Merge branch '5626-git-server-hostname' into 4752-docker-websockets
[arvados.git] / services / api / config / application.default.yml
index 92b3ca1fa688a75043f36a67540fb748ef3cc5ad..1696e2c56ebf9226126945c86b254144c7acd7fa 100644 (file)
@@ -15,7 +15,7 @@ development:
   active_record.auto_explain_threshold_in_seconds: 0.5
   assets.compress: false
   assets.debug: true
-  local_modified: <%= '-modified' if `git status -s` %>
+  local_modified: "<%= '-modified' if `git status -s` != '' %>"
 
 production:
   force_ssl: true
@@ -47,8 +47,21 @@ test:
   workbench_address: https://localhost:3001/
 
 common:
+  # The prefix used for all database identifiers to identify the record as
+  # originating from this site.  Must be exactly 5 alphanumeric characters
+  # (lowercase ASCII letters and digits).
   uuid_prefix: <%= Digest::MD5.hexdigest(`hostname`).to_i(16).to_s(36)[0..4] %>
 
+  # If not false, this is the hostname that will be used for root_url and
+  # advertised in the discovery document.  By default, use the default Rails
+  # logic for deciding on a hostname.
+  host: false
+
+  # If not false, this is the hostname that will be used to generate fetch_url
+  # and push_url for git repositories.  By default, this will be
+  # git.(uuid_prefix).arvadosapi.com
+  git_host: false
+
   # If this is not false, HTML requests at the API server's root URL
   # are redirected to this location, and it is provided in the text of
   # user activation notification email messages to remind them where
@@ -61,6 +74,11 @@ common:
   # {git_repositories_dir}/arvados/.git
   git_repositories_dir: /var/lib/arvados/git
 
+  # If an arv-git-httpd service is running, advertise it in the
+  # discovery document by adding its public URI base here. Example:
+  # https://git.xxxxx.arvadosapi.com
+  git_http_base: false
+
   # This is a (bare) repository that stores commits used in jobs.  When a job
   # runs, the source commits are first fetched into this repository, then this
   # repository is used to deploy to compute nodes.  This should NOT be a
@@ -99,8 +117,21 @@ common:
   # silenced by throttling are not counted against this total.
   crunch_limit_log_bytes_per_job: 67108864
 
-  # Path to /etc/dnsmasq.d, or false = do not update dnsmasq data.
-  dnsmasq_conf_dir: false
+  # Path to dns server configuration directory (e.g. /etc/unbound.d/conf.d),
+  # or false = do not update dns server data.
+  dns_server_conf_dir: false
+
+  # Template for the dns server host snippets. See unbound.template in this directory for
+  # an example. Set to false to disable.
+  dns_server_conf_template: false
+
+  # Dns server reload command, or false = do not reload dns server after data change
+  dns_server_reload_command: false
+
+  # Example for unbound
+  #dns_server_conf_dir: /etc/unbound/conf.d
+  #dns_server_conf_template: /path/to/your/api/server/config/unbound.template
+  #dns_server_reload_command: /etc/init.d/unbound reload
 
   compute_node_domain: false
   compute_node_nameservers:
@@ -153,15 +184,29 @@ common:
 
   arvados_theme: default
 
-  # Default: do not advertise a websocket server.
-  websocket_address: false
-
-  # You can run the websocket server separately from the regular HTTP service
-  # by setting "ARVADOS_WEBSOCKETS=ws-only" in the environment before running
-  # the websocket server.  When you do this, you need to set the following
-  # configuration variable so that the primary server can give out the correct
-  # address of the dedicated websocket server:
+  # The ARVADOS_WEBSOCKETS environment variable determines whether to
+  # serve http, websockets, or both.
+  #
+  # If ARVADOS_WEBSOCKETS="true", http and websockets are both served
+  # from the same process.
+  #
+  # If ARVADOS_WEBSOCKETS="ws-only", only websockets is served.
+  #
+  # If ARVADOS_WEBSOCKETS="false" or not set at all, only http is
+  # served. In this case, you should have a separate process serving
+  # websockets, and the address of that service should be given here
+  # as websocket_address.
+  #
+  # If websocket_address is false (which is the default), the
+  # discovery document will tell clients to use the current server as
+  # the websocket service, or (if the current server does not have
+  # websockets enabled) not to use websockets at all.
+  #
+  # Example: Clients will connect to the specified endpoint.
   #websocket_address: wss://127.0.0.1:3333/websocket
+  # Default: Clients will connect to this server if it's running
+  # websockets, otherwise none at all.
+  websocket_address: false
 
   # blob_signing_key is a string of alphanumeric characters used to
   # generate permission signatures for Keep locators. It must be
@@ -203,8 +248,23 @@ common:
   auto_setup_name_blacklist: [arvados, git, gitolite, gitolite-admin, root, syslog]
 
   # source_version
-  source_version: "<%= `git log -n 1 --format=%h` %>"
+  source_version: "<%= `git log -n 1 --format=%h`.strip %>"
   local_modified: false
 
   # Default lifetime for ephemeral collections: 2 weeks.
   default_trash_lifetime: 1209600
+
+  # Permit insecure (OpenSSL::SSL::VERIFY_NONE) connections to the Single Sign
+  # On (sso) server.  Should only be enabled during development when the SSO
+  # server is using a self-signed cert.
+  sso_insecure: false
+
+  # Default replication level for collections. This is used when a
+  # collection's replication_desired attribute is nil.
+  default_collection_replication: 2
+
+  # Maximum size (in bytes) allowed for a single API request that will be
+  # published in the discovery document for use by clients.
+  # Note you must separately configure the upstream web server or proxy to
+  # actually enforce the desired maximum request size on the server side.
+  max_request_size: 134217728