sheppy/opendesk
1
0
Fork 0
mirror of https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk.git synced 2025-12-06 07:21:36 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs(getting-started.md): Update for apps. level introduced with v1.1.2

Browse Source
This commit is contained in:
Thorsten Roßner
2025-02-20 12:42:09 +01:00
parent 60f5e36b7c
commit da3adff0ef
2 changed files with 32 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
docs/getting-started.md
View File

@@ -101,33 +101,34 @@ All available apps and their default value are in `helmfile/environments/default
| Component | Name | Default | Description | | Component | Name | Default | Description |
| -------------------- | --------------------------- | ------- | ------------------------------ | | -------------------- | --------------------------- | ------- | ------------------------------ |
| Certificates | `certificates.enabled` | `true` | TLS certificates | | Certificates | `apps.certificates.enabled` | `true` | TLS certificates |
| ClamAV (Distributed) | `clamavDistributed.enabled` | `false` | Antivirus engine | | ClamAV (Distributed) | `apps.clamavDistributed.enabled` | `false` | Antivirus engine |
| ClamAV (Simple) | `clamavSimple.enabled` | `true` | Antivirus engine | | ClamAV (Simple) | `apps.clamavSimple.enabled` | `true` | Antivirus engine |
| Collabora | `collabora.enabled` | `true` | Weboffice | | Collabora | `apps.collabora.enabled` | `true` | Weboffice |
| CryptPad | `cryptpad.enabled` | `true` | Weboffice | | CryptPad | `apps.cryptpad.enabled` | `true` | Weboffice |
| dkimpy | `dkimpy.enabled` | `false` | Postfix milter for DKIM | | dkimpy | `apps.dkimpy.enabled` | `false` | Postfix milter for DKIM |
| Dovecot | `dovecot.enabled` | `true` | Mail backend | | Dovecot | `apps.dovecot.enabled` | `true` | Mail backend |
| Element | `element.enabled` | `true` | Secure communications platform | | Element | `apps.element.enabled` | `true` | Secure communications platform |
| Home | `home.enabled` | `true` | Base domain portal redirect | | Home | `apps.home.enabled` | `true` | Base domain portal redirect |
| Jitsi | `jitsi.enabled` | `true` | Videoconferencing | | Jitsi | `apps.jitsi.enabled` | `true` | Videoconferencing |
| MariaDB | `mariadb.enabled` | `true` | Database | | MariaDB | `apps.mariadb.enabled` | `true` | Database |
| Memcached | `memcached.enabled` | `true` | Cache Database | | Memcached | `apps.memcached.enabled` | `true` | Cache Database |
| MinIO | `minio.enabled` | `true` | Object Storage | | MinIO | `apps.minio.enabled` | `true` | Object Storage |
| Nextcloud | `nextcloud.enabled` | `true` | File share | | Nextcloud | `apps.nextcloud.enabled` | `true` | File share |
| Nubus | `nubus.enabled` | `true` | Identity Management & Portal | | Nubus | `apps.nubus.enabled` | `true` | Identity Management & Portal |
| OpenProject | `openproject.enabled` | `true` | Project management | | OpenProject | `apps.openproject.enabled` | `true` | Project management |
| OX App Suite | `oxAppSuite.enabled` | `true` | Groupware | | OX App Suite | `apps.oxAppSuite.enabled` | `true` | Groupware |
| Postfix | `postfix.enabled` | `true` | MTA | | Postfix | `apps.postfix.enabled` | `true` | MTA |
| PostgreSQL | `postgresql.enabled` | `true` | Database | | PostgreSQL | `apps.postgresql.enabled` | `true` | Database |
| Redis | `redis.enabled` | `true` | Cache Database | | Redis | `apps.redis.enabled` | `true` | Cache Database |
| XWiki | `xwiki.enabled` | `true` | Knowledge management | | XWiki | `apps.xwiki.enabled` | `true` | Knowledge management |
Exemplary, Jitsi can be disabled like: Exemplary, Jitsi can be disabled like:
```yaml ```yaml
jitsi: apps:
enabled: false jitsi:
enabled: false
``` ```
## Private registries ## Private registries
@@ -304,8 +305,10 @@ Enabling DKIM signing of emails helps to reduce spam and increases trust.
openDesk ships dkimpy-milter as Postfix milter for signing emails. openDesk ships dkimpy-milter as Postfix milter for signing emails.
```yaml ```yaml
dkimpy: apps:
enable: true dkimpy:
enabled: true
smtp:
dkim: dkim:
key: key:
value: "HzZs08QF1O7UiAkcM9T3U7rePPECtSFvWZIvyKqdg8E=" value: "HzZs08QF1O7UiAkcM9T3U7rePPECtSFvWZIvyKqdg8E="
@@ -337,8 +340,9 @@ secret named `opendesk-certificates-tls` must be present in the application name
turn off `Certificate` resource creation by: turn off `Certificate` resource creation by:
```yaml ```yaml
certificates: apps:
enabled: false certificates:
enabled: false
``` ```
If you want to leverage the `cert-manager.io` to handle certificates, like `Let's encrypt`, you need to provide the If you want to leverage the `cert-manager.io` to handle certificates, like `Let's encrypt`, you need to provide the

2
helmfile/environments/default/smtp.yaml.gotmpl
View File

@@ -10,7 +10,7 @@ smtp:
password: {{ env "SMTP_PASSWORD" | quote }} password: {{ env "SMTP_PASSWORD" | quote }}
localpartNoReply: "no-reply" localpartNoReply: "no-reply"
# For the following settings to have effect `dkimpy.enabled` must be `true`. # For the following settings to have effect `apps.dkimpy.enabled` must be `true`.
dkim: dkim:
key: key:
# DKIM private key as plaintext value. # DKIM private key as plaintext value.