From c5732ba1aec7ab498d7e6d69631edcc0dd5d62b2 Mon Sep 17 00:00:00 2001 From: Olivier Leger Date: Wed, 29 May 2024 14:39:01 -0400 Subject: [PATCH] Update README --- readme.md | 62 +++++++++++++++++++++++++++---------------------------- 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/readme.md b/readme.md index 067e478..ecb0f8b 100644 --- a/readme.md +++ b/readme.md @@ -94,37 +94,37 @@ User can choose between 2 types of installations: ### Advanced Options -| Option |Default|Workstation|Server -|--------------------------------------------------|---|---|---| -| Webserver port | **80** | ✓ | | -| Reverse proxy interal port | **8080** | | ✓ (front end only) | -| Network interface | **Autodetected** | ✓ | ✓ (front end only) | -| Use separate servers | **No** | | ✓ | -| Use DNS for private routes | **No** | | ✓ (front end only) | -| Primary back end IP _(if previous answer is no)_ | **Local IP** | | ✓ (front end only) | -| PostgreSQL DB | **kobo** | ✓ | ✓ | -| PostgreSQL user's username | **kobo** | ✓ | ✓ | -| PostgreSQL user's password | **Autogenerate** | ✓ | ✓ | -| PostgreSQL number of connections3 | **100** | ✓ | ✓ (back end only) | -| PostgreSQL RAM3 | **2** | ✓ | ✓ (back end only) | -| PostgreSQL Application Profile3 | **Mixed** | ✓ | ✓ (back end only) | -| PostgreSQL Storage3 | **HDD** | ✓ | ✓ (back end only) | -| MongoDB super user's username | **root** | ✓ | ✓ | -| MongoDB super user's password | **Autogenerate** | ✓ | ✓ | -| MongoDB user's username | **kobo** | ✓ | ✓ | -| MongoDB user's password | **Autogenerate** | ✓ | ✓ | -| Redis password4 | **Autogenerate** | ✓ | ✓ | -| Use AWS storage5 | **No** | ✓ | ✓ | -| uWGI workers | **start: 2, max: 4** | ✓ | ✓ (front end only) | -| uWGI memory limit | **128 MB** | ✓ | ✓ (front end only) | -| uWGI harakiri timeout | **120s** | ✓ | ✓ (front end only) | -| uWGI worker reload timeout | **120s** | ✓ | ✓ (front end only) | -| Google UA | | ✓ | ✓ (front end only) | -| Google API Key | | ✓ | ✓ (front end only) | -| Sentry tokens | | ✓ | ✓ (front end only) | -| Debug | **False** | ✓ | | -| Developer mode | **False** | ✓ | | -| Staging mode | **False** | | ✓ (front end only) | +| Option |Default|Workstation|Server +|-------------------------------------------------|---|---|---| +| Webserver port | **80** | ✓ | | +| Reverse proxy interal port | **8080** | | ✓ (front end only) | +| Network interface | **Autodetected** | ✓ | ✓ (front end only) | +| Use separate servers | **No** | | ✓ | +| Use DNS for private routes | **No** | | ✓ (front end only) | +| Back-end server IP _(if previous answer is no)_ | **Local IP** | | ✓ (front end only) | +| PostgreSQL DB | **kobo** | ✓ | ✓ | +| PostgreSQL user's username | **kobo** | ✓ | ✓ | +| PostgreSQL user's password | **Autogenerate** | ✓ | ✓ | +| PostgreSQL number of connections3 | **100** | ✓ | ✓ (back end only) | +| PostgreSQL RAM3 | **2** | ✓ | ✓ (back end only) | +| PostgreSQL Application Profile3 | **Mixed** | ✓ | ✓ (back end only) | +| PostgreSQL Storage3 | **HDD** | ✓ | ✓ (back end only) | +| MongoDB super user's username | **root** | ✓ | ✓ | +| MongoDB super user's password | **Autogenerate** | ✓ | ✓ | +| MongoDB user's username | **kobo** | ✓ | ✓ | +| MongoDB user's password | **Autogenerate** | ✓ | ✓ | +| Redis password4 | **Autogenerate** | ✓ | ✓ | +| Use AWS storage5 | **No** | ✓ | ✓ | +| uWGI workers | **start: 2, max: 4** | ✓ | ✓ (front end only) | +| uWGI memory limit | **128 MB** | ✓ | ✓ (front end only) | +| uWGI harakiri timeout | **120s** | ✓ | ✓ (front end only) | +| uWGI worker reload timeout | **120s** | ✓ | ✓ (front end only) | +| Google UA | | ✓ | ✓ (front end only) | +| Google API Key | | ✓ | ✓ (front end only) | +| Sentry tokens | | ✓ | ✓ (front end only) | +| Debug | **False** | ✓ | | +| Developer mode | **False** | ✓ | | +| Staging mode | **False** | | ✓ (front end only) | 1) _HTTPS certificates must be installed on a Reverse Proxy. `kobo-install` can install one and use `Let's Encrypt` to generate certificates