Skip to content

Install configuration ​

This file contains all the necessary variables to configure a Centauron node. The configuration is broken down into sections for each major service. Here you can find an overview of the used components.

Global Settings ​

These variables define the base paths for all persistent data on the node.

base_data_path

Description: The absolute base directory on the host machine where all persistent data for all services will be stored.

Important: This path must end with a trailing slash (/).

Example: /opt/centauron/data/

Traefik ​

This section configures Traefik, which acts as the reverse proxy, manages network traffic, and handles SSL certificates.

traefik.acme

Description: The path (relative to the Traefik project directory) where Let's Encrypt SSL certificate information will be stored.

Example: ./acme

traefik.le_email

Description: The email address to be used for Let's Encrypt registration and certificate expiration notices.

Example: your-email@example.com

traefik.routers

Description: A dictionary defining the public-facing subdomains for each service. Traefik will route traffic based on these hostnames.

Note: For the iipsrv router, the path (e.g., /iipsrv.fcgi) is appended automatically in the Traefik configuration templates.

Example:

yaml
routers:
  dashboard: traefik.your-domain.com
  iipsrv: your-domain.com

traefik.admin.ip_source_range

Description: A list of trusted IP addresses or CIDR ranges that are allowed to access the Traefik admin dashboard.

Example: ["192.168.1.0/24", "10.0.0.5/32"]

IPFS ​

Configures the node's IPFS daemon for decentralized file storage.

ipfs.swarm_key

Description: The absolute path to the swarm.key file. This key is required to connect to a private IPFS network.

Example: ./ipfs/swarm.key

ipfs.data

Description: The relative path for storing the IPFS node's configuration and data blocks.

Example: ./data/

ipfs.export

Description: The relative path for exporting files from the IPFS node.

Example: ./export/

ipfs.bootstrap_nodes

Description: A list of multi-address strings for the bootstrap nodes of the private IPFS network. Your node will connect to these peers to join the network.

ipfs.test_files

Description: A list of IPFS CIDs (Content Identifiers) used for testing purposes.

Keycloak ​

Configures the credentials for the Keycloak admin user.

keycloak.admin.username

Description: The username for the Keycloak master realm admin account.

Default: admin

keycloak.admin.password

Description: The password for the Keycloak master realm admin account.

Default: admin

Centauron (Core Application) ​

Configures the main Centauron application, including paths, secrets, and Kubernetes settings.

centauron.admin_email

Description: The email address for the Centauron administrator.

centauron.common_name

Description: The common name for the node, typically used in certificate generation.

centauron.identifier

Description: A unique identifier for this Centauron node.

centauron.k8s_config

Description: The absolute path to the Kubernetes configuration file (kubeconfig) that will be used to interact with the cluster.

Example: /home/user/kubeconfig

centauron.docker_config

Description: The absolute path to the Docker config.json file, which contains credentials for private Docker registries.

Example: /home/user/.docker/config.json

centauron.logs, centauron.certs, centauron.postgres.data_path, centauron.postgres.backup_path

Description: Relative paths for storing logs, certificates, and PostgreSQL data/backups.

centauron.django.secret

Description: The secret key for the Django application. This should be a long, random string. You can generate it e.g. via tr -dc 'a-z0-9!@#$%^&*(-_=+)' < /dev/urandom | head -c50

Example: your-super-long-random-secret-key

centauron.django.admin_url

Description: The URL path for the Django admin interface.

Default: admin

centauron.shared_data_folder_with_k8s_cluster, centauron.shared_artifacts_folder_with_k8s_cluster, centauron.k8s_tmp_folder

Description: Absolute paths on the host machine that are shared with the Kubernetes cluster via a persistent volume. These are used for transferring data, artifacts, and temporary files between the main node and Kubernetes workers.

centauron.private_key, centauron.certificate

Description: Absolute paths on the host machine to the node's private key and certificate files.

Aria2 ​

Configures the Aria2 download utility.

aria2.port

Description: The port for the Aria2 RPC interface.

Default: 6800

aria2.secret

Description: The RPC secret token for authenticating with Aria2.

aria2.config_path

Description: The relative path to the Aria2 configuration directory.