Impresso app stack

Running Impresso app stack in docker compose:

cp .env.example .env
docker-compose -p impresso up

Running in production (detached mode), check the contents of your .env file if any:

docker-compose -p impresso up -d

Reading logs in production:

docker-compose -p impresso logs -f

The .env.example contains latest images of the services in docker-compose and it is for development purposes.

Configuration

Docker compose expects several files located in config directory in this folder:

impresso-middle-layer.json - middle layer API configuration
impresso-user-admin.env - admin dashboard and celery tasks app configuration
nginx.conf - nginx configuration
ssh/config - ssh tunnel configuration (plus key files in ssh folder if needed)
recsys_config.py - collections recommender system configuration

We provide a sample set of files in config_example. Fields that need to be replaced (mostly hostnames, usernames and passwords) are marked with [!!!REPLACE] string.

A special note about the database. Our setup assumes the database is accessed via an SSH tunnel to the database host. If the database port is accessible directly, you can simplify the configuration by setting the db hostname, port and credentials in the relevant config files, commenting out the mysql-tunnel section in docker-compose.yml. In this case you also do not need the files in the config/ssh folder, those are used for the DB tunnel only.

Apps versions

Tags of impresso docker images are read from the .env file. The default file with all tags set to latest is provided in this repository.

Docker specific configuration notes for components

Middle Layer API

Make sure the following parameters are set to internal docker hostnames:

redis.host to redis
celery.CELERY_BROKER_URL hostname to redis
celery.CELERY_RESULT_BACKEND hostname to redis
sequelize.host to mysql-tunnel
sequelize.port to 3306

User Admin Dashboard / Celery

Make sure the following parameters are set to internal docker hostnames:

IMPRESSO_DB_HOST to mysql-tunnel
IMPRESSO_DB_PORT to 3306
REDIS_HOST to redis
STATIC_URL to /admin/static/ (assuming in nginx configuration the base URL of the dashboard is /admin/)
ALLOWED_HOSTS to * (dashboard is behind nginx reverse proxy which manages this)

Frontend Web App

When building docker container for the app make sure:

webpack compiles the app with PUBLIC_PATH environmental variable set to /app/ (assuming that the app base URL in nginx configuration is /app).
BASE_URL in prod.env.js is set to '"/app"' (assuming that the app base URL in nginx configuration is /app).
MIDDLELAYER_API in prod.env.js is set to '""'
MIDDLELAYER_API_PATH in prod.env.js is set to '"/api"' (assuming that middle layer API base URL in nginx configuration is /api)
MIDDLELAYER_API_SOCKET_PATH in prod.env.js is set to '"/api/socket.io/"' (assuming that middle layer API base URL in nginx configuration is /api)
MIDDLELAYER_MEDIA_PATH in prod.env.js is set to '"/api/media"' (assuming that the api base URL in nginx configuration is /api)

Scripts, to be executed only when data changes.

impresso-middle-layer-update-cache:
  # Updates cache files expected by middle layer. They do not change often
  # so until this is refactored it is fine to run it on docker compose "up" or manually.
  image: impresso/impresso-middle-layer:${IMPRESSO_MIDDLE_LAYER_TAG}
  environment:
    NODE_ENV: docker
  depends_on:
    - mysql-tunnel
  volumes:
    - ./config/impresso-middle-layer.json:/impresso-middle-layer/config/docker.json
    - middle-layer-cache:/impresso-middle-layer/data
  entrypoint:  >
    /bin/sh -c "echo 'Updating newspapers:' &&
                (node scripts/update-newspapers.js || true) &&
                echo 'Updating topics:' &&
                (node scripts/update-topics.js || true) &&
                echo 'Updating years:' &&
                (node scripts/update-years.js || true) &&
                echo 'Updating facet ranges:' &&
                (node scripts/update-facet-ranges.js || true)"
impresso-middle-layer-update-related-topics:
  # Updates related topics cache files expected by middle layer.
  # It's a long running script (takes about 30-40 minutes). It should be run
  # Every time Solr data changes.
  image: impresso/impresso-middle-layer:${IMPRESSO_MIDDLE_LAYER_TAG}
  environment:
    NODE_ENV: docker
    DEBUG: impresso/scripts*
  depends_on:
    - mysql-tunnel
  volumes:
    - ./config/impresso-middle-layer.json:/impresso-middle-layer/config/docker.json
    - middle-layer-cache:/impresso-middle-layer/data
  entrypoint:  >
    /bin/sh -c "echo 'Updating related topics:' &&
                (node scripts/update-topics-related.js || true) &&
                echo 'Updating Topic Graph:' &&
                (node scripts/update-topics-positions.js || true)"

impresso/impresso-docker-stack