From b43d99b1981598b4e624740012dc5fed0c3e8256 Mon Sep 17 00:00:00 2001 From: Willy Kloucek Date: Thu, 5 May 2022 10:55:37 +0200 Subject: [PATCH] update docs --- docs/extensions/app-registry/apps.md | 2 +- docs/ocis/deployment/oc10_ocis_parallel.md | 96 ++++++++--------- docs/ocis/deployment/ocis_hello.md | 50 ++++----- .../deployment/ocis_individual_services.md | 1 + docs/ocis/deployment/ocis_keycloak.md | 1 + docs/ocis/deployment/ocis_s3.md | 74 ++++++------- docs/ocis/deployment/ocis_traefik.md | 18 ++-- docs/ocis/deployment/ocis_wopi.md | 100 +++++++++--------- 8 files changed, 170 insertions(+), 172 deletions(-) diff --git a/docs/extensions/app-registry/apps.md b/docs/extensions/app-registry/apps.md index 7bcff036b1..d35b2e82a2 100644 --- a/docs/extensions/app-registry/apps.md +++ b/docs/extensions/app-registry/apps.md @@ -439,7 +439,7 @@ services: ... environment: ... - STORAGE_GATEWAY_GRPC_ADDR: 0.0.0.0:9142 # make the REVA gateway accessible to the app drivers + GATEWAY_GRPC_ADDR: 0.0.0.0:9142 # make the REVA gateway accessible to the app drivers ocis-appdriver-collabora: image: owncloud/ocis:latest diff --git a/docs/ocis/deployment/oc10_ocis_parallel.md b/docs/ocis/deployment/oc10_ocis_parallel.md index d87f233ae5..7067cf389d 100644 --- a/docs/ocis/deployment/oc10_ocis_parallel.md +++ b/docs/ocis/deployment/oc10_ocis_parallel.md @@ -54,60 +54,60 @@ See also [example server setup]({{< ref "preparing_server" >}}) The file by default looks like this: ```bash - # If you're on a internet facing server please comment out following line. - # It skips certificate validation for various parts of oCIS and is needed if you use self signed certificates. - INSECURE=true + # If you're on a internet facing server please comment out following line. + # It skips certificate validation for various parts of oCIS and is needed if you use self signed certificates. + INSECURE=true - ### Traefik settings ### - TRAEFIK_LOG_LEVEL= - # Serve Traefik dashboard. Defaults to "false". - TRAEFIK_DASHBOARD= - # Domain of Traefik, where you can find the dashboard. Defaults to "traefik.owncloud.test" - TRAEFIK_DOMAIN= - # Basic authentication for the dashboard. Defaults to user "admin" and password "admin" - TRAEFIK_BASIC_AUTH_USERS= - # Email address for obtaining LetsEncrypt certificates, needs only be changed if this is a public facing server - TRAEFIK_ACME_MAIL= + ### Traefik settings ### + TRAEFIK_LOG_LEVEL= + # Serve Traefik dashboard. Defaults to "false". + TRAEFIK_DASHBOARD= + # Domain of Traefik, where you can find the dashboard. Defaults to "traefik.owncloud.test" + TRAEFIK_DOMAIN= + # Basic authentication for the dashboard. Defaults to user "admin" and password "admin" + TRAEFIK_BASIC_AUTH_USERS= + # Email address for obtaining LetsEncrypt certificates, needs only be changed if this is a public facing server + TRAEFIK_ACME_MAIL= - ### shared oCIS / oC10 settings ### - # Domain of oCIS / oC10, where you can find the frontend. Defaults to "cloud.owncloud.test" - CLOUD_DOMAIN= + ### shared oCIS / oC10 settings ### + # Domain of oCIS / oC10, where you can find the frontend. Defaults to "cloud.owncloud.test" + CLOUD_DOMAIN= - ### oCIS settings ### - # oCIS version. Defaults to "latest" - OCIS_DOCKER_TAG= - # JWT secret which is used for the storage provider. Must be changed in order to have a secure oCIS. Defaults to "Pive-Fumkiu4" - OCIS_JWT_SECRET= - # JWT secret which is used for uploads to create transfer tokens. Must be changed in order to have a secure oCIS. Defaults to "replace-me-with-a-transfer-secret" - STORAGE_TRANSFER_SECRET= - # Machine auth api key secret. Must be changed in order to have a secure oCIS. Defaults to "change-me-please" - OCIS_MACHINE_AUTH_API_KEY= + ### oCIS settings ### + # oCIS version. Defaults to "latest" + OCIS_DOCKER_TAG= + # JWT secret which is used for the storage provider. Must be changed in order to have a secure oCIS. Defaults to "Pive-Fumkiu4" + OCIS_JWT_SECRET= + # JWT secret which is used for uploads to create transfer tokens. Must be changed in order to have a secure oCIS. Defaults to "replace-me-with-a-transfer-secret" + STORAGE_TRANSFER_SECRET= + # Machine auth api key secret. Must be changed in order to have a secure oCIS. Defaults to "change-me-please" + OCIS_MACHINE_AUTH_API_KEY= - ### oCIS settings ### - # oC10 version. Defaults to "latest" - OC10_DOCKER_TAG= - # client secret which the openidconnect app uses to authenticate to Keycloak. Defaults to "oc10-oidc-secret" - OC10_OIDC_CLIENT_SECRET= - # app which will be shown when opening the ownCloud 10 UI. Defaults to "files" but also could be set to "web" - OWNCLOUD_DEFAULT_APP= - # if set to "false" (default) links will be opened in the classic UI, if set to "true" ownCloud Web is used - OWNCLOUD_WEB_REWRITE_LINKS= + ### oCIS settings ### + # oC10 version. Defaults to "latest" + OC10_DOCKER_TAG= + # client secret which the openidconnect app uses to authenticate to Keycloak. Defaults to "oc10-oidc-secret" + OC10_OIDC_CLIENT_SECRET= + # app which will be shown when opening the ownCloud 10 UI. Defaults to "files" but also could be set to "web" + OWNCLOUD_DEFAULT_APP= + # if set to "false" (default) links will be opened in the classic UI, if set to "true" ownCloud Web is used + OWNCLOUD_WEB_REWRITE_LINKS= - ### LDAP settings ### - # password for the LDAP admin user "cn=admin,dc=owncloud,dc=com", defaults to "admin" - LDAP_ADMIN_PASSWORD= - # Domain of the LDAP management frontend. Defaults to "ldap.owncloud.test" - LDAP_MANAGER_DOMAIN= + ### LDAP settings ### + # password for the LDAP admin user "cn=admin,dc=owncloud,dc=com", defaults to "admin" + LDAP_ADMIN_PASSWORD= + # Domain of the LDAP management frontend. Defaults to "ldap.owncloud.test" + LDAP_MANAGER_DOMAIN= - ### Keycloak ### - # Domain of Keycloak, where you can find the management and authentication frontend. Defaults to "keycloak.owncloud.test" - KEYCLOAK_DOMAIN= - # Realm which to be used with oC10 and oCIS. Defaults to "owncloud" - KEYCLOAK_REALM= - # Admin user login name. Defaults to "admin" - KEYCLOAK_ADMIN_USER= - # Admin user login password. Defaults to "admin" - KEYCLOAK_ADMIN_PASSWORD= + ### Keycloak ### + # Domain of Keycloak, where you can find the management and authentication frontend. Defaults to "keycloak.owncloud.test" + KEYCLOAK_DOMAIN= + # Realm which to be used with oC10 and oCIS. Defaults to "owncloud" + KEYCLOAK_REALM= + # Admin user login name. Defaults to "admin" + KEYCLOAK_ADMIN_USER= + # Admin user login password. Defaults to "admin" + KEYCLOAK_ADMIN_PASSWORD= ``` You are installing oCIS on a server and Traefik will obtain valid certificates for you so please remove `INSECURE=true` or set it to `false`. diff --git a/docs/ocis/deployment/ocis_hello.md b/docs/ocis/deployment/ocis_hello.md index 25e2a47fd9..8e9adfda6c 100644 --- a/docs/ocis/deployment/ocis_hello.md +++ b/docs/ocis/deployment/ocis_hello.md @@ -48,34 +48,34 @@ See also [example server setup]({{< ref "preparing_server" >}}) The file by default looks like this: ```bash - # If you're on a internet facing server please comment out following line. - # It skips certificate validation for various parts of oCIS and is needed if you use self signed certificates. - INSECURE=true + # If you're on a internet facing server please comment out following line. + # It skips certificate validation for various parts of oCIS and is needed if you use self signed certificates. + INSECURE=true - ### Traefik settings ### - # Serve Traefik dashboard. Defaults to "false". - TRAEFIK_DASHBOARD= - # Domain of Traefik, where you can find the dashboard. Defaults to "traefik.owncloud.test" - TRAEFIK_DOMAIN= - # Basic authentication for the dashboard. Defaults to user "admin" and password "admin" - TRAEFIK_BASIC_AUTH_USERS= - # Email address for obtaining LetsEncrypt certificates, needs only be changed if this is a public facing server - TRAEFIK_ACME_MAIL= + ### Traefik settings ### + # Serve Traefik dashboard. Defaults to "false". + TRAEFIK_DASHBOARD= + # Domain of Traefik, where you can find the dashboard. Defaults to "traefik.owncloud.test" + TRAEFIK_DOMAIN= + # Basic authentication for the dashboard. Defaults to user "admin" and password "admin" + TRAEFIK_BASIC_AUTH_USERS= + # Email address for obtaining LetsEncrypt certificates, needs only be changed if this is a public facing server + TRAEFIK_ACME_MAIL= - ### oCIS settings ### - # oCIS version. Defaults to "latest" - OCIS_DOCKER_TAG= - # Domain of oCIS, where you can find the frontend. Defaults to "ocis.owncloud.test" - OCIS_DOMAIN= - # oCIS admin user password. Defaults to "admin". - ADMIN_PASSWORD= - # The demo users should not be created on a production instance - # because their passwords are public. Defaults to "false". - DEMO_USERS= + ### oCIS settings ### + # oCIS version. Defaults to "latest" + OCIS_DOCKER_TAG= + # Domain of oCIS, where you can find the frontend. Defaults to "ocis.owncloud.test" + OCIS_DOMAIN= + # oCIS admin user password. Defaults to "admin". + ADMIN_PASSWORD= + # The demo users should not be created on a production instance + # because their passwords are public. Defaults to "false". + DEMO_USERS= - ### oCIS Hello settings ### - # oCIS Hello version. Defaults to "latest" - OCIS_HELLO_DOCKER_TAG= + ### oCIS Hello settings ### + # oCIS Hello version. Defaults to "latest" + OCIS_HELLO_DOCKER_TAG= ``` You are installing oCIS on a server and Traefik will obtain valid certificates for you so please remove `INSECURE=true` or set it to `false`. diff --git a/docs/ocis/deployment/ocis_individual_services.md b/docs/ocis/deployment/ocis_individual_services.md index 718e5291a4..0ea6ba9f55 100644 --- a/docs/ocis/deployment/ocis_individual_services.md +++ b/docs/ocis/deployment/ocis_individual_services.md @@ -45,6 +45,7 @@ See also [example server setup]({{< ref "preparing_server" >}}) * Open the `.env` file in a text editor The file by default looks like this: + ```bash # If you're on a internet facing server please comment out following line. # It skips certificate validation for various parts of oCIS and is needed if you use self signed certificates. diff --git a/docs/ocis/deployment/ocis_keycloak.md b/docs/ocis/deployment/ocis_keycloak.md index 5708569e2a..28db3b1b95 100644 --- a/docs/ocis/deployment/ocis_keycloak.md +++ b/docs/ocis/deployment/ocis_keycloak.md @@ -49,6 +49,7 @@ See also [example server setup]({{< ref "preparing_server" >}}) * Open the `.env` file in a text editor The file by default looks like this: + ```bash # If you're on a internet facing server please comment out following line. # It skips certificate validation for various parts of oCIS and is needed if you use self signed certificates. diff --git a/docs/ocis/deployment/ocis_s3.md b/docs/ocis/deployment/ocis_s3.md index 38c2d9ddf2..39350a46c8 100644 --- a/docs/ocis/deployment/ocis_s3.md +++ b/docs/ocis/deployment/ocis_s3.md @@ -49,47 +49,47 @@ See also [example server setup]({{< ref "preparing_server" >}}) * Open the `.env` file in a text editor The file by default looks like this: + ```bash - # If you're on a internet facing server please comment out following line. - # It skips certificate validation for various parts of oCIS and is needed if you use self signed certificates. - INSECURE=true + # If you're on a internet facing server please comment out following line. + # It skips certificate validation for various parts of oCIS and is needed if you use self signed certificates. + INSECURE=true - ### Traefik settings ### - # Serve Traefik dashboard. Defaults to "false". - TRAEFIK_DASHBOARD= - # Domain of Traefik, where you can find the dashboard. Defaults to "traefik.owncloud.test" - TRAEFIK_DOMAIN= - # Basic authentication for the dashboard. Defaults to user "admin" and password "admin" - TRAEFIK_BASIC_AUTH_USERS= - # Email address for obtaining LetsEncrypt certificates, needs only be changed if this is a public facing server - TRAEFIK_ACME_MAIL= + ### Traefik settings ### + # Serve Traefik dashboard. Defaults to "false". + TRAEFIK_DASHBOARD= + # Domain of Traefik, where you can find the dashboard. Defaults to "traefik.owncloud.test" + TRAEFIK_DOMAIN= + # Basic authentication for the dashboard. Defaults to user "admin" and password "admin" + TRAEFIK_BASIC_AUTH_USERS= + # Email address for obtaining LetsEncrypt certificates, needs only be changed if this is a public facing server + TRAEFIK_ACME_MAIL= - ### oCIS settings ### - # oCIS version. Defaults to "latest" - OCIS_DOCKER_TAG= - # Domain of oCIS, where you can find the frontend. Defaults to "ocis.owncloud.test" - OCIS_DOMAIN= - # IDP LDAP bind password. Must be changed in order to have a secure oCIS. Defaults to "idp". - IDP_LDAP_BIND_PASSWORD= - # Storage LDAP bind password. Must be changed in order to have a secure oCIS. Defaults to "reva". - STORAGE_LDAP_BIND_PASSWORD= - # JWT secret which is used for the storage provider. Must be changed in order to have a secure oCIS. Defaults to "Pive-Fumkiu4" - OCIS_JWT_SECRET= - # JWT secret which is used for uploads to create transfer tokens. Must be changed in order to have a secure oCIS. Defaults to "replace-me-with-a-transfer-secret" - STORAGE_TRANSFER_SECRET= - # Machine auth api key secret. Must be changed in order to have a secure oCIS. Defaults to "change-me-please" - OCIS_MACHINE_AUTH_API_KEY= - - ### MINIO / S3 settings ### - # Domain of MinIO where the Web UI is accessible. Defaults to "minio.owncloud.test". - MINIO_DOMAIN= - # S3 bucket name, where oCIS stores its data in. Defaults to "ocis-bucket". - MINIO_BUCKET= - # S3 bucket access key, which oCIS uses to authenticate. Defaults to "ocis". - MINIO_ACCESS_KEY= - # S3 bucket access key secret, which oCIS uses to authenticate. Defaults to "ocis-secret-key". - MINIO_SECRET_KEY= + ### oCIS settings ### + # oCIS version. Defaults to "latest" + OCIS_DOCKER_TAG= + # Domain of oCIS, where you can find the frontend. Defaults to "ocis.owncloud.test" + OCIS_DOMAIN= + # IDP LDAP bind password. Must be changed in order to have a secure oCIS. Defaults to "idp". + IDP_LDAP_BIND_PASSWORD= + # Storage LDAP bind password. Must be changed in order to have a secure oCIS. Defaults to "reva". + STORAGE_LDAP_BIND_PASSWORD= + # JWT secret which is used for the storage provider. Must be changed in order to have a secure oCIS. Defaults to "Pive-Fumkiu4" + OCIS_JWT_SECRET= + # JWT secret which is used for uploads to create transfer tokens. Must be changed in order to have a secure oCIS. Defaults to "replace-me-with-a-transfer-secret" + STORAGE_TRANSFER_SECRET= + # Machine auth api key secret. Must be changed in order to have a secure oCIS. Defaults to "change-me-please" + OCIS_MACHINE_AUTH_API_KEY= + ### MINIO / S3 settings ### + # Domain of MinIO where the Web UI is accessible. Defaults to "minio.owncloud.test". + MINIO_DOMAIN= + # S3 bucket name, where oCIS stores its data in. Defaults to "ocis-bucket". + MINIO_BUCKET= + # S3 bucket access key, which oCIS uses to authenticate. Defaults to "ocis". + MINIO_ACCESS_KEY= + # S3 bucket access key secret, which oCIS uses to authenticate. Defaults to "ocis-secret-key". + MINIO_SECRET_KEY= ``` You are installing oCIS on a server and Traefik will obtain valid certificates for you so please remove `INSECURE=true` or set it to `false`. diff --git a/docs/ocis/deployment/ocis_traefik.md b/docs/ocis/deployment/ocis_traefik.md index ee6851d108..0bc2d15738 100644 --- a/docs/ocis/deployment/ocis_traefik.md +++ b/docs/ocis/deployment/ocis_traefik.md @@ -44,6 +44,7 @@ See also [example server setup]({{< ref "preparing_server" >}}) * Open the `.env` file in a text editor The file by default looks like this: + ```bash # If you're on a internet facing server please comment out following line. # It skips certificate validation for various parts of oCIS and is needed if you use self signed certificates. @@ -64,16 +65,11 @@ See also [example server setup]({{< ref "preparing_server" >}}) OCIS_DOCKER_TAG= # Domain of oCIS, where you can find the frontend. Defaults to "ocis.owncloud.test" OCIS_DOMAIN= - # IDP LDAP bind password. Must be changed in order to have a secure oCIS. Defaults to "idp". - IDP_LDAP_BIND_PASSWORD= - # Storage LDAP bind password. Must be changed in order to have a secure oCIS. Defaults to "reva". - STORAGE_LDAP_BIND_PASSWORD= - # JWT secret which is used for the storage provider. Must be changed in order to have a secure oCIS. Defaults to "Pive-Fumkiu4" - OCIS_JWT_SECRET= - # JWT secret which is used for uploads to create transfer tokens. Must be changed in order to have a secure oCIS. Defaults to "replace-me-with-a-transfer-secret" - STORAGE_TRANSFER_SECRET= - # Machine auth api key secret. Must be changed in order to have a secure oCIS. Defaults to "change-me-please" - OCIS_MACHINE_AUTH_API_KEY= + # oCIS admin user password. Defaults to "admin". + ADMIN_PASSWORD= + # The demo users should not be created on a production instance + # because their passwords are public. Defaults to "false". + DEMO_USERS= ``` You are installing oCIS on a server and Traefik will obtain valid certificates for you so please remove `INSECURE=true` or set it to `false`. @@ -88,6 +84,8 @@ See also [example server setup]({{< ref "preparing_server" >}}) Set your domain for the oCIS frontend in `OCIS_DOMAIN=`, e.g. `OCIS_DOMAIN=ocis.owncloud.test`. + Set the initial admin user password in `ADMIN_PASSWORD=`, it defaults to `admin`. + Now you have configured everything and can save the file. * Start the docker stack diff --git a/docs/ocis/deployment/ocis_wopi.md b/docs/ocis/deployment/ocis_wopi.md index 99f9713918..4c1199104d 100644 --- a/docs/ocis/deployment/ocis_wopi.md +++ b/docs/ocis/deployment/ocis_wopi.md @@ -58,64 +58,60 @@ See also [example server setup]({{< ref "preparing_server" >}}) * Open the `.env` file in a text editor The file by default looks like this: + ```bash - # If you're on a internet facing server please comment out following line. - # It skips certificate validation for various parts of oCIS and is needed if you use self signed certificates. - INSECURE=true + # If you're on a internet facing server please comment out following line. + # It skips certificate validation for various parts of oCIS and is needed if you use self signed certificates. + INSECURE=true - ### Traefik settings ### - # Serve Traefik dashboard. Defaults to "false". - TRAEFIK_DASHBOARD= - # Domain of Traefik, where you can find the dashboard. Defaults to "traefik.owncloud.test" - TRAEFIK_DOMAIN= - # Basic authentication for the dashboard. Defaults to user "admin" and password "admin" - TRAEFIK_BASIC_AUTH_USERS= - # Email address for obtaining LetsEncrypt certificates, needs only be changed if this is a public facing server - TRAEFIK_ACME_MAIL= + ### Traefik settings ### + # Serve Traefik dashboard. Defaults to "false". + TRAEFIK_DASHBOARD= + # Domain of Traefik, where you can find the dashboard. Defaults to "traefik.owncloud.test" + TRAEFIK_DOMAIN= + # Basic authentication for the dashboard. Defaults to user "admin" and password "admin" + TRAEFIK_BASIC_AUTH_USERS= + # Email address for obtaining LetsEncrypt certificates, needs only be changed if this is a public facing server + TRAEFIK_ACME_MAIL= - ### oCIS settings ### - # oCIS version. Defaults to "latest" - OCIS_DOCKER_TAG= - # Domain of oCIS, where you can find the frontend. Defaults to "ocis.owncloud.test" - OCIS_DOMAIN= - # IDP LDAP bind password. Must be changed in order to have a secure oCIS. Defaults to "idp". - IDP_LDAP_BIND_PASSWORD= - # Storage LDAP bind password. Must be changed in order to have a secure oCIS. Defaults to "reva". - STORAGE_LDAP_BIND_PASSWORD= - # JWT secret which is used for the storage provider. Must be changed in order to have a secure oCIS. Defaults to "Pive-Fumkiu4" - OCIS_JWT_SECRET= - # JWT secret which is used for uploads to create transfer tokens. Must be changed in order to have a secure oCIS. Defaults to "replace-me-with-a-transfer-secret" - STORAGE_TRANSFER_SECRET= - # Machine auth api key secret. Must be changed in order to have a secure oCIS. Defaults to "change-me-please" - OCIS_MACHINE_AUTH_API_KEY= + ### oCIS settings ### + # oCIS version. Defaults to "latest" + OCIS_DOCKER_TAG= + # Domain of oCIS, where you can find the frontend. Defaults to "ocis.owncloud.test" + OCIS_DOMAIN= + # oCIS admin user password. Defaults to "admin". + ADMIN_PASSWORD= + # The demo users should not be created on a production instance + # because their passwords are public. Defaults to "false". + DEMO_USERS= - ### Wopi server settings ### - # cs3org wopi server version. Defaults to "latest" - WOPISERVER_DOCKER_TAG= - # cs3org wopi server domain. Defaults to "wopiserver.owncloud.test" - WOPISERVER_DOMAIN= - # JWT secret which is used for the documents to be request by the Wopi client from the cs3org Wopi server. Must be change in order to have a secure Wopi server. Defaults to "LoremIpsum567" - WOPI_JWT_SECRET= - # JWT secret which is used for the documents to be request by the Wopi client from the cs3org Wopi server. Must be change in order to have a secure Wopi server. Defaults to "LoremIpsum123" - WOPI_IOP_SECRET= + ### Wopi server settings ### + # cs3org wopi server version. Defaults to "latest" + WOPISERVER_DOCKER_TAG= + # cs3org wopi server domain. Defaults to "wopiserver.owncloud.test" + WOPISERVER_DOMAIN= + # JWT secret which is used for the documents to be request by the Wopi client from the cs3org Wopi server. Must be change in order to have a secure Wopi server. Defaults to "LoremIpsum567" + WOPI_JWT_SECRET= + # JWT secret which is used for the documents to be request by the Wopi client from the cs3org Wopi server. Must be change in order to have a secure Wopi server. Defaults to "LoremIpsum123" + WOPI_IOP_SECRET= - ### Collabora settings ### - # Domain of Collabora, where you can find the frontend. Defaults to "collabora.owncloud.test" - COLLABORA_DOMAIN= - # Admin user for Collabora. Defaults to blank, provide one to enable access - COLLABORA_ADMIN_USER= - # Admin password for Collabora. Defaults to blank, provide one to enable access - COLLABORA_ADMIN_PASSWORD= + ### Collabora settings ### + # Domain of Collabora, where you can find the frontend. Defaults to "collabora.owncloud.test" + COLLABORA_DOMAIN= + # Admin user for Collabora. Defaults to blank, provide one to enable access + COLLABORA_ADMIN_USER= + # Admin password for Collabora. Defaults to blank, provide one to enable access + COLLABORA_ADMIN_PASSWORD= - ### OnlyOffice settings ### - # Domain of OnlyOffice, where you can find the frontend. Defaults to "onlyoffice.owncloud.test" - ONLYOFFICE_DOMAIN= + ### OnlyOffice settings ### + # Domain of OnlyOffice, where you can find the frontend. Defaults to "onlyoffice.owncloud.test" + ONLYOFFICE_DOMAIN= - ### CodiMD settings ### - # Domain of Collabora, where you can find the frontend. Defaults to "codimd.owncloud.test" - CODIMD_DOMAIN= - # Secret which is used for the communication with the WOPI server. Must be changed in order to have a secure CodiMD. Defaults to "LoremIpsum456" - CODIMD_SECRET= + ### CodiMD settings ### + # Domain of Collabora, where you can find the frontend. Defaults to "codimd.owncloud.test" + CODIMD_DOMAIN= + # Secret which is used for the communication with the WOPI server. Must be changed in order to have a secure CodiMD. Defaults to "LoremIpsum456" + CODIMD_SECRET= ``` You are installing oCIS on a server and Traefik will obtain valid certificates for you so please remove `INSECURE=true` or set it to `false`. @@ -130,6 +126,8 @@ See also [example server setup]({{< ref "preparing_server" >}}) Set your domain for the oCIS frontend in `OCIS_DOMAIN=`, e.g. `OCIS_DOMAIN=ocis.owncloud.test`. + Set the initial admin user password in `ADMIN_PASSWORD=`, it defaults to `admin`. + By default the CS3Org WOPI server will also be started in the `latest` version. If you want to start a specific version of it, you can set the version to `WOPISERVER_DOCKER_TAG=`. Available versions can be found on [Docker Hub](https://hub.docker.com/r/cs3org/wopiserver/tags?page=1&ordering=last_updated). Set your domain for the CS3Org WOPI server in `WOPISERVER_DOMAIN=`, where all office suites can download the files via the WOPI protocol.