Superdesk installation instructions (Docker)

README.md

Archive only

I haven't looked at Superdesk in close to two years now (I no longer work at Sourcefabric) and I have little to no recollection of how to set it up. I'm leaving this gist online mainly for archival reasons and because there's a lot of useful information in the comments that I don't want to disappear from the internet. I hope you get it up and running one way or another, and if you do, please pop your solution here/make a new gist and link it here for others!

How to install Superdesk using Docker

1. Install Docker
2. Copy and paste docker-compose.yml in this gist into a blank folder (call it something like superdesk/)
3. Open the folder in a terminal
4. Run docker-compose up
5. Wait a few seconds...
6. Navigate to localhost:8080

You should see the Superdesk login screen! Now to initialise some data:

1. Open a new terminal in the same folder
2. Run docker-compose run superdesk-server run python manage.py app:initialize_data to populate Superdesk with some starting data.
3. Run docker-compose run superdesk-server run python manage.py users:create -u admin -p admin -e admin@localhost --admin to create an example administrator.

docker-compose.yml

version: "3"
services:

  mongo:
    image: mongo:3
    expose:
      - "27017"

  redis:
    image: redis:3
    expose:
      - "6379"
    
  elastic:
    image: docker.elastic.co/elasticsearch/elasticsearch:7.9.3
    environment:
      - xpack.security.enabled=false
      - discovery.type=single-node
    expose:
      - "9200"
      - "9300"
    ulimits:
      memlock:
        soft: -1
        hard: -1
      nofile:
        soft: 65536
        hard: 65536
    cap_add:
      - IPC_LOCK

  superdesk-server:
    image: nickdbush/superdesk-server:2.0
    container_name: superdesk-server
    depends_on:
      - redis
      - mongo
      - elastic
    environment:
      - WEB_CONCURRENCY=2
      - SUPERDESK_CLIENT_URL=http://localhost:8080
      - GRAMMALECTE_URL=http://grammalecte:9999
      - MONGO_URI=mongodb://mongo/test
      - PUBLICAPI_MONGO_URI=mongodb://mongo/test_pa
      - LEGAL_ARCHIVE_URI=mongodb://mongo/test_la
      - ARCHIVED_URI=mongodb://mongo/test_ar
      - ELASTICSEARCH_URL=http://elastic:9200
      - ELASTICSEARCH_INDEX=superdesk
      - CELERY_BROKER_URL=redis://redis:6379/1
      - REDIS_URL=redis://redis:6379/1
      - AMAZON_ACCESS_KEY_ID
      - AMAZON_CONTAINER_NAME
      - AMAZON_REGION
      - AMAZON_SECRET_ACCESS_KEY
      - REUTERS_USERNAME
      - REUTERS_PASSWORD
      # - MAIL_SERVER=example.com
      # - MAIL_PORT=25
      # - MAIL_USE_TLS=false
      # - MAIL_USE_SSL=false
      # - MAIL_USERNAME=user
      # - MAIL_PASSWORD=pwd
      - SENTRY_DSN
      - SECRET_KEY
      - CONTENTAPI_URL=http://localhost:8080/capi
      - CONTENTAPI_MONGO_URI=mongodb://mongo/test_ca

  superdesk-client:
    image: nickdbush/superdesk-client:2.0
    container_name: superdesk
    environment:
      - SUPERDESK_URL=http://localhost:8080/api
      - SUPERDESK_WS_URL=ws://localhost:8080/ws
      - VIEW_DATE_FORMAT
      - VIEW_TIME_FORMAT
      - IFRAMELY_KEY
    depends_on:
      - superdesk-server
    ports:
      - "8080:80"

@trondhuso @Saied-A I haven't looked at Superdesk in close to two years now (I no longer work at Sourcefabric) and I have little to no recollection of how to set it up. I'm leaving this gist online mainly for archival reasons and because there's a lot of useful information in the comments that I don't want to disappear from the internet. I hope you get it up and running one way or another, and if you do, please pop your solution here/make a new gist and link it here for others!

@nickdbush Thank you for your quick response and for maintaining the gist for archival purposes. Your dedication to preserving resources is greatly appreciated. I'll continue working on resolving the user verification email issue and will share any solution I find in the comments, or a new gist as suggested.

I did set up a superdesk a few months back for myself - and to fresh up on knowledge.
Superdesk / sourcefabric has a docker install now that works much better than running the old stuff.

sorry to hear that you are no longer at sourcefabric, Nick.