teic/docker-pkp-ojs repository overview

⁠OJS Docker image

Open Journal Systems (OJS) is a journal management and publishing system that has been developed by the Public Knowledge Project through its federally funded efforts to expand and improve access to research.

Check out its creators⁠ and its official website⁠.

This particular Docker image is based on arturluizbr/docker-pkp-ojs⁠ but enhanced for running behind an SSL terminating proxy and for managing Docker secrets.

⁠How to use this image

You can run the OJS container and service like so:

docker run -d -e PKP_DATABASE_HOST=ojsdb teic/docker-pkp-ojs

This assumes you've already launched a suitable MySQL or MariaDB database container with the name osjdb.

⁠… via docker stack deploy or docker-compose

Example stack.yml for docker-pkp-ojs:

# docker-compose.yml
version: "3.6"
services:
  ojs:
    image: teic/docker-pkp-ojs
    ports: 
      - 8181:80
    environment: 
      - PKP_DATABASE_DRIVER=mysqli
      - PKP_DATABASE_HOST=ojsdb
      - PKP_DATABASE_USERNAME=ojs
      - PKP_DATABASE_PASSWORD=ojs
      - PKP_DATABASE_NAME=ojs
    restart: unless-stopped
  ojsdb:
    image: mariadb:10
    volumes:
      - db_data:/var/lib/mysql
    environment: 
      - MYSQL_DATABASE=ojs
      - MYSQL_USER=ojs
      - MYSQL_PASSWORD=ojs
      - MYSQL_RANDOM_ROOT_PASSWORD=yes
    restart: unless-stopped

volumes: 
  db_data:

Run docker stack deploy -c stack.yml docker-pkp-ojs (or docker-compose -f stack.yml up), wait for it to initialize completely, and visit http://localhost:8181/.

⁠Environment Variables

Basically all variables inside config.inc.php can be overriden by passing the respective environment variable to the docker run command.

Check the full list of environment variables and their description here⁠.

⁠Docker Secrets

TODO

⁠Persistent Data

TODO

⁠OJS Tools

TODO

⁠Upgrading

Warning: THIS PROCEDURE WAS NOT TESTED

Steps:

• Backup and/or restore your database accoding to db image you use;
• Configure your docker-compose file to use the newest version of this image;
• Recreate your OJS container with newest version (docker-compose up -d --force-recreate);
• Enter the terminal mode of your container (docker-compose exec ojs bash);
• Run the official upgrade tool from OJS (php -c $PHP_INI_DIR tools/upgrade.php upgrade);

⁠Using your own version of OJS

To use your custom version of OJS, update the following ARGs when buiding this image.

Steps:

• Clone/Fork this repository to your workspace.
• (Docker variant) Build the image using custom ARGs (docker build --build-arg repo_url=[YOUR-REPO] --build-arg tag_name=[YOUR_TAG_OR_BRANCH] -t user/ojs:latest .);
• (Docker Compose variant) Update ARGs in your docker-compose.yml⁠ file and build the image using docker-compose build.