@@ -3,3 +3,8 @@ This page describes a simplified deployment of LEAF-Writer using docker compose
...
@@ -3,3 +3,8 @@ This page describes a simplified deployment of LEAF-Writer using docker compose
To deploy the branches `main` and `dev` see (Deployment)[deployment]. After the merge of the current `exp` branch, the Deployment page will describe a full manual deployment. A manual deployment can bee desirable if e.g. the Keycloak server is used as a login provider for other services as well.
To deploy the branches `main` and `dev` see (Deployment)[deployment]. After the merge of the current `exp` branch, the Deployment page will describe a full manual deployment. A manual deployment can bee desirable if e.g. the Keycloak server is used as a login provider for other services as well.
# Prerequisites
# Prerequisites
You need a server with installed `docker` and the `docker compose` plugin. The server mus be reachable from the internet and must have a domain like `leafwriter.your-university.example.com` assigned and properly configured (DNS etc.). This server needs to have a web server such as Apache or Nginx installed to act as a reverse proxy. You must have the right to execute docker containers either directly or via `sudo` and you must be able to configure the web server.
LEAF-Writer must be exposed to the internet only via an encrypted connection (`https`). It is the task of the reverse proxy ensure an encrypted connection, therefore you need a suitable certificate. It is enough if this certificate is valid for your chosen domain, e.g. `leafwriter.your-university.example.com`, no subdomain or wildcard capabilities are needed. You can use a `Let's encrypt` certificate, issued via `certbot`.
The following deployment tutorial will assume that you use (and have installed) `cerbot` to get a SSL-certificate. However, as described, you can also use other certificates, you just have to properly configure them in conjunction with your reverse proxy.
