docs: add github setup

config.yaml.example

@@ -1,4 +1,8 @@
 ---
+############################################################################
+# 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
@@ -7,27 +11,50 @@ 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
+
 # This directory must exist and be writable by the user running the portal.
 TERRAFORM_DIRECTORY: /home/bc/terraform
 
-# AWS (CloudFront)
-AWS_ACCESS_KEY: accesskeygoeshere
-AWS_SECRET_KEY: accesssecretgoeshere
+############################################################################
+# Provider configuration follows. You must activate at least one provider. #
+############################################################################
 
-# Azure
-AZURE_RESOURCE_GROUP_NAME: namegoeshere
-AZURE_STORAGE_ACCOUNT_NAME: namegoeshere
-AZURE_LOCATION: westcentralus
-AZURE_SUBSCRIPTION_ID: subscriptionuuid
-AZURE_TENANT_ID: tenantuuid
-AZURE_CLIENT_ID: clientuuid
-AZURE_CLIENT_SECRET: clientsecretgoeshere
+## Amazon Web Services
+#AWS_ACTIVATED: true
+#AWS_ACCESS_KEY:
+#AWS_SECRET_KEY:
 
-# GitHub
-GITHUB_ORGANIZATION: exampleorg
-GITHUB_REPOSITORY: example-repo
-GITHUB_API_KEY: keygoeshere
-GITHUB_FILE_V2: mirrorSites.json
+## 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:
 
-# Hetzner Cloud
-HCLOUD_TOKEN: tokengoeshere
+## Fastly
+#FASTLY_ACTIVATED: true
+#FASTLY_API_KEY:
+
+## GitHub
+#GITHUB_ACTIVATED: true
+#GITHUB_API_KEY:
+
+## Hetzner Cloud
+#HCLOUD_ACTIVATED: true
+#HCLOUD_TOKEN:
+
+## OVH Cloud
+#OVH_ACTIVATED: true
+#OVH_CLOUD_APPLICATION_KEY:
+#OVH_CLOUD_APPLICATION_SECRET:
+#OVH_CLOUD_CONSUMER_KEY:
+#OVH_CLOUD_PROJECT_SERVICE:
+#OVH_OPENSTACK_USER:
+#OVH_OPENSTACK_PASSWORD:
+#OVH_OPENSTACK_TENANT_ID: