1 # Do not use this file for site configuration. Create application.yml
2 # instead (see application.yml.example).
4 # The order of precedence is:
5 # 1. config/environments/{RAILS_ENV}.rb (deprecated)
6 # 2. Section in application.yml corresponding to RAILS_ENV (e.g., development)
7 # 3. Section in application.yml called "common"
8 # 4. Section in application.default.yml corresponding to RAILS_ENV
9 # 5. Section in application.default.yml called "common"
12 # If you change any of the code in this block, you'll probably also want
13 # to update it in Workbench's application.default.yml.
14 def info_cmd(*args, &block)
15 IO.popen(args, "r", chdir: Rails.root, err: "/dev/null", &block)
19 local_modified = false
20 if Rails.env == "production"
21 # Read the version from our package's git-commit.version file, if available.
23 source_version = IO.read(Rails.root.join("git-commit.version")).strip
28 if source_version.empty?
31 info_cmd("git", "status", "-s") do |git_pipe|
32 git_pipe.each_line do |_|
34 # Continue reading the pipe so git doesn't get SIGPIPE.
38 info_cmd("git", "log", "-n1", "--format=%H") do |git_pipe|
39 git_pipe.each_line do |line|
40 source_version = line.chomp
43 local_modified = status_output
45 rescue SystemCallError
52 ### Essential site configuration
55 # The prefix used for all database identifiers to identify the record as
56 # originating from this site. Must be exactly 5 alphanumeric characters
57 # (lowercase ASCII letters and digits).
60 # secret_token is a string of alphanumeric characters used by Rails
61 # to sign session tokens. IMPORTANT: This is a site secret. It
62 # should be at least 50 characters.
65 # blob_signing_key is a string of alphanumeric characters used to
66 # generate permission signatures for Keep locators. It must be
67 # identical to the permission key given to Keep. IMPORTANT: This is
68 # a site secret. It should be at least 50 characters.
71 # These settings are provided by your OAuth2 provider (e.g.,
77 # If this is not false, HTML requests at the API server's root URL
78 # are redirected to this location, and it is provided in the text of
79 # user activation notification email messages to remind them where
81 workbench_address: false
83 # The ARVADOS_WEBSOCKETS environment variable determines whether to
84 # serve http, websockets, or both.
86 # If ARVADOS_WEBSOCKETS="true", http and websockets are both served
87 # from the same process.
89 # If ARVADOS_WEBSOCKETS="ws-only", only websockets is served.
91 # If ARVADOS_WEBSOCKETS="false" or not set at all, only http is
92 # served. In this case, you should have a separate process serving
93 # websockets, and the address of that service should be given here
94 # as websocket_address.
96 # If websocket_address is false (which is the default), the
97 # discovery document will tell clients to use the current server as
98 # the websocket service, or (if the current server does not have
99 # websockets enabled) not to use websockets at all.
101 # Example: Clients will connect to the specified endpoint.
102 #websocket_address: wss://127.0.0.1:3333/websocket
103 # Default: Clients will connect to this server if it's running
104 # websockets, otherwise none at all.
105 websocket_address: false
107 # Git repositories must be readable by api server, or you won't be
108 # able to submit crunch jobs. To pass the test suites, put a clone
109 # of the arvados tree in {git_repositories_dir}/arvados.git or
110 # {git_repositories_dir}/arvados/.git
111 git_repositories_dir: /var/lib/arvados/git/repositories
113 # This is a (bare) repository that stores commits used in jobs. When a job
114 # runs, the source commits are first fetched into this repository, then this
115 # repository is used to deploy to compute nodes. This should NOT be a
116 # subdirectory of {git_repositiories_dir}.
117 git_internal_dir: /var/lib/arvados/internal.git
119 # Default replication level for collections. This is used when a
120 # collection's replication_desired attribute is nil.
121 default_collection_replication: 2
125 ### Overriding default advertised hostnames/URLs
128 # If not false, this is the hostname that will be used for root_url and
129 # advertised in the discovery document. By default, use the default Rails
130 # logic for deciding on a hostname.
133 # Base part of SSH git clone url given with repository resources. If
134 # true, the default "git@git.(uuid_prefix).arvadosapi.com:" is
135 # used. If false, SSH clone URLs are not advertised. Include a
136 # trailing ":" or "/" if needed: it will not be added automatically.
137 git_repo_ssh_base: true
139 # Base part of HTTPS git clone urls given with repository
140 # resources. This is expected to be an arv-git-httpd service which
141 # accepts API tokens as HTTP-auth passwords. If true, the default
142 # "https://git.(uuid_prefix).arvadosapi.com/" is used. If false,
143 # HTTPS clone URLs are not advertised. Include a trailing ":" or "/"
144 # if needed: it will not be added automatically.
145 git_repo_https_base: true
149 ### New user and & email settings
152 # Config parameters to automatically setup new users.
153 # The params auto_setup_new_users_with_* are meaningful only when auto_setup_new_users is turned on.
154 # auto_setup_name_blacklist is a list of usernames to be blacklisted for auto setup.
155 auto_setup_new_users: false
156 auto_setup_new_users_with_vm_uuid: false
157 auto_setup_new_users_with_repository: false
158 auto_setup_name_blacklist: [arvados, git, gitolite, gitolite-admin, root, syslog]
160 # When new_users_are_active is set to true, the user agreement check is skipped.
161 new_users_are_active: false
163 # The e-mail address of the user you would like to become marked as an admin
164 # user on their first login.
165 # In the default configuration, authentication happens through the Arvados SSO
166 # server, which uses OAuth2 against Google's servers, so in that case this
167 # should be an address associated with a Google account.
168 auto_admin_user: false
170 # If auto_admin_first_user is set to true, the first user to log in when no
171 # other admin users exist will automatically become an admin user.
172 auto_admin_first_user: false
174 # Email address to notify whenever a user creates a profile for the
176 user_profile_notification_address: false
178 admin_notifier_email_from: arvados@example.com
179 email_subject_prefix: "[ARVADOS] "
180 user_notifier_email_from: arvados@example.com
181 new_user_notification_recipients: [ ]
182 new_inactive_user_notification_recipients: [ ]
186 ### Limits, timeouts and durations
189 # Lifetime (in seconds) of blob permission signatures generated by
190 # the API server. This determines how long a client can take (after
191 # retrieving a collection record) to retrieve the collection data
192 # from Keep. If the client needs more time than that (assuming the
193 # collection still has the same content and the relevant user/token
194 # still has permission) the client can retrieve the collection again
195 # to get fresh signatures.
197 # Datamanager considers an unreferenced block older than this to be
198 # eligible for garbage collection. Therefore, it should never be
199 # smaller than the corresponding value used by any local keepstore
200 # service (see keepstore -blob-signature-ttl flag). This rule
201 # prevents datamanager from trying to garbage-collect recently
202 # written blocks while clients are still holding valid signatures.
204 # The default is 2 weeks.
205 blob_signature_ttl: 1209600
207 # Default lifetime for ephemeral collections: 2 weeks.
208 default_trash_lifetime: 1209600
210 # Maximum size (in bytes) allowed for a single API request. This
211 # limit is published in the discovery document for use by clients.
212 # Note: You must separately configure the upstream web server or
213 # proxy to actually enforce the desired maximum request size on the
215 max_request_size: 134217728
217 # Limit the number of bytes read from the database during an index
218 # request (by retrieving and returning fewer rows than would
219 # normally be returned in a single response).
220 # Note 1: This setting never reduces the number of returned rows to
221 # zero, no matter how big the first data row is.
222 # Note 2: Currently, this only limits the
223 # arvados.v1.collections.list API (GET /arvados/v1/collections), and
224 # only takes the size of manifest_text into account. Other fields
225 # (e.g., "properties" hashes) are not counted against this limit
226 # when returning collections, and the limit is not applied at all
227 # for other data types.
228 max_index_database_read: 134217728
230 # When you run the db:delete_old_job_logs task, it will find jobs that
231 # have been finished for at least this many seconds, and delete their
232 # stderr logs from the logs table.
233 clean_job_log_rows_after: <%= 30.days %>
235 # The maximum number of compute nodes that can be in use simultaneously
236 # If this limit is reduced, any existing nodes with slot number >= new limit
237 # will not be counted against the new limit. In other words, the new limit
238 # won't be strictly enforced until those nodes with higher slot numbers
240 max_compute_nodes: 64
242 # These two settings control how frequently log events are flushed to the
243 # database. Log lines are buffered until either crunch_log_bytes_per_event
244 # has been reached or crunch_log_seconds_between_events has elapsed since
246 crunch_log_bytes_per_event: 4096
247 crunch_log_seconds_between_events: 1
249 # The sample period for throttling logs, in seconds.
250 crunch_log_throttle_period: 60
252 # Maximum number of bytes that job can log over crunch_log_throttle_period
253 # before being silenced until the end of the period.
254 crunch_log_throttle_bytes: 65536
256 # Maximum number of lines that job can log over crunch_log_throttle_period
257 # before being silenced until the end of the period.
258 crunch_log_throttle_lines: 1024
260 # Maximum bytes that may be logged by a single job. Log bytes that are
261 # silenced by throttling are not counted against this total.
262 crunch_limit_log_bytes_per_job: 67108864
266 ### Crunch, DNS & compute node management
269 # Docker image to be used when none found in runtime_constraints of a job
270 default_docker_image_for_jobs: false
272 # :none or :slurm_immediate
273 crunch_job_wrapper: :none
275 # username, or false = do not set uid when running jobs.
276 crunch_job_user: crunch
278 # The web service must be able to create/write this file, and
279 # crunch-job must be able to stat() it.
280 crunch_refresh_trigger: /tmp/crunch_refresh_trigger
282 # Path to dns server configuration directory
283 # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
284 # files or touch restart.txt (see below).
285 dns_server_conf_dir: false
287 # Template file for the dns server host snippets. See
288 # unbound.template in this directory for an example. If false, do
289 # not write any config files.
290 dns_server_conf_template: false
292 # String to write to {dns_server_conf_dir}/restart.txt (with a
293 # trailing newline) after updating local data. If false, do not
294 # open or write the restart.txt file.
295 dns_server_reload_command: false
297 # Command to run after each DNS update. Template variables will be
298 # substituted; see the "unbound" example below. If false, do not run
300 dns_server_update_command: false
302 ## Example for unbound:
303 #dns_server_conf_dir: /etc/unbound/conf.d
304 #dns_server_conf_template: /path/to/your/api/server/config/unbound.template
305 ## ...plus one of the following two methods of reloading:
306 #dns_server_reload_command: unbound-control reload
307 #dns_server_update_command: echo %{hostname} %{hostname}.%{uuid_prefix} %{hostname}.%{uuid_prefix}.arvadosapi.com %{ptr_domain} | xargs -n 1 unbound-control local_data_remove && unbound-control local_data %{hostname} IN A %{ip_address} && unbound-control local_data %{hostname}.%{uuid_prefix} IN A %{ip_address} && unbound-control local_data %{hostname}.%{uuid_prefix}.arvadosapi.com IN A %{ip_address} && unbound-control local_data %{ptr_domain}. IN PTR %{hostname}.%{uuid_prefix}.arvadosapi.com
309 compute_node_domain: false
310 compute_node_nameservers:
313 # Hostname to assign to a compute node when it sends a "ping" and the
314 # hostname in its Node record is nil.
315 # During bootstrapping, the "ping" script is expected to notice the
316 # hostname given in the ping response, and update its unix hostname
318 # If false, leave the hostname alone (this is appropriate if your compute
319 # nodes' hostnames are already assigned by some other mechanism).
321 # One way or another, the hostnames of your node records should agree
322 # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
324 # Example for compute0000, compute0001, ....:
325 # assign_node_hostname: compute%<slot_number>04d
326 # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
327 assign_node_hostname: compute%<slot_number>d
331 ### Remaining assorted configuration options.
334 arvados_theme: default
336 # Permit insecure (OpenSSL::SSL::VERIFY_NONE) connections to the Single Sign
337 # On (sso) server. Should only be enabled during development when the SSO
338 # server is using a self-signed cert.
341 ## Set Time.zone default to the specified zone and make Active
342 ## Record auto-convert to this zone. Run "rake -D time" for a list
343 ## of tasks for finding time zone names. Default is UTC.
344 #time_zone: Central Time (US & Canada)
346 ## Default encoding used in templates for Ruby 1.9.
349 # Enable the asset pipeline
352 # Version of your assets, change this if you want to expire all your assets
353 assets.version: "1.0"
355 # Allow clients to create collections by providing a manifest with
356 # unsigned data blob locators. IMPORTANT: This effectively disables
357 # access controls for data stored in Keep: a client who knows a hash
358 # can write a manifest that references the hash, pass it to
359 # collections.create (which will create a permission link), use
360 # collections.get to obtain a signature for that data locator, and
361 # use that signed locator to retrieve the data from Keep. Therefore,
362 # do not turn this on if your users expect to keep data private from
364 permit_create_collection_with_unsigned_manifest: false
366 default_openid_prefix: https://www.google.com/accounts/o8/id
369 source_version: "<%= source_version[0...8] %>"
370 local_modified: false
377 consider_all_requests_local: true
378 action_controller.perform_caching: false
379 action_mailer.raise_delivery_errors: false
380 action_mailer.perform_deliveries: false
381 active_support.deprecation: :log
382 action_dispatch.best_standards_support: :builtin
383 active_record.mass_assignment_sanitizer: :strict
384 active_record.auto_explain_threshold_in_seconds: 0.5
385 assets.compress: false
387 local_modified: "<%= local_modified ? '-modified' : '' %>"
392 consider_all_requests_local: false
393 action_controller.perform_caching: true
394 serve_static_assets: false
395 assets.compress: true
396 assets.compile: false
402 serve_static_assets: true
403 static_cache_control: public, max-age=3600
405 consider_all_requests_local: true
406 action_controller.perform_caching: false
407 action_dispatch.show_exceptions: false
408 action_controller.allow_forgery_protection: false
409 action_mailer.delivery_method: :test
410 active_support.deprecation: :stderr
411 active_record.mass_assignment_sanitizer: :strict
413 sso_app_id: arvados-server
414 sso_app_secret: <%= rand(2**512).to_s(36) %>
415 sso_provider_url: http://localhost:3002
416 secret_token: <%= rand(2**512).to_s(36) %>
417 blob_signing_key: zfhgfenhffzltr9dixws36j1yhksjoll2grmku38mi7yxd66h5j4q9w4jzanezacp8s6q0ro3hxakfye02152hncy6zml2ed0uc
418 user_profile_notification_address: arvados@example.com
419 workbench_address: https://localhost:3001/
420 git_repositories_dir: <%= Rails.root.join 'tmp', 'git', 'test' %>
421 git_internal_dir: <%= Rails.root.join 'tmp', 'internal.git' %>