@@ -22,8 +22,12 @@ The machine you want to deploy LEAF-Writer on also needs to have `git` installed
8. Run the automatic setup docker compose script: `sudo docker compose --env-file leafwriter.env -f leafwriter-configuration-files/docker-compose-keycloak-firstrun.yml up`
9. Wait until you see a line similar to `keycloak-thirdrun-1 exited with code 0`. Stop the running containers with e.g. `Ctrl+c` and run `sudo docker compose --env-file leafwriter.env -f leafwriter-configuration-files/docker-compose-keycloak-firstrun.yml down` to remove them
10. Build and run LEAF-Writer and all its dependencies by running: `sudo docker compose --env-file leafwriter.env -f docker-compose.yml up` If you feel brave enough, you can add the `-d` option to directly launch the containers in the background. It is, however, advisable to first launch LEAF-Writer with enabled output stream to see if any problems are identifiable by the logs. You should, therefore, probably continue the rest of the steps in a second terminal and once everything is up and running switch to the detached mode. You can do this by exiting the containers with `Ctr+c`, run `sudo docker compose --env-file leafwriter.env -f docker-compose.yml down` and then `sudo docker compose --env-file leafwriter.env -f docker-compose.yml up -d`
11. The following steps will guide you through setting up a nginx-based reverse proxy to server LEAF-Writer with SSL encryption to the web. This assumes that you have a fresh install of nginx that does not serve any other sites and has a default structure for configuration files. If this does not reflect your setup, see the section for reverse proxy settings below to gather all necessary information so you can setup the reverse proxy properly within your larger environment or for your desired webserver.
12. Make sure that the default / placeholder website is removed. On Debian-based distributions you can generally just remove the symlink in the `/etc/nginx/sites-enabled` directory, other systems you may have to edit a file called `nginx.conf`. If in doubt, consult the documentation of your operating system.
11. The following steps will guide you through setting up a nginx-based reverse proxy to serve LEAF-Writer with SSL encryption to the web. This assumes that you have a fresh install of nginx that does not serve any other sites and has a default structure for configuration files. If this does not reflect your setup, see the section for reverse proxy settings below to gather all necessary information so you can setup the reverse proxy properly within your larger environment or for your desired web server.
12. Make sure that the default / placeholder website is removed. On Debian-based distributions you can generally just remove the symlink in the `/etc/nginx/sites-enabled` directory, on other systems you may have to edit a file called `nginx.conf`. If in doubt, consult the documentation of your operating system.
13. Copy the files `leafwriter.conf` in the directory `leafwriter-configuration-files/nginx-sample-conf` to the configuration directory for your nginx installation. On Debian-based systems this is `/etc/nginx/sites-available` on other distributions it may be something like `/etc/nginx/conf.d`. Make sure that the files in this directory are loaded by e.g. on Debian-based distributions adding a symlink in the `/etc/nginx/sites-enabled` directory. Open the file you just copied and adjust the `server_name` to point to the domain you want to serve LEAF-Writer on.
14. Reload nginx
15. Add the SSL-certificate. If you use certbot and nginx run: `sudo certbot -d docker.leafwriter-playground.users.h-da.cloud --nginx`
16. Check if LEAF-Writer is reachable from the internet. On some distributions
