From 1aff5453bfc281df2187a151333b77528f5bfa91 Mon Sep 17 00:00:00 2001 From: Michael Barz Date: Thu, 27 Jun 2024 14:34:13 +0200 Subject: [PATCH] docs: fix spaces and add S3 explanation --- deployments/examples/ocis_full/.env | 12 +++---- docs/ocis/deployment/ocis_full.md | 49 +++++++++++++++++++++++++---- 2 files changed, 49 insertions(+), 12 deletions(-) diff --git a/deployments/examples/ocis_full/.env b/deployments/examples/ocis_full/.env index bf27cf1b49..e1afb4b193 100644 --- a/deployments/examples/ocis_full/.env +++ b/deployments/examples/ocis_full/.env @@ -63,7 +63,7 @@ LOG_LEVEL= # Per default, S3 storage is disabled and we use the local filesystem. # To enable S3 storage, uncomment the following lines and configure the S3 storage. # The leading colon is required to enable the service. -# S3NG=:s3ng.yml +#S3NG=:s3ng.yml # Configure the S3 storage endpoint. Defaults to "http://minio:9000" for testing purposes. S3NG_ENDPOINT= # S3 region. Defaults to "default". @@ -77,7 +77,7 @@ S3NG_BUCKET= # Add local minio S3 storage to the docker-compose file. # This is needed for testing purposes. # The leading colon is required to enable the service. -# S3NG_MINIO=:minio.yml +#S3NG_MINIO=:minio.yml # Minio domain. Defaults to "minio.owncloud.test". MINIO_DOMAIN= @@ -139,11 +139,11 @@ COLLABORA_ADMIN_PASSWORD= # Please see documentation at: https://owncloud.dev/ocis/deployment/monitoring-tracing/ # Only enable if you have Collabora AND OnlyOffice enabled. # The leading colon is required to enable the service. -# MONITORING=:monitoring.yml +#MONITORING=:monitoring.yml ## Uppy Companion Settings ## # The leading colon is required to enable the service. -CLOUD_IMPORTER=:cloudimporter.yml +#CLOUD_IMPORTER=:cloudimporter.yml ## The docker image to be used for uppy companion. # owncloud has built a container with public link import support. COMPANION_IMAGE= @@ -163,7 +163,7 @@ CLAMAV_DOCKER_TAG= ## OnlyOffice Settings ## # The leading colon is required to enable the service. -# ONLYOFFICE=:onlyoffice.yml +#ONLYOFFICE=:onlyoffice.yml # Domain for OnlyOffice. Defaults to "onlyoffice.owncloud.test". ONLYOFFICE_DOMAIN= # Domain for the wopiserver which handles OnlyOffice. @@ -173,7 +173,7 @@ WOPISERVER_ONLYOFFICE_DOMAIN= # Inbucket is a mail catcher tool for testing purposes. # DO NOT use in Production. # The leading colon is required to enable the service. -# INBUCKET=:inbucket.yml +#INBUCKET=:inbucket.yml # email server (in this case inbucket acts as mail catcher). # Domain for Inbucket. Defaults to "mail.owncloud.test". INBUCKET_DOMAIN= diff --git a/docs/ocis/deployment/ocis_full.md b/docs/ocis/deployment/ocis_full.md index 05f5e21c51..882e080171 100644 --- a/docs/ocis/deployment/ocis_full.md +++ b/docs/ocis/deployment/ocis_full.md @@ -37,6 +37,7 @@ The Infinite Scale Team and product management are providing a default setup for ### Optional components +- ClamAV Virusscanner - Cloud Importer (Experimental) - OnlyOffice as an alternative to Collabora - S3 Storage config to connect to an S3 storage backend @@ -269,6 +270,18 @@ Open https://ocis.owncloud.test in your browser and accept the invalid certifica ## Additional services +### Clamav Virusscanner + +You can add a Clamav Virusscanner to the stack. The service is disabled by default. To enable it, uncomment the `CLAMAV` line in the `docker-compose.yml` file. + +```shell {linenos=table,hl_lines=[3]} +## Clamav Settings ## +# The leading colon is required to enable the service. +CLAMAV=:clamav.yml +``` + +After enabling that service, you can add the service to the stack with `docker-compose up -d` again. + ### Traefik dashboard If you want to use the Traefik dashboard, set TRAEFIK_DASHBOARD to `true` (default is `false` and therefore not active). If you activate it, you must set a domain for the Traefik dashboard in `TRAEFIK_DOMAIN=` e.g. `TRAEFIK_DOMAIN=traefik.owncloud.test`. @@ -308,17 +321,41 @@ COMPANION_ONEDRIVE_SECRET= After Enabling that servive by uncommenting the `CLOUD_IMPORTER` line, you can add the service to the stack with `docker-compose up -d` again. -### Clamav Virusscanner +### S3 Storage -You can add a Clamav Virusscanner to the stack. The service is disabled by default. To enable it, uncomment the `CLAMAV` line in the `docker-compose.yml` file. +You can use an S3 compatible Storage as the primary data store. The metadatata of the files will still be stored on the local filesystem. -```shell {linenos=table,hl_lines=[3]} -## Clamav Settings ## +{{}} +The endpoint, region and keys for your S3 Server need to be provided by the service or company who operates it. Normally you can get these via web portal. +{{}} + +```shell {linenos=table,hl_lines=[9,11,13,15,17,19]} +# S3 Storage configuration +# +# - optional +# +# Infinite Scale supports S3 storage as primary storage. +# Per default, S3 storage is disabled and we use the local filesystem. +# To enable S3 storage, uncomment the following lines and configure the S3 storage. # The leading colon is required to enable the service. -CLAMAV=:clamav.yml +S3NG=:s3ng.yml +# Configure the S3 storage endpoint. Defaults to "http://minio:9000" for testing purposes. +S3NG_ENDPOINT= +# S3 region. Defaults to "default". +S3NG_REGION= +# S3 access key. Defaults to "ocis" +S3NG_ACCESS_KEY= +# S3 secret. Defaults to "ocis-secret-key" +S3NG_SECRET_KEY= +# S3 bucket. Defaults to "ocis" +S3NG_BUCKET= ``` -After enabling that service, you can add the service to the stack with `docker-compose up -d` again. +#### Use a local minio S3 storage backend + +For testing purposes, you can use a local minio S3 storage backend. To enable it, uncomment the `S3NG_MINIO` line in the `docker-compose.yml` file. + +The frontend for the minio server is available at `http://minio.owncloud.test` and the access key is `ocis` and the secret key is `ocis-secret`. ## Local setup for web development