X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/35336cd73e444534cb2eda20e3730464cc4e6553..5ee93e408c0e547dfb03b2f3d039a7715126395b:/services/api/config/application.yml.example

diff --git a/services/api/config/application.yml.example b/services/api/config/application.yml.example
index a9c33a4bae..6c6ff15cd9 100644
--- 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,32 +14,39 @@
 # 4. Section in application.default.yml corresponding to RAILS_ENV
 # 5. Section in application.default.yml called "common"
 
-development:
-
 production:
-  # At minimum, you need a nice long randomly generated secret_token here.
+  # 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: ~
+  sso_app_secret: ~
+  sso_app_id: ~
+  sso_provider_url: ~
+  workbench_address: ~
+  websocket_address: ~
+  #git_repositories_dir: ~
+  #git_internal_dir: ~
 
-  uuid_prefix: bogus
-
-  # This is suitable for AWS; see common section below for a static example.
-  #
-  #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 must be readable by api server, or you won't be
-  # able to submit crunch jobs. To pass the test suites, put a clone
-  # of the arvados tree in {git_repositories_dir}/arvados.git or
-  # {git_repositories_dir}/arvados/.git
-  #
-  #git_repositories_dir: /var/cache/git
+  # Settings in this section will be used in all environments
+  # (development, production, test) except when overridden in the
+  # environment-specific sections above.