From 74945a5fecb5b8bb53df99452ba90e0b900c252e Mon Sep 17 00:00:00 2001 From: Anja Barz Date: Thu, 6 Mar 2025 14:45:31 +0100 Subject: [PATCH 1/3] initial push --- .../05-environment-variables.md | 72 +++++++++++++++++++ docs/admin/30-configuration/10-office.md | 3 +- 2 files changed, 74 insertions(+), 1 deletion(-) create mode 100644 docs/admin/30-configuration/05-environment-variables.md diff --git a/docs/admin/30-configuration/05-environment-variables.md b/docs/admin/30-configuration/05-environment-variables.md new file mode 100644 index 00000000..8a10ea25 --- /dev/null +++ b/docs/admin/30-configuration/05-environment-variables.md @@ -0,0 +1,72 @@ +--- +sidebar_position: 1 +id: env-variables +title: Environment Variables +draft: true +--- + +| Variable | Description | Default Value | +|---------------------------------|------------------------------------------------------------------------|------------------------------------------------------| +|**Basic Settings** | | | +| LOG_DRIVER | Defines the Docker Compose log driver used. | local | +| INSECURE | Skips certificate validation for OpenCloud parts when using self-signed certificates. | true (should be commented out on internet-facing servers) | +|**Traefik Settings** | | | +| TRAEFIK_DASHBOARD | Enables serving the Traefik dashboard. | false | +| TRAEFIK_DOMAIN | Sets the domain for the Traefik dashboard. | traefik.opencloud.test | +| TRAEFIK_BASIC_AUTH_USERS | Configures basic authentication for the Traefik dashboard. | admin:admin (user "admin", password "admin") | +| TRAEFIK_ACME_MAIL | Specifies the email address for obtaining Let's Encrypt certificates. | None specified in source | +| TRAEFIK_ACME_CASERVER | Used for testing the certificate process. | None specified in source | +|**OpenCloud Settings** | | | +| OPENCLOUD | Enables the core OpenCloud service. | :opencloud.yml | +| OC_DOCKER_IMAGE | Defines the OpenCloud container image. | opencloudeu/opencloud-rolling | +| OC_DOCKER_TAG | Specifies the OpenCloud container version. | latest | +| OC_DOMAIN | Sets the domain for the OpenCloud frontend. | cloud.opencloud.test | +| ADMIN_PASSWORD | Sets the OpenCloud admin user password. | admin | +| DEMO_USERS | Determines whether demo users are created. | false | +| LOG_LEVEL | Defines the OpenCloud log level. | None specified in source | +| OC_CONFIG_DIR | Defines the OpenCloud configuration storage location. | /your/local/opencloud/config (example path) | +| OC_DATA_DIR | Defines the OpenCloud data storage location. | /your/local/opencloud/data (example path) | +|**S3 Storage configuration - optional** | | | +| DECOMPOSEDS3 | Enables S3 storage. | :decomposeds3.yml | +| DECOMPOSEDS3_ENDPOINT | Configures the S3 storage endpoint. | http://minio:9000 | +| DECOMPOSEDS3_REGION | Sets the S3 region. | default | +| DECOMPOSEDS3_ACCESS_KEY | Specifies the S3 access key. | opencloud | +| DECOMPOSEDS3_SECRET_KEY | Defines the S3 secret key. | opencloud-secret-key | +| DECOMPOSEDS3_BUCKET | Sets the S3 bucket. | opencloud | +| DECOMPOSEDS3_MINIO | Adds local Minio S3 storage. | :minio.yml | +| MINIO_DOMAIN | Sets the Minio domain. | minio.opencloud.test | +|**POSIX Storage configuration - optional** | | | +| POSIX | Enables POSIX storage. | :posix.yml | +|**SMPT settings** | | | +| SMTP_HOST | Specifies the SMTP host to connect to. | None specified in source | +| SMTP_PORT | Sets the port of the SMTP host. | None specified in source | +| SMTP_SENDER | Defines the email address used for sending OpenCloud notification emails. | None specified in source | +| SMTP_USERNAME | Sets the username for the SMTP host. | None specified in source | +| SMTP_PASSWORD | Defines the password for the SMTP host. | None specified in source | +| SMTP_AUTHENTICATION | Configures the authentication method for SMTP communication. | None specified in source | +| SMTP_INSECURE | Allows insecure connections to the SMTP server. | false | +|**Addititional services** | | | +| START_ADDITIONAL_SERVICES | Defines additional services to start on OpenCloud startup. | notifications | +| EXTENSIONS | Enables the creation of a new named volume for web extensions. | :web_extensions/extensions.yml | +| COMPANION_IMAGE | Specifies the Docker image for Uppy Companion. | None specified in source | +| COMPANION_DOMAIN | Sets the domain for Uppy Companion. | companion.opencloud.test | +| COMPANION_ONEDRIVE_KEY | Provider settings for OneDrive. | None specified in source | +| COMPANION_ONEDRIVE_SECRET | Provider settings for OneDrive. | None specified in source | +| TIKA | Enables Tika (search). | :tika.yml | +| TIKA_IMAGE | Sets the desired Docker image tag or digest for Tika. | latest | +| COLLABORA | Enables Collabora web office. | :collabora.yml | +| COLLABORA_DOMAIN | Sets the domain for Collabora. | collabora.opencloud.test | +| WOPISERVER_DOMAIN | Sets the domain for the wopiserver which handles OnlyOffice. | wopiserver.opencloud.test | +| COLLABORA_ADMIN_USER | Sets the admin user for Collabora. | admin | +| COLLABORA_ADMIN_PASSWORD | Sets the admin password for Collabora. | admin | +| COLLABORA_SSL_ENABLE | Enables SSL for Collabora Online. | false | +| COLLABORA_SSL_VERIFICATION | Enables SSL verification for Collabora Online. | false | +| MONITORING | Enables monitoring. | :monitoring_tracing/monitoring.yml | +| CLAMAV | Enables the ClamAV virus scanner. | :clamav.yml | +| CLAMAV_DOCKER_TAG | Sets the image version of the ClamAV container. | latest | +| ONLYOFFICE | Enables OnlyOffice. | :onlyoffice.yml | +| ONLYOFFICE_DOMAIN | Sets the domain for OnlyOffice [17]. | onlyoffice.opencloud.test | +| WOPISERVER_ONLYOFFICE_DOMAIN | Sets the domain for the wopiserver which handles OnlyOffice [17]. | None specified in source | +| INBUCKET | Enables Inbucket, a mail catcher tool [17]. | :inbucket.yml | +| INBUCKET_DOMAIN | Sets the domain for Inbucket [18]. | mail.opencloud.test | +| COMPOSE_FILE | Assembles the supplemental compose files to be used [18]. | docker-compose.yml plus supplemental configs | diff --git a/docs/admin/30-configuration/10-office.md b/docs/admin/30-configuration/10-office.md index 2828617c..4c3619bb 100644 --- a/docs/admin/30-configuration/10-office.md +++ b/docs/admin/30-configuration/10-office.md @@ -3,4 +3,5 @@ sidebar_position: 1 id: office title: Office draft: true ---- \ No newline at end of file +--- + From b96cd97e42c48adde0c3e82356ded04f68d68a69 Mon Sep 17 00:00:00 2001 From: Anja Barz Date: Thu, 6 Mar 2025 15:04:52 +0100 Subject: [PATCH 2/3] add missing parts in space roles --- docs/user/roles/space-roles.md | 11 ++++++----- .../current/user/roles/space-roles.md | 15 +++++++++------ 2 files changed, 15 insertions(+), 11 deletions(-) diff --git a/docs/user/roles/space-roles.md b/docs/user/roles/space-roles.md index 7fffadc0..e902687a 100644 --- a/docs/user/roles/space-roles.md +++ b/docs/user/roles/space-roles.md @@ -6,11 +6,11 @@ title: Space roles in OpenCloud ### Space Roles in OpenCloud -| Role | view | download | upload | edit | add | delete | manage members | disable / enable Space | delete Space -| :----------| :-: | :-: | :-: | :-: | :-: | :-: | :-: | :-: | :-: -| can view | x | x | - | - | - | - | - | - | - -| can edit | x | x | x | x | x | x | - | - | - -| can manage | x | x | x | x | x | x | x | x | x +| Role | view | download | upload | edit | add | delete | manage members | disable / enable Space | edit quota | delete Space +| :----------| :-: | :-: | :-: | :-: | :-: | :-: | :-: | :-: | :-: | :-: +| can view | x | x | - | - | - | - | - | - | - | - +| can edit | x | x | x | x | x | x | - | - | - | - +| can manage | x | x | x | x | x | x | x | x | x | x In a Space, members can have different roles that give them different levels of access. @@ -30,6 +30,7 @@ This role gives the member all the abilities of "Can Edit," plus: - Add or remove members from the Space - Change the roles of other members in the Space - Enable and disable the Space +- Edit the quota of the Space - Delete the Space **Each role determines what a member can do within the Space!** diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/roles/space-roles.md b/i18n/de/docusaurus-plugin-content-docs/current/user/roles/space-roles.md index 316ab085..08645bca 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/user/roles/space-roles.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/user/roles/space-roles.md @@ -6,11 +6,11 @@ title: Rollen für Spaces ### Rollen für Spaces in OpenCloud -| Role | anzeigen | herunterladen | hochladen | bearbeiten | erstellen | löschen | Mitglieder verwalten | -| :----------| :-: | :-: | :-: | :-: | :-: | :-: | :-: | -| kann anzeigen | x | x | - | - | - | - | - | -| kann bearbeiten | x | x | x | x | x | x | - | -| kann verwalten | x | x | x | x | x | x | x | +| Role | anzeigen | herunterladen | hochladen | bearbeiten | erstellen | löschen | Mitglieder verwalten | deaktivieren / aktivieren Space | Quota bearbeiten | Space löschen +| :----------| :-: | :-: | :-: | :-: | :-: | :-: | :-: | :-: | :-: | :-: +| can view | x | x | - | - | - | - | - | - | - | - +| can edit | x | x | x | x | x | x | - | - | - | - +| can manage | x | x | x | x | x | x | x | x | x | x In einem Space können Mitglieder verschiedene Rollen haben, die ihnen unterschiedliche Zugriffsebenen geben. @@ -26,9 +26,12 @@ Mit dieser Rolle kann das Mitglied alles tun, was ein „Can View“-Mitglied tu - Gelöschte Dateien wiederherstellen ### Verwalten können -Diese Rolle gibt dem Mitglied alle Fähigkeiten von „Kann bearbeiten“, plus: +Diese Rolle verleiht dem Mitglied alle Fähigkeiten von „Kann bearbeiten“, plus: - Hinzufügen oder Entfernen von Mitgliedern aus dem Space - Ändern der Rollen anderer Mitglieder im Space +- Aktivieren und Deaktivieren des Spaces +- Bearbeiten der Quote des Spaces +- Löschen des Spaces **Jede Rolle bestimmt, was ein Mitglied innerhalb des Spaces tun kann!** From 20562ef8a59195220ab644eca91f8f05b306e332 Mon Sep 17 00:00:00 2001 From: Anja Barz Date: Thu, 6 Mar 2025 16:36:32 +0100 Subject: [PATCH 3/3] remove accendially added env vars --- .../05-environment-variables.md | 72 ------------------- 1 file changed, 72 deletions(-) delete mode 100644 docs/admin/30-configuration/05-environment-variables.md diff --git a/docs/admin/30-configuration/05-environment-variables.md b/docs/admin/30-configuration/05-environment-variables.md deleted file mode 100644 index 8a10ea25..00000000 --- a/docs/admin/30-configuration/05-environment-variables.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -sidebar_position: 1 -id: env-variables -title: Environment Variables -draft: true ---- - -| Variable | Description | Default Value | -|---------------------------------|------------------------------------------------------------------------|------------------------------------------------------| -|**Basic Settings** | | | -| LOG_DRIVER | Defines the Docker Compose log driver used. | local | -| INSECURE | Skips certificate validation for OpenCloud parts when using self-signed certificates. | true (should be commented out on internet-facing servers) | -|**Traefik Settings** | | | -| TRAEFIK_DASHBOARD | Enables serving the Traefik dashboard. | false | -| TRAEFIK_DOMAIN | Sets the domain for the Traefik dashboard. | traefik.opencloud.test | -| TRAEFIK_BASIC_AUTH_USERS | Configures basic authentication for the Traefik dashboard. | admin:admin (user "admin", password "admin") | -| TRAEFIK_ACME_MAIL | Specifies the email address for obtaining Let's Encrypt certificates. | None specified in source | -| TRAEFIK_ACME_CASERVER | Used for testing the certificate process. | None specified in source | -|**OpenCloud Settings** | | | -| OPENCLOUD | Enables the core OpenCloud service. | :opencloud.yml | -| OC_DOCKER_IMAGE | Defines the OpenCloud container image. | opencloudeu/opencloud-rolling | -| OC_DOCKER_TAG | Specifies the OpenCloud container version. | latest | -| OC_DOMAIN | Sets the domain for the OpenCloud frontend. | cloud.opencloud.test | -| ADMIN_PASSWORD | Sets the OpenCloud admin user password. | admin | -| DEMO_USERS | Determines whether demo users are created. | false | -| LOG_LEVEL | Defines the OpenCloud log level. | None specified in source | -| OC_CONFIG_DIR | Defines the OpenCloud configuration storage location. | /your/local/opencloud/config (example path) | -| OC_DATA_DIR | Defines the OpenCloud data storage location. | /your/local/opencloud/data (example path) | -|**S3 Storage configuration - optional** | | | -| DECOMPOSEDS3 | Enables S3 storage. | :decomposeds3.yml | -| DECOMPOSEDS3_ENDPOINT | Configures the S3 storage endpoint. | http://minio:9000 | -| DECOMPOSEDS3_REGION | Sets the S3 region. | default | -| DECOMPOSEDS3_ACCESS_KEY | Specifies the S3 access key. | opencloud | -| DECOMPOSEDS3_SECRET_KEY | Defines the S3 secret key. | opencloud-secret-key | -| DECOMPOSEDS3_BUCKET | Sets the S3 bucket. | opencloud | -| DECOMPOSEDS3_MINIO | Adds local Minio S3 storage. | :minio.yml | -| MINIO_DOMAIN | Sets the Minio domain. | minio.opencloud.test | -|**POSIX Storage configuration - optional** | | | -| POSIX | Enables POSIX storage. | :posix.yml | -|**SMPT settings** | | | -| SMTP_HOST | Specifies the SMTP host to connect to. | None specified in source | -| SMTP_PORT | Sets the port of the SMTP host. | None specified in source | -| SMTP_SENDER | Defines the email address used for sending OpenCloud notification emails. | None specified in source | -| SMTP_USERNAME | Sets the username for the SMTP host. | None specified in source | -| SMTP_PASSWORD | Defines the password for the SMTP host. | None specified in source | -| SMTP_AUTHENTICATION | Configures the authentication method for SMTP communication. | None specified in source | -| SMTP_INSECURE | Allows insecure connections to the SMTP server. | false | -|**Addititional services** | | | -| START_ADDITIONAL_SERVICES | Defines additional services to start on OpenCloud startup. | notifications | -| EXTENSIONS | Enables the creation of a new named volume for web extensions. | :web_extensions/extensions.yml | -| COMPANION_IMAGE | Specifies the Docker image for Uppy Companion. | None specified in source | -| COMPANION_DOMAIN | Sets the domain for Uppy Companion. | companion.opencloud.test | -| COMPANION_ONEDRIVE_KEY | Provider settings for OneDrive. | None specified in source | -| COMPANION_ONEDRIVE_SECRET | Provider settings for OneDrive. | None specified in source | -| TIKA | Enables Tika (search). | :tika.yml | -| TIKA_IMAGE | Sets the desired Docker image tag or digest for Tika. | latest | -| COLLABORA | Enables Collabora web office. | :collabora.yml | -| COLLABORA_DOMAIN | Sets the domain for Collabora. | collabora.opencloud.test | -| WOPISERVER_DOMAIN | Sets the domain for the wopiserver which handles OnlyOffice. | wopiserver.opencloud.test | -| COLLABORA_ADMIN_USER | Sets the admin user for Collabora. | admin | -| COLLABORA_ADMIN_PASSWORD | Sets the admin password for Collabora. | admin | -| COLLABORA_SSL_ENABLE | Enables SSL for Collabora Online. | false | -| COLLABORA_SSL_VERIFICATION | Enables SSL verification for Collabora Online. | false | -| MONITORING | Enables monitoring. | :monitoring_tracing/monitoring.yml | -| CLAMAV | Enables the ClamAV virus scanner. | :clamav.yml | -| CLAMAV_DOCKER_TAG | Sets the image version of the ClamAV container. | latest | -| ONLYOFFICE | Enables OnlyOffice. | :onlyoffice.yml | -| ONLYOFFICE_DOMAIN | Sets the domain for OnlyOffice [17]. | onlyoffice.opencloud.test | -| WOPISERVER_ONLYOFFICE_DOMAIN | Sets the domain for the wopiserver which handles OnlyOffice [17]. | None specified in source | -| INBUCKET | Enables Inbucket, a mail catcher tool [17]. | :inbucket.yml | -| INBUCKET_DOMAIN | Sets the domain for Inbucket [18]. | mail.opencloud.test | -| COMPOSE_FILE | Assembles the supplemental compose files to be used [18]. | docker-compose.yml plus supplemental configs |