Update docker images and documentation

Author: bobvandevijver

.dockerignore

@@ -0,0 +1,24 @@
+# Files
+.editorconfig
+.gitattributes
+.gitignore
+.gitlab-ci.yml
+.gitmodules
+.gtt.yml
+.php-cs-fixer.dist.php
+.env.local
+composer.phar
+rector.php
+tslint.json
+
+# Folders
+.idea
+icinga
+node_modules
+public/build
+public/bundles
+systemd
+tests
+update
+var
+vendor

.env

@@ -39,12 +39,12 @@ SECRETS_FILE=%kernel.project_dir%/.secrets.json
 
 # Exception mailer
 EXCEPTION_MAILER_URL=null://localhost
-EXCEPTION_RECEIVER=webmaster@drenso.nl
-EXCEPTION_SENDER=webmaster@ltb.itc.utwente.nl
+EXCEPTION_RECEIVER=
+EXCEPTION_SENDER=
 
 # OpenID Connect
-OIDC_WELL_KNOWN=https://connect.surfconext.nl/.well-known/openid-configuration
-OIDC_CLIENT_ID=ltb.itc.utwente.nl
+OIDC_WELL_KNOWN=
+OIDC_CLIENT_ID=
 
 # General settings
 PRODUCTION_SERVER=false
@@ -53,8 +53,8 @@ PANDOC_PATH=/usr/bin/pandoc
 PYTHON_PATH=/usr/bin/python3.8
 
 # Domain settings
-HTTP_HOST=ltb.itc.utwente.nl
+HTTP_HOST=
 HTTP_SCHEMA=https
 
 # Mailer settings
-MAIL_FROM="Living Textbook by ITC <noreply@ltb.itc.utwente.nl>"
+MAIL_FROM=

.gitignore

@@ -47,3 +47,10 @@ yarn-error.log
 
 # PHP-CS-Fixer cache
 .php-cs-fixer.cache
+
+# Docker environment
+docker-compose.prod.yml
+docker/db.env
+docker/ltb_prod.env
+docker/nginx/server.key
+docker/nginx/server.cert

README.md

@@ -1,61 +1,15 @@
-# Setup docker environment
+The Living Textbook project is developed and maintained by the [ITC faculty](https://www.itc.nl/) of
+the [University of Twente](https://utwente.nl).
 
-- `git clone`
-- `yarn install`
+> The documentation is currently a work in progress. More to come soon!
 
-Configure the relevant environment by creating the following files:
+Check our documentation in the `docs` folder!
 
-```
-# .env.local
-APP_ENV=dev
-DATABASE_URL=mysql://013-living-textbook:%database_password%@db:3306/013-living-textbook
-HTTP_HOST=localhost
-```
+- [Backend development](docs/backend-development.md)
+- [Frontend development](docs/frontend-development.md)
+- [Docker](docs/docker.md)
+- [Environment](docs/environment.md)
 
-Place the following in `.secrets.json`
-```
-{
-  "app": "SomeSecret",
-  "database": "dbpass",
-  "oidc": ""
-}
-```
+## Known issues
 
-Create a self-signed certificate for nginx:
-
-```
-openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout docker/nginx/server.key -out docker/nginx/server.cert
-```
-
-Build the docker containers with `docker-compose build`.
-
-Bring it all up with `docker-compose up -d`.
-
-Open a console within the php container (assuming the folder is `013-living-textbook`):
-
-- `docker exec -it 013-living-textbook_php_1 /bin/sh`
-- `composer install`
-- `bin/console doctrine:migrations:migrate` and select `y`
-
-In your normal console, now run:
-
-- `yarn build`
-
-Execute the following queries in the console of the db container (in `docker exec -it 013-living-textbook_db_1 /bin.sh` -> `mysql`)
-
-```sql
-use 013-living-textbook;
-INSERT INTO user__table (given_name, last_name, full_name, display_name, username, is_oidc, is_admin, roles, password, registered_on, created_at, created_by) VALUES ('Dev', 'Loper', 'Developer', 'Developer', 'developer@localhost.nl', 0, 1, 'a:0:{}', '$argon2id$v=19$m=65536,t=4,p=1$0HoR4yJvi6fb5xFtXXH66w$yXO7fsj/I1X7/jFb0NuNuN/AkRBsiJOLmAnezAFWwCM', NOW(), NOW(), 'developer');
-INSERT INTO study_area (owner_user_id, name, created_at, access_type, track_users, open_access, analytics_dashboard_enabled, review_mode_enabled, dotron) VALUES (1, 'Development Area', NOW(), 'public', 0, 0, 0, 0, 0);
-```
-
-Open the ltb on `https://localhost:10443/` (and ignore the certificate error). You can login with a local account
-used `developer@localhost.nl`:`developer` as credentials. This is a full admin account.
-
-OIDC login will not work, as localhost is not configured (or can be configured as) as valid return URL.
-
-# JS development
-
-You should be able to start the JS development server
-with `yarn encore dev-server --hot --https --disableHostCheck=true --cert docker/nginx/server.cert --key docker/nginx/server.key`
-for HMR, or just use `yarn watch` when HMR is not required.
+The python data visualisation module is not (yet) publicly available, meaning those endpoints will fail when used.

docker-compose.dev.yml

@@ -0,0 +1,64 @@
+version: '3.4'
+
+services:
+  ltb:
+    build:
+      context: .
+      target: ltb_dev
+      dockerfile: docker/ltb/Dockerfile
+    restart: always
+    volumes:
+      - './:/usr/src/app/'
+    environment:
+      APP_ENV: dev
+      PYTHON_PATH: '/usr/local/bin/python3.8'
+      DATABASE_CHECK: 'db:3306'
+      DATABASE_URL: 'mysql://ltb:%database_password%@db:3306/ltb'
+      PRODUCTION_SERVER: 'false'
+      TRUSTED_PROXIES: 10.9.8.1
+      HTTP_HOST: localhost
+    depends_on:
+      - db
+    networks:
+      - ltb-network
+
+  nginx:
+    image: nginx:1.21.6-alpine
+    restart: always
+    volumes:
+      - './public:/usr/src/app:ro'
+      - './docker/nginx/default.conf:/etc/nginx/conf.d/default.conf:ro'
+      - './docker/nginx/server.cert:/etc/nginx/certs/server.cert:ro'
+      - './docker/nginx/server.key:/etc/nginx/certs/server.key:ro'
+    depends_on:
+      - ltb
+    ports:
+      - '10443:443'
+    networks:
+      - ltb-network
+
+  db:
+    image: mariadb:10.8.2
+    command: [ '--character-set-server=utf8mb4', '--collation-server=utf8mb4_unicode_ci' ]
+    restart: always
+    environment:
+      MYSQL_USER: ltb
+      MYSQL_DATABASE: ltb
+    env_file:
+      - docker/db.env
+    volumes:
+      - 'ltb-database:/var/lib/mysql'
+    networks:
+      - ltb-network
+
+volumes:
+  ltb-database:
+  ltb-uploads:
+  ltb-public:
+
+networks:
+  ltb-network:
+    driver: bridge
+    ipam:
+      config:
+        - subnet: 10.9.8.0/24

docker-compose.prod.yml

@@ -0,0 +1,66 @@
+version: '3.4'
+
+services:
+  ltb:
+    build:
+      context: .
+      target: ltb_prod
+      dockerfile: docker/ltb/Dockerfile
+    restart: always
+    volumes:
+      - 'ltb-uploads:/usr/src/app/public/uploads'
+      - 'ltb-public:/usr/src/app/public_mirror'
+      - './.secrets.json:/usr/src/app/.secrets.json:ro'
+    environment:
+      PYTHON_PATH: '/usr/local/bin/python3.8'
+      DATABASE_CHECK: 'db:3306'
+      DATABASE_URL: 'mysql://ltb:%database_password%@db:3306/ltb'
+      PRODUCTION_SERVER: 'true'
+      TRUSTED_PROXIES: 10.9.8.1
+    env_file:
+      - docker/ltb_prod.env
+    depends_on:
+      - db
+    networks:
+      - ltb-network
+
+  nginx:
+    image: nginx:1.21.6-alpine
+    restart: always
+    volumes:
+      - 'ltb-public:/usr/src/app:ro'
+      - './docker/nginx/default.conf:/etc/nginx/conf.d/default.conf:ro'
+      - './docker/nginx/server.cert:/etc/nginx/certs/server.cert:ro'
+      - './docker/nginx/server.key:/etc/nginx/certs/server.key:ro'
+    depends_on:
+      - ltb
+    ports:
+      - '10443:443'
+    networks:
+      - ltb-network
+
+  db:
+    image: mariadb:10.8.2
+    command: [ '--character-set-server=utf8mb4', '--collation-server=utf8mb4_unicode_ci' ]
+    restart: always
+    environment:
+      MYSQL_USER: ltb
+      MYSQL_DATABASE: ltb
+    env_file:
+      - docker/db.env
+    volumes:
+      - 'ltb-database:/var/lib/mysql'
+    networks:
+      - ltb-network
+
+volumes:
+  ltb-database:
+  ltb-uploads:
+  ltb-public:
+
+networks:
+  ltb-network:
+    driver: bridge
+    ipam:
+      config:
+        - subnet: 10.9.8.0/24

docker-compose.yml

@@ -0,0 +1,2 @@
+MYSQL_ROOT_PASSWORD=
+MYSQL_PASSWORD=