19146: Remove unneeded special case checks, explain the needed one.

[arvados.git] / services / api / config / application.yml.example

diff --git a/services/api/config/application.yml.example b/services/api/config/application.yml.example
index d6db3a4f8b7bcca3aea4c9d92974d9d131b307c5..6c6ff15cd9650f7c07bb9d373f068864363dd44a 100644 (file)
--- a/services/api/config/application.yml.example
+++ b/services/api/config/application.yml.example
@@ -1,3 +1,7 @@
+# Copyright (C) The Arvados Authors. All rights reserved.
+#
+# SPDX-License-Identifier: AGPL-3.0
+
 # Copy this file to application.yml and edit to suit.
 #
 # Consult application.default.yml for the full list of configuration
@@ -10,45 +14,39 @@
 # 4. Section in application.default.yml corresponding to RAILS_ENV
 # 5. Section in application.default.yml called "common"
 
-development:
-  # The blob_signing_key is a string of alphanumeric characters used
-  # to sign permission hints for Keep locators. It must be identical
-  # to the permission key given to Keep.  If you run both apiserver
-  # and Keep in development, change this to a hardcoded string and
-  # make sure both systems use the same value.
-  blob_signing_key: ~
-
 production:
-  # At minimum, you need a nice long randomly generated secret_token here.
-  # Use a long string of alphanumeric characters (at least 36).
+  # Mandatory site configuration.  See application.default.yml and
+  # http://http://doc.arvados.org/install/install-api-server.html#configure_application
+  # for more information.
+  uuid_prefix: ~
   secret_token: ~
-
-  # blob_signing_key is required and must be identical to the
-  # permission secret provisioned to Keep.
-  # Use a long string of alphanumeric characters (at least 36).
   blob_signing_key: ~
+  sso_app_secret: ~
+  sso_app_id: ~
+  sso_provider_url: ~
+  workbench_address: ~
+  websocket_address: ~
+  #git_repositories_dir: ~
+  #git_internal_dir: ~
 
-  uuid_prefix: bogus
-
-  # compute_node_domain: example.org
-  # compute_node_nameservers:
-  #   - 127.0.0.1
-  #   - 192.168.1.1
-  #
-  # The version below is suitable for AWS.
-  # Uncomment and change <%# to <%= to use it.
-  # compute_node_nameservers: <%#
-  #   require 'net/http'
-  #   ['local', 'public'].collect do |iface|
-  #     Net::HTTP.get(URI("http://169.254.169.254/latest/meta-data/#{iface}-ipv4")).match(/^[\d\.]+$/)[0]
-  #   end << '172.16.0.23'
-  # %>
+development:
+  # Separate settings for development configuration.
+  uuid_prefix: ~
+  secret_token: ~
+  blob_signing_key: ~
+  sso_app_id: ~
+  sso_app_secret: ~
+  sso_provider_url: ~
+  workbench_address: ~
+  websocket_address: ~
+  #git_repositories_dir: ~
+  #git_internal_dir: ~
 
 test:
-  uuid_prefix: zzzzz
-  secret_token: <%= rand(2**512).to_s(36) %>
+  # Tests should be able to run without further configuration, but if you do
+  # want to change your local test configuration, this is where to do it.
 
 common:
-  #git_repositories_dir: /var/cache/git
-  #git_internal_dir: /var/cache/arvados/internal.git
-
+  # Settings in this section will be used in all environments
+  # (development, production, test) except when overridden in the
+  # environment-specific sections above.