Sample

content/deployment/configuration.md

@@ -7,7 +7,104 @@ weight = 40
 
 You will find on this page all the configuration settings available for the Arkindex backend. These settings must be stored in a YAML file, and exposed using a Docker volume to the backend and worker container. The configuration path  is set through `CONFIG_PATH` environment variable.
 
-A minimal file is available on [our public repository](https://gitlab.teklia.com/arkindex/public-architecture/-/blob/master/config.yml).
+# Configuration sample
+
+A minimal file is available here:
+
+```yaml
+---
+# This file must be exposed to the backend and worker container
+# using a Docker volume
+# You can set its path in the container by using the environment variable CONFIG_PATH
+
+# Connection to the postgresql database
+# Here we use a postgresql container on the same network
+database:
+  host: ark-database
+  port: 5432
+  name: arkindex_public
+  user: public_user
+  password: public_data
+
+
+# Connection to the redis server to share asynchronous local jobs
+redis:
+  host: ark-redis
+
+# Connection to an S3-compatible storage API
+# Here we use a minio container on the same network
+s3:
+  access_key_id: minio1234
+  secret_access_key: minio1234
+  endpoint: https://minio.ark.localhost
+  region: local
+
+# Connection to the search engine
+# This is only needed if the search feature is enabled
+solr:
+  api_url: http://ark-solr:8983/solr/
+
+# Cache system to use for performance
+# In production we recommend to use redis
+cache:
+  type: memory
+
+# Control the optional features on your instance
+features:
+  signup: yes
+  search: yes
+
+# Use remote frontend files, hosted by Teklia
+# You need to synchronize the version mentioned here
+# with the one from your backend
+static:
+  frontend_version: 1.3.5
+  cdn_assets_url: https://assets.teklia.com/arkindex
+
+# Configure the remote workers credentials
+# to allow them to communicate with this Arkindex instance
+ponos:
+  private_key: /etc/ponos.key
+  default_env:
+    ARKINDEX_API_URL: https://ark.localhost/api/v1/
+
+    # Do not change this setting if you use the bootstrap script
+    ARKINDEX_API_TOKEN: deadbeefTestToken
+
+# Root URL of the Arkindex instance
+# Used to build external links (in emails)
+public_hostname: https://ark.localhost
+
+# Configure the django settings for session & CSRF cookies
+# along with CORS allowed hosts
+# These should match your public hostname
+session:
+  cookie_domain: ark.localhost
+csrf:
+  cookie_domain: ark.localhost
+  trusted_origins:
+    - 'https://*.ark.localhost'
+cors:
+  origin_whitelist:
+    - https://ark.localhost
+
+# HTTP hosts allowed to reach the server
+# This should match your public hostname
+# Note the leading .
+allowed_hosts:
+  - .ark.localhost
+
+
+# IIIF Image Server used to expose the locally uploaded images
+# Do not change this setting if you use the bootstrap script
+local_imageserver_id: 12345
+
+# Worker version used by the file imports tasks
+# Do not change this setting if you use the bootstrap script
+imports_worker_version: f2bb8dd7-55e9-49ae-9bd9-b1d2e5d491b9
+```
+
+# Reference
 
 ## `allowed_hosts`