~jan0sch/smederee

Showing details for patch d019b1c971c03257177e8722a6c72a4fdaaaf9dc.
2023-06-01 (Thu), 1:43 PM - Jens Grassel - d019b1c971c03257177e8722a6c72a4fdaaaf9dc

Add more information for deployment.

Summary of changes
1 files modified with 41 lines added and 2 lines removed
  • README.md with 41 added and 2 removed lines
diff -rN -u old-smederee/README.md new-smederee/README.md
--- old-smederee/README.md	2025-01-16 05:28:24.713031445 +0000
+++ new-smederee/README.md	2025-01-16 05:28:24.713031445 +0000
@@ -71,6 +71,47 @@
 Please ensure that the system requirements are met and that you have the
 credentials needed to access the database.
 
+### Creating the distribution ###
+
+On the sbt console run the task `hub/Universal/packageXzTarball` which will
+create a package under `modules/hub/target/universal`. This archive can be
+extracted to a place of your liking. Afterwards you _have to_ create the
+file `conf/application.conf` in which you configure the service.
+
+### Creating the configuration file ###
+
+The easiest way is to simply concatenate the both default configurations for
+the hub and ticket module:
+
+```
+% cat modules/hub/src/main/resources/reference.conf \
+    modules/tickets/src/main/resources/reference.conf > application.conf
+```
+
+### Important configuration settings ###
+
+The first and foremost settings are the ones related to the database. Please
+ensure that _both_ database settings (hub _and_ tickets) are set to proper
+values.
+
+Secondly take a look at the `external` configuration settings for _both_
+services and configure them accordingly to be able to reach them depending
+on your setup. We assume that you will be running them behind a reverse
+proxy which also does take care of encryption (https). Depending on your
+setup you can either decide to run both endpoints under one domain or on
+different subdomains e.g. hub on "example.com" and tickets on
+"tickets.example.com".
+
+The hub service has a `ticket-integration` section into which you have to
+enter the base uri under which the ticket endpoints are reachable. The
+ticket service has a `hub-integration` section with the analogue settings.
+
+Both services have a `cookie-secret` setting that MUST be set to a randomly
+generated sequence of at least 64 alphanumeric characters.
+
+Next you might want to check the pre-configured paths and make adjustments
+were needed.
+
 ### Database setup ###
 
 The application uses schemas which may reside in a single database or not
@@ -90,8 +131,6 @@
 GRANT CONNECT, CREATE ON DATABASE <database name> TO <role name>;
 ```
 
-TODO
-
 ### Coloured diffs ###
 
 1. Install `colordiff`