Configuration File

A file named config.yaml must exist. For specifics about the provider configurations, see External Services.

Base Configuration

Template

---
############################################################################
# Base configuration. All options in this section mandatory.               #
############################################################################

# Supports any backend supported by SQLAlchemy, but you may need additional
# packages installed if you're not using SQLite.
SQLALCHEMY_DATABASE_URI: sqlite:///example.db
SQLALCHEMY_TRACK_MODIFICATIONS: true

# You can just put whatever here, but you should change it!
SECRET_KEY: iechaj0mun6beih3rooga0mei7eo0iwoal1eeweN

# This SSH key must not have a passphrase.
SSH_PRIVATE_KEY_PATH: /home/bc/.ssh/id_rsa
SSH_PUBLIC_KEY_PATH: /home/bc/.ssh/id_rsa.pub

TERRAFORM_DIRECTORY: /home/bc/portal-terraform
TFSTATE_BACKEND: http://127.0.0.1:5000/tfstate


GLOBAL_NAMESPACE: egbc # will be used as a prefix in the name of all cloud resources

BYPASS_TOKEN: dummy

ADMIN_EMAIL: bc@example.com

SMART_ZONE: example.com

HIDDEN_AUTOMATIONS: {}

############################################################################
# Provider configuration follows. You must activate at least one provider. #
############################################################################

## Amazon Web Services
#AWS_ACTIVATED: true
#AWS_ACCESS_KEY:
#AWS_SECRET_KEY:

## Azure
#AZURE_ACTIVATED: true
#AZURE_RESOURCE_GROUP_NAME:
#AZURE_STORAGE_ACCOUNT_NAME:
#AZURE_LOCATION:
#AZURE_SUBSCRIPTION_ID:
#AZURE_TENANT_ID:
#AZURE_CLIENT_ID:
#AZURE_CLIENT_SECRET:

## Fastly
#FASTLY_ACTIVATED: true
#FASTLY_API_KEY:

## GitHub
#GITHUB_ACTIVATED: true
#GITHUB_API_KEY:

## GitLab
#GITLAB_ACTIVATED: true
#GITLAB_AUTHOR_EMAIL:
#GITLAB_AUTHOR_NAME:
#GITLAB_COMMIT_MESSAGE:
#GITLAB_TOKEN:

## Hetzner Cloud
#HCLOUD_ACTIVATED: true
#HCLOUD_TOKEN:

## OVH Cloud
#OVH_ACTIVATED: true
#OVH_OPENSTACK_USER:
#OVH_OPENSTACK_PASSWORD:
#OVH_OPENSTACK_TENANT_ID:
#OVH_CLOUD_APPLICATION_KEY:
#OVH_CLOUD_APPLICATION_SECRET:
#OVH_CLOUD_CONSUMER_KEY:
#OVH_CLOUD_PROJECT_SERVICE: