From 359539ffd7595f77ecb68adab8e813b5fc24c4a9 Mon Sep 17 00:00:00 2001
From: Sebastian Serth <Sebastian.Serth@hpi.de>
Date: Wed, 15 Feb 2023 19:18:05 +0100
Subject: [PATCH] Update configuration examples for seamless start

---
 config/code_ocean.yml.example              | 8 ++++----
 config/content_security_policy.yml.example | 2 ++
 config/database.yml.example                | 6 +++---
 config/docker.yml.erb.ci                   | 3 ++-
 config/docker.yml.erb.example              | 3 ++-
 5 files changed, 13 insertions(+), 9 deletions(-)

diff --git a/config/code_ocean.yml.example b/config/code_ocean.yml.example
index 03547875..e170c07f 100644
--- a/config/code_ocean.yml.example
+++ b/config/code_ocean.yml.example
@@ -41,18 +41,18 @@ default: &default
     # When enabled, CodeOcean delegates the handling and management of (containerized) runners
     # to a dedicated runner management. Otherwise, code executions are performed locally using
     # Docker and without pre-warming support (one container per execution).
-    enabled: false
+    enabled: true
     # The strategy to use. Possible values are: poseidon, docker_container_pool
     strategy: poseidon
     # The root URL of the runner management to use (include any API prefix if required)
     # If a hostname is specified and the target host is reachable via IPv6, the WebSocket
     # connection might not use the IPv6-to-IPv4 fallback but rather fail unexpectedly.
-    url: https://runners.example.org/api/v1
+    url: http://127.0.0.1:7200/api/v1
     # The root certificate authority to trust for TLS connections to the runner management (Poseidon only)
-    ca_file: /example/certificates/ca.crt
+    # ca_file: /example/certificates/ca.crt
     # The authorization token for connections to the runner management (Poseidon only)
     # If TLS support is not enabled, this token is transmitted in clear text!
-    token: SECRET
+    # token: SECRET
     # The maximum time in seconds a runner may idle at the runner management before it is removed.
     # Each begin of an interaction with the runner resets this time. Thus, this value should
     # be truly greater than any permitted execution time of an execution environment.
diff --git a/config/content_security_policy.yml.example b/config/content_security_policy.yml.example
index 000cca6f..afa07b37 100644
--- a/config/content_security_policy.yml.example
+++ b/config/content_security_policy.yml.example
@@ -13,6 +13,8 @@ default: &default
   # See https://bugs.webkit.org/show_bug.cgi?id=235873
   connect_src:
     - wss://codeocean.openhpi.de
+    # Enable the StackExchange API for Flowr
+    # - https://api.stackexchange.com
   # Optionally: Specify a custom, non-Sentry URL for reporting CSP violations
   # report_uri: https://example.com/csp-report
 
diff --git a/config/database.yml.example b/config/database.yml.example
index e59bdd23..0efe267f 100644
--- a/config/database.yml.example
+++ b/config/database.yml.example
@@ -1,10 +1,10 @@
 default: &default
   adapter: postgresql
   encoding: unicode
-  password: CHANGE_ME
   pool: 16
-  username: postgres
-  host: localhost
+  # username: CHANGE_ME
+  # password: CHANGE_ME
+  # host: localhost
 
 development:
   <<: *default
diff --git a/config/docker.yml.erb.ci b/config/docker.yml.erb.ci
index 4ea13165..7b38c4ee 100644
--- a/config/docker.yml.erb.ci
+++ b/config/docker.yml.erb.ci
@@ -1,4 +1,5 @@
-#Why erb?
+# This file is only used for the deprecated DockerContainerPool (and not for Poseidon).
+
 default: &default
   connection_timeout: 3
   pool:
diff --git a/config/docker.yml.erb.example b/config/docker.yml.erb.example
index 8fad3a8f..6856a65e 100644
--- a/config/docker.yml.erb.example
+++ b/config/docker.yml.erb.example
@@ -1,4 +1,5 @@
-#Why erb?
+# This file is only used for the deprecated DockerContainerPool (and not for Poseidon).
+
 default: &default
   # Specify the Docker host below, once for container management and once for output streaming.
   # Always use the TCP socket (instead of a unix socket) and an IPv4 address for best compatibility.