Skip to content

Latest commit

 

History

History
78 lines (50 loc) · 4.36 KB

README.md

File metadata and controls

78 lines (50 loc) · 4.36 KB
Raw

Docker Compose Configuration for OpenOlitor

OpenOlitor consists of multiple components and needs a DB server, an S3 compatible service and a document converter to provide its functionality.

This project makes it easy to:

  • Run OpenOlitor on a local system to try it out and to develop frontend and/or backend features.
  • Generate all configuration files based on a single JSON-file
  • Run OpenOlitor on a server/cloud infrastructure.

Here you find how to achieve this:

Run on localhost

  1. Make sure you have docker and docker-compose available on your host.
  2. In a terminal window clone this repository: git clone https://github.com/OpenOlitor/openolitor-docker-compose.git
  3. Change into the folder cd openolitor-docker-compose
  4. Create and start MariaDB and Minio (S3): docker-compose up -d db s3 (wait a minute so the DB schema creation is done)
  5. Bring up everything else: docker-compose up -d
  6. Use your favorite browser to open http://localhost:8080

Piece of cake.

This will use the default docker-compose.yml.

BTW: Sending emails is not enabled.

Generate Configuration

You want to configure OpenOlitor so one or multiple groups/CSAs may use OpenOlitor on your instance. This is easily possible using the provided generator. How to proceed:

  1. Make sure you have python3 and the Jinja2 library available on your host.
  2. Copy the environment template dev.json to the name of your choice: 'cp dev.json [your-env].json'
  3. Edit the file and add all needed
  4. Call the generator python3 generator.py -e [your-env]
  5. All configuration files are created, i.e. docker-compose.[your-env].yml
  6. Use the new configuration by specifying the file using docker-compose: docker-compose -f docker-compose.[your-env].yml start

You may want to fork this repo as a private repository so you can safely check in your configuration and the generated files.

NOTE: if you are not using https, you will need to change the configuration to http (config/client/admin/config.[your-env].js and config/client/kundenportal/config.[your-env].js )

Run on Server/Cloud-Environment

There is many different (cloud) environments docker compose may run on. Please share your experiences and knowledge if you use another environment. Currently we provide some information about the following:

Good practice is:

  • Configure a firewall: Don't expose the ports of the database, S3 and such to the outside.

Run on a ROOT server

Simply run OpenOlitor on a ROOT server? We have a step-by-step guide available.

Insights: Services

The following services are started:

  • db: MariaDB (one instance for all with one database per configured CSA)
  • s3: Minio (one instance for all with multiple buckets per configured CSA)
  • client-kundenportal: OpenOlitor web UI for members
  • client-admin: OpenOlitor web UI for administrators
  • server: OpenOlitor Backend with all the magic (Scala application running on OpenJDK)
  • pdf-tool: Java OpenDocument Converter providing a REST-API to transform ODF documents into PDF
  • nginx: Webserver providing access to all services through one interface (Port 8080 on localhost; Port 80 for servers)
  • smtp-proxy: mailhog collecting emails send by openolitor (see below)

Insights: Mail-Sending (SMTP)

OpenOlitor can be used to send personalized emails. In order to not send unintended mails to recipient based on test data, we introduced mailhog as an SMTP collector and proxy if needed. This collects all mail send and you may see the mails on the provided web interface on localhost:8025.

It makes sense to enable the smtp-proxy on all environments but production. The attribute smtpProxy in your environment configuration specifies, if the docker-compose configuration includes this service or not.

Credits

Thanks to Eike for his great work we have based this repo on.