-
Notifications
You must be signed in to change notification settings - Fork 1k
/
galaxy.yml.sample
2726 lines (2258 loc) · 121 KB
/
galaxy.yml.sample
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Galaxy is configured by default to be usable in a single-user development
# environment. To tune the application for a multi-user production
# environment, see the documentation at:
#
# https://docs.galaxyproject.org/en/master/admin/production.html
#
# Throughout this sample configuration file, except where stated otherwise,
# uncommented values override the default if left unset, whereas commented
# values are set to the default value. Relative paths are relative to the root
# Galaxy directory.
#
# Examples of many of these options are explained in more detail in the Galaxy
# Community Hub.
#
# https://galaxyproject.org/admin/config
#
# Config hackers are encouraged to check there before asking for help.
#
# Configuration for Gravity process manager.
# ``uwsgi:`` section will be ignored if Galaxy is started via Gravity commands (e.g ``./run.sh``, ``galaxy`` or ``galaxyctl``).
gravity:
# Process manager to use.
# ``supervisor`` is the default process manager when Gravity is invoked as a non-root user.
# ``systemd`` is the default when Gravity is invoked as root.
# Valid options are: supervisor, systemd
# process_manager:
# What command to write to the process manager configs
# `gravity` (`galaxyctl exec <service-name>`) is the default
# `direct` (each service's actual command) is also supported.
# Valid options are: gravity, direct
# service_command_style: gravity
# Use the process manager's *service instance* functionality for services that can run multiple instances.
# Presently this includes services like gunicorn and Galaxy dynamic job handlers. Service instances are only supported if
# ``service_command_style`` is ``gravity``, and so this option is automatically set to ``false`` if
# ``service_command_style`` is set to ``direct``.
# use_service_instances: true
# umask under which services should be executed. Setting ``umask`` on an individual service overrides this value.
# umask: '022'
# Memory limit (in GB), processes exceeding the limit will be killed. Default is no limit. If set, this is default value
# for all services. Setting ``memory_limit`` on an individual service overrides this value. Ignored if ``process_manager``
# is ``supervisor``.
# memory_limit:
# Specify Galaxy config file (galaxy.yml), if the Gravity config is separate from the Galaxy config. Assumed to be the
# same file as the Gravity config if a ``galaxy`` key exists at the root level, otherwise, this option is required.
# galaxy_config_file:
# Specify Galaxy's root directory.
# Gravity will attempt to find the root directory, but you can set the directory explicitly with this option.
# galaxy_root:
# User to run Galaxy as, required when using the systemd process manager as root.
# Ignored if ``process_manager`` is ``supervisor`` or user-mode (non-root) ``systemd``.
# galaxy_user:
# Group to run Galaxy as, optional when using the systemd process manager as root.
# Ignored if ``process_manager`` is ``supervisor`` or user-mode (non-root) ``systemd``.
# galaxy_group:
# Set to a directory that should contain log files for the processes controlled by Gravity.
# If not specified defaults to ``<galaxy_data_dir>/gravity/log``.
# log_dir:
# Set to Galaxy's virtualenv directory.
# If not specified, Gravity assumes all processes are on PATH. This option is required in most circumstances when using
# the ``systemd`` process manager.
# virtualenv:
# Select the application server.
# ``gunicorn`` is the default application server.
# ``unicornherder`` is a production-oriented manager for (G)unicorn servers that automates zero-downtime Galaxy server restarts,
# similar to uWSGI Zerg Mode used in the past.
# Valid options are: gunicorn, unicornherder
# app_server: gunicorn
# Override the default instance name.
# this is hidden from you when running a single instance.
# instance_name: _default_
# Configuration for Gunicorn. Can be a list to run multiple gunicorns for rolling restarts.
gunicorn:
# Enable Galaxy gunicorn server.
# enable: true
# The socket to bind. A string of the form: ``HOST``, ``HOST:PORT``, ``unix:PATH``, ``fd://FD``. An IP is a valid HOST.
# bind: localhost:8080
# Controls the number of Galaxy application processes Gunicorn will spawn.
# Increased web performance can be attained by increasing this value.
# If Gunicorn is the only application on the server, a good starting value is the number of CPUs * 2 + 1.
# 4-12 workers should be able to handle hundreds if not thousands of requests per second.
# workers: 1
# Gunicorn workers silent for more than this many seconds are killed and restarted.
# Value is a positive number or 0. Setting it to 0 has the effect of infinite timeouts by disabling timeouts for all workers entirely.
# If you disable the ``preload`` option workers need to have finished booting within the timeout.
# timeout: 300
# Extra arguments to pass to Gunicorn command line.
# extra_args:
# Use Gunicorn's --preload option to fork workers after loading the Galaxy Application.
# Consumes less memory when multiple processes are configured. Default is ``false`` if using unicornherder, else ``true``.
# preload:
# umask under which service should be executed
# umask:
# Value of supervisor startsecs, systemd TimeoutStartSec
# start_timeout: 15
# Value of supervisor stopwaitsecs, systemd TimeoutStopSec
# stop_timeout: 65
# Amount of time to wait for a server to become alive when performing rolling restarts.
# restart_timeout: 300
# Memory limit (in GB). If the service exceeds the limit, it will be killed. Default is no limit or the value of the
# ``memory_limit`` setting at the top level of the Gravity configuration, if set. Ignored if ``process_manager`` is
# ``supervisor``.
# memory_limit:
# Extra environment variables and their values to set when running the service. A dictionary where keys are the variable
# names.
# environment: {}
# Configuration for Celery Processes.
celery:
# Enable Celery distributed task queue.
# enable: true
# Enable Celery Beat periodic task runner.
# enable_beat: true
# Number of Celery Workers to start.
# concurrency: 2
# Log Level to use for Celery Worker.
# Valid options are: DEBUG, INFO, WARNING, ERROR
# loglevel: DEBUG
# Queues to join
# queues: celery,galaxy.internal,galaxy.external
# Pool implementation
# Valid options are: prefork, eventlet, gevent, solo, processes, threads
# pool: threads
# Extra arguments to pass to Celery command line.
# extra_args:
# umask under which service should be executed
# umask:
# Value of supervisor startsecs, systemd TimeoutStartSec
# start_timeout: 10
# Value of supervisor stopwaitsecs, systemd TimeoutStopSec
# stop_timeout: 10
# Memory limit (in GB). If the service exceeds the limit, it will be killed. Default is no limit or the value of the
# ``memory_limit`` setting at the top level of the Gravity configuration, if set. Ignored if ``process_manager`` is
# ``supervisor``.
# memory_limit:
# Extra environment variables and their values to set when running the service. A dictionary where keys are the variable
# names.
# environment: {}
# Configuration for gx-it-proxy.
gx_it_proxy:
# Set to true to start gx-it-proxy
# enable: false
# gx-it-proxy version
# version: '>=0.0.5'
# Public-facing IP of the proxy
# ip: localhost
# Public-facing port of the proxy
# port: 4002
# Routes file to monitor.
# Should be set to the same path as ``interactivetools_map`` in the ``galaxy:`` section. This is ignored if
# ``interactivetools_map is set``.
# sessions: database/interactivetools_map.sqlite
# Include verbose messages in gx-it-proxy
# verbose: true
# Forward all requests to IP.
# This is an advanced option that is only needed when proxying to remote interactive tool container that cannot be reached through the local network.
# forward_ip:
# Forward all requests to port.
# This is an advanced option that is only needed when proxying to remote interactive tool container that cannot be reached through the local network.
# forward_port:
# Rewrite location blocks with proxy port.
# This is an advanced option that is only needed when proxying to remote interactive tool container that cannot be reached through the local network.
# reverse_proxy: false
# umask under which service should be executed
# umask:
# Value of supervisor startsecs, systemd TimeoutStartSec
# start_timeout: 10
# Value of supervisor stopwaitsecs, systemd TimeoutStopSec
# stop_timeout: 10
# Memory limit (in GB). If the service exceeds the limit, it will be killed. Default is no limit or the value of the
# ``memory_limit`` setting at the top level of the Gravity configuration, if set. Ignored if ``process_manager`` is
# ``supervisor``.
# memory_limit:
# Extra environment variables and their values to set when running the service. A dictionary where keys are the variable
# names.
# environment: {}
# Configuration for tusd server (https://github.com/tus/tusd).
# The ``tusd`` binary must be installed manually and made available on PATH (e.g in galaxy's .venv/bin directory).
tusd:
# Enable tusd server.
# If enabled, you also need to set up your proxy as outlined in https://docs.galaxyproject.org/en/latest/admin/nginx.html#receiving-files-via-the-tus-protocol.
# enable: false
# Path to tusd binary
# tusd_path: tusd
# Host to bind the tusd server to
# host: localhost
# Port to bind the tusd server to
# port: 1080
# Directory to store uploads in.
# Must match ``tus_upload_store`` setting in ``galaxy:`` section.
# upload_dir:
# Comma-separated string of enabled tusd hooks.
#
# Leave at the default value to require authorization at upload creation time.
# This means Galaxy's web process does not need to be running after creating the initial
# upload request.
#
# Set to empty string to disable all authorization. This means data can be uploaded (but not processed)
# without the Galaxy web process being available.
#
# You can find a list of available hooks at https://github.com/tus/tusd/blob/master/docs/hooks.md#list-of-available-hooks.
# hooks_enabled_events: pre-create
# Extra arguments to pass to tusd command line.
# extra_args:
# umask under which service should be executed
# umask:
# Value of supervisor startsecs, systemd TimeoutStartSec
# start_timeout: 10
# Value of supervisor stopwaitsecs, systemd TimeoutStopSec
# stop_timeout: 10
# Memory limit (in GB). If the service exceeds the limit, it will be killed. Default is no limit or the value of the
# ``memory_limit`` setting at the top level of the Gravity configuration, if set. Ignored if ``process_manager`` is
# ``supervisor``.
# memory_limit:
# Extra environment variables and their values to set when running the service. A dictionary where keys are the variable
# names.
# environment: {}
# Configuration for Galaxy Reports.
reports:
# Enable Galaxy Reports server.
# enable: false
# Path to reports.yml, relative to galaxy.yml if not absolute
# config_file: reports.yml
# The socket to bind. A string of the form: ``HOST``, ``HOST:PORT``, ``unix:PATH``, ``fd://FD``. An IP is a valid HOST.
# bind: localhost:9001
# Controls the number of Galaxy Reports application processes Gunicorn will spawn.
# It is not generally necessary to increase this for the low-traffic Reports server.
# workers: 1
# Gunicorn workers silent for more than this many seconds are killed and restarted.
# Value is a positive number or 0. Setting it to 0 has the effect of infinite timeouts by disabling timeouts for all workers entirely.
# timeout: 300
# URL prefix to serve from.
# The corresponding nginx configuration is (replace <url_prefix> and <bind> with the values from these options):
#
# location /<url_prefix>/ {
# proxy_pass http://<bind>/;
# }
#
# If <bind> is a unix socket, you will need a ``:`` after the socket path but before the trailing slash like so:
# proxy_pass http://unix:/run/reports.sock:/;
# url_prefix:
# Extra arguments to pass to Gunicorn command line.
# extra_args:
# umask under which service should be executed
# umask:
# Value of supervisor startsecs, systemd TimeoutStartSec
# start_timeout: 10
# Value of supervisor stopwaitsecs, systemd TimeoutStopSec
# stop_timeout: 10
# Memory limit (in GB). If the service exceeds the limit, it will be killed. Default is no limit or the value of the
# ``memory_limit`` setting at the top level of the Gravity configuration, if set. Ignored if ``process_manager`` is
# ``supervisor``.
# memory_limit:
# Extra environment variables and their values to set when running the service. A dictionary where keys are the variable
# names.
# environment: {}
# Configure dynamic handlers in this section.
# See https://docs.galaxyproject.org/en/latest/admin/scaling.html#dynamically-defined-handlers for details.
# handlers: {}
galaxy:
# The directory that will be prepended to relative paths in options
# specifying other Galaxy config files (e.g. datatypes_config_file).
# Defaults to the directory in which galaxy.yml is located.
#config_dir: null
# The directory that will be prepended to relative paths in options
# specifying config files controlled by Galaxy (such as
# shed_tool_config_file, etc.). Must be writable by the user running
# Galaxy. Defaults to `<config_dir>/` if running Galaxy from source
# or `<data_dir>/config` otherwise.
#managed_config_dir: null
# The directory that will be prepended to relative paths in options
# specifying Galaxy data/cache directories and files (such as the
# default SQLite database, file_path, etc.). Defaults to `database/`
# if running Galaxy from source or `<config_dir>/data` otherwise.
#data_dir: null
# The directory containing custom templates for Galaxy, such as
# HTML/text email templates. Defaults to 'templates'. Default
# templates can be found in the Galaxy root under config/templates.
# These can be copied to <templates_dir> if you wish to customize
# them.
# The value of this option will be resolved with respect to
# <config_dir>.
#templates_dir: templates
# Top level cache directory. Any other cache directories
# (tool_cache_data_dir, template_cache_path, etc.) should be
# subdirectories.
# The value of this option will be resolved with respect to
# <data_dir>.
#cache_dir: cache
# By default, Galaxy uses a SQLite database at
# '<data_dir>/universe.sqlite'. You may use a SQLAlchemy connection
# string to specify an external database instead.
# Sample default
# 'sqlite:///<data_dir>/universe.sqlite?isolation_level=IMMEDIATE'
# You may specify additional options that will be passed to the
# SQLAlchemy database engine by using the prefix
# "database_engine_option_". For some of these options, default values
# are provided (e.g. see database_engine_option_pool_size, etc.).
# The same applies to `install_database_connection`, for which you
# should use the "install_database_engine_option_" prefix.
# For more options, please check SQLAlchemy's documentation at
# https://docs.sqlalchemy.org/en/14/core/engines.html?highlight=create_engine#sqlalchemy.create_engine
#database_connection: null
# If the server logs errors about not having enough database pool
# connections, you will want to increase these values, or consider
# running more Galaxy processes.
#database_engine_option_pool_size: 5
# If the server logs errors about not having enough database pool
# connections, you will want to increase these values, or consider
# running more Galaxy processes.
#database_engine_option_max_overflow: 10
# If using MySQL and the server logs the error "MySQL server has gone
# away", you will want to set this to some positive value (7200 should
# work).
#database_engine_option_pool_recycle: -1
# If large database query results are causing memory or response time
# issues in the Galaxy process, leave the result on the server
# instead. This option is only available for PostgreSQL and is highly
# recommended.
#database_engine_option_server_side_cursors: false
# Log all database transactions, can be useful for debugging and
# performance profiling. Logging is done via Python's 'logging'
# module under the qualname
# 'galaxy.model.orm.logging_connection_proxy'
#database_query_profiling_proxy: false
# If auto-creating a postgres database on startup - it can be based on
# an existing template database. This will set that. This is probably
# only useful for testing but documentation is included here for
# completeness.
#database_template: null
# Log number of SQL queries executed and total time spent dispatching
# SQL statements for each web request. If statsd is also enabled this
# information will be logged there as well. This should be considered
# somewhat experimental, we are unsure of the performance costs of
# running this in production. This is useful information for
# optimizing database interaction performance. Similar information can
# be obtained on a per-request basis by enabling the sql_debug
# middleware and adding sql_debug=1 to a request string.
#database_log_query_counts: false
# Slow query logging. Queries slower than the threshold indicated
# below will be logged to debug. A value of '0' is disabled. For
# example, you would set this to .005 to log all queries taking longer
# than 5 milliseconds.
#slow_query_log_threshold: 0.0
# Enables a per request sql debugging option. If this is set to true,
# append ?sql_debug=1 to web request URLs to enable detailed logging
# on the backend of SQL queries generated during that request. This is
# useful for debugging slow endpoints during development.
#enable_per_request_sql_debugging: false
# By default, Galaxy will use the same database to track user data and
# tool shed install data. There are many situations in which it is
# valuable to separate these - for instance bootstrapping fresh Galaxy
# instances with pretested installs. The following option can be used
# to separate the tool shed install database (all other options listed
# above but prefixed with ``install_`` are also available).
# Defaults to the value of the 'database_connection' option.
#install_database_connection: null
# Setting the following option to true will cause Galaxy to
# automatically migrate the database forward after updates. This is
# not recommended for production use.
#database_auto_migrate: false
# Wait for database to become available instead of failing
# immediately.
#database_wait: false
# Number of attempts before failing if database_wait is enabled.
#database_wait_attempts: 60
# Time to sleep between attempts if database_wait is enabled (in
# seconds).
#database_wait_sleep: 1.0
# Time (in seconds) between attempts to remove old rows from the
# history_audit database table. Set to 0 to disable pruning.
#history_audit_table_prune_interval: 3600
# Where dataset files are stored. It must be accessible at the same
# path on any cluster nodes that will run Galaxy jobs, unless using
# Pulsar. The default value has been changed from 'files' to 'objects'
# as of 20.05; however, Galaxy will first check if the 'files'
# directory exists before using 'objects' as the default.
# The value of this option will be resolved with respect to
# <data_dir>.
#file_path: objects
# Where temporary files are stored. It must be accessible at the same
# path on any cluster nodes that will run Galaxy jobs, unless using
# Pulsar.
# The value of this option will be resolved with respect to
# <data_dir>.
#new_file_path: tmp
# Maximum size of uploadable files, specified in bytes (default:
# 100GB). This value is ignored if an external upload server is
# configured.
#maximum_upload_file_size: 107374182400
# Tool config files, defines what tools are available in Galaxy. Tools
# can be locally developed or installed from Galaxy tool sheds.
# (config/tool_conf.xml.sample will be used if left unset and
# config/tool_conf.xml does not exist). Can be a single file, a list
# of files, or (for backwards compatibility) a comma-separated list of
# files.
# The value of this option will be resolved with respect to
# <config_dir>.
#tool_config_file: tool_conf.xml
# Tool config file for tools installed from the Galaxy Tool Shed. Must
# be writable by Galaxy and generally should not be edited by hand. In
# older Galaxy releases, this file was part of the tool_config_file
# option. It is still possible to specify this file (and other
# shed-enabled tool config files) in tool_config_file, but in the
# standard case of a single shed-enabled tool config, this option is
# preferable. This file will be created automatically upon tool
# installation, whereas Galaxy will fail to start if any files in
# tool_config_file cannot be read.
# The value of this option will be resolved with respect to
# <managed_config_dir>.
#shed_tool_config_file: shed_tool_conf.xml
# This option is deprecated. In previous releases this file was
# maintained by tool migration scripts that are no longer part of the
# code base. The option remains as a placeholder for deployments where
# these scripts were previously run and such a file exists.
# The value of this option will be resolved with respect to
# <managed_config_dir>.
#migrated_tools_config: migrated_tools_conf.xml
# File that contains the XML section and tool tags from all tool panel
# config files integrated into a single file that defines the tool
# panel layout. This file can be changed by the Galaxy administrator
# to alter the layout of the tool panel. If not present, Galaxy will
# create it.
# The value of this option will be resolved with respect to
# <managed_config_dir>.
#integrated_tool_panel_config: integrated_tool_panel.xml
# Default path to the directory containing the tools defined in
# tool_conf.xml. Other tool config files must include the tool_path as
# an attribute in the <toolbox> tag.
#tool_path: tools
# Various dependency resolver configuration parameters will have
# defaults set relative to this path, such as the default conda
# prefix, default Galaxy packages path, legacy tool shed dependencies
# path, and the dependency cache directory.
# Set the string to null to explicitly disable tool dependency
# handling. If this option is set to none or an invalid path,
# installing tools with dependencies from the Tool Shed or in Conda
# will fail.
# The value of this option will be resolved with respect to
# <data_dir>.
#tool_dependency_dir: dependencies
# Specifies the path to the standalone dependency resolvers
# configuration file. This configuration can now be specified directly
# in the Galaxy configuration, see the description of the
# 'dependency_resolvers' option for details.
# The value of this option will be resolved with respect to
# <config_dir>.
#dependency_resolvers_config_file: dependency_resolvers_conf.xml
# conda_prefix is the location on the filesystem where Conda packages
# and environments are installed.
# Sample default '<tool_dependency_dir>/_conda'
#conda_prefix: null
# Override the Conda executable to use, it will default to the one on
# the PATH (if available) and then to <conda_prefix>/bin/conda
#conda_exec: null
# Pass debug flag to conda commands.
#conda_debug: false
# conda channels to enable by default
# (https://conda.io/docs/user-guide/tasks/manage-channels.html)
#conda_ensure_channels: conda-forge,bioconda,defaults
# Use locally-built conda packages.
#conda_use_local: false
# Set to true to instruct Galaxy to look for and install missing tool
# dependencies before each job runs.
#conda_auto_install: false
# Set to true to instruct Galaxy to install Conda from the web
# automatically if it cannot find a local copy and conda_exec is not
# configured.
#conda_auto_init: true
# You must set this to true if conda_prefix and job_working_directory
# are not on the same volume, or some conda dependencies will fail to
# execute at job runtime. Conda will copy packages content instead of
# creating hardlinks or symlinks. This will prevent problems with some
# specific packages (perl, R), at the cost of extra disk space usage
# and extra time spent copying packages.
#conda_copy_dependencies: false
# Path to a file that provides a mapping from abstract packages to
# concrete conda packages. See `config/local_conda_mapping.yml.sample`
# for examples.
# The value of this option will be resolved with respect to
# <config_dir>.
#local_conda_mapping_file: local_conda_mapping.yml
# Path to a file that provides a mapping from abstract packages to
# locally installed modules. See
# `config/environment_modules_mapping.yml.sample` for examples.
# The value of this option will be resolved with respect to
# <config_dir>.
#modules_mapping_files: environment_modules_mapping.yml
# Certain dependency resolvers (namely Conda) take a considerable
# amount of time to build an isolated job environment in the
# job_working_directory if the job working directory is on a network
# share. Set this option to true to cache the dependencies in a
# folder. This option is beta and should only be used if you
# experience long waiting times before a job is actually submitted to
# your cluster.
# This only affects tools where some requirements can be resolved but
# not others, most modern best practice tools can use prebuilt
# environments in the Conda directory.
#use_cached_dependency_manager: false
# By default the tool_dependency_cache_dir is the _cache directory of
# the tool dependency directory.
# Sample default '<tool_dependency_dir>/_cache'
#tool_dependency_cache_dir: null
# By default, when using a cached dependency manager, the dependencies
# are cached when installing new tools and when using tools for the
# first time. Set this to false if you prefer dependencies to be
# cached only when installing new tools.
#precache_dependencies: true
# File containing the Galaxy Tool Sheds that should be made available
# to install from in the admin interface (.sample used if default does
# not exist).
# The value of this option will be resolved with respect to
# <config_dir>.
#tool_sheds_config_file: tool_sheds_conf.xml
# Monitor the tools and tool directories listed in any tool config
# file specified in tool_config_file option. If changes are found,
# tools are automatically reloaded. Watchdog (
# https://pypi.org/project/watchdog/ ) must be installed and available
# to Galaxy to use this option. Other options include 'auto' which
# will attempt to watch tools if the watchdog library is available but
# won't fail to load Galaxy if it is not and 'polling' which will use
# a less efficient monitoring scheme that may work in wider range of
# scenarios than the watchdog default.
#watch_tools: 'false'
# Monitor dynamic job rules. If changes are found, rules are
# automatically reloaded. Takes the same values as the 'watch_tools'
# option.
#watch_job_rules: 'false'
# Monitor a subset of options in the core configuration file (See
# RELOADABLE_CONFIG_OPTIONS in lib/galaxy/config/__init__.py). If
# changes are found, modified options are automatically reloaded.
# Takes the same values as the 'watch_tools' option.
#watch_core_config: 'false'
# Monitor the interactive tours directory specified in the
# 'tour_config_dir' option. If changes are found, modified tours are
# automatically reloaded. Takes the same values as the 'watch_tools'
# option.
#watch_tours: 'false'
# Location of files available for a short time as downloads (short
# term storage). This directory is exclusively used for serving
# dynamically generated downloadable content. Galaxy may uses the
# new_file_path parameter as a general temporary directory and that
# directory should be monitored by a tool such as tmpwatch in
# production environments. short_term_storage_dir on the other hand is
# monitored by Galaxy's task framework and should not require such
# external tooling.
# The value of this option will be resolved with respect to
# <cache_dir>.
#short_term_storage_dir: short_term_web_storage
# Default duration before short term web storage files will be cleaned
# up by Galaxy tasks (in seconds). The default duration is 1 day.
#short_term_storage_default_duration: 86400
# The maximum duration short term storage files can hosted before they
# will be marked for clean up. The default setting of 0 indicates no
# limit here.
#short_term_storage_maximum_duration: 0
# How many seconds between instances of short term storage being
# cleaned up in default Celery task configuration.
#short_term_storage_cleanup_interval: 3600
# Configured FileSource plugins.
# The value of this option will be resolved with respect to
# <config_dir>.
#file_sources_config_file: file_sources_conf.yml
# FileSource plugins described embedded into Galaxy's config.
#file_sources: null
# Enable Galaxy to fetch containers registered with quay.io generated
# from tool requirements resolved through Conda. These containers
# (when available) have been generated using mulled -
# https://github.com/mulled. Container availability will vary by tool,
# this option will only be used for job destinations with Docker or
# Singularity enabled.
#enable_mulled_containers: true
# Container resolvers configuration. Set up a file describing
# container resolvers to use when discovering containers for Galaxy.
# If this is set to None, the default container resolvers loaded is
# determined by enable_mulled_containers. For available options see
# config/container_resolvers_conf.xml.sample.
#container_resolvers_config_file: null
# Rather than specifying a container_resolvers_config_file, the
# definition of the resolvers to enable can be embedded into Galaxy's
# config with this option. This has no effect if a
# container_resolvers_config_file is used. Takes the same options that
# can be set in container_resolvers_config_file.
#container_resolvers: null
# involucro is a tool used to build Docker or Singularity containers
# for tools from Conda dependencies referenced in tools as
# `requirement` s. The following path is the location of involucro on
# the Galaxy host. This is ignored if the relevant container resolver
# isn't enabled, and will install on demand unless involucro_auto_init
# is set to false.
# The value of this option will be resolved with respect to
# <tool_dependency_dir>.
#involucro_path: involucro
# Install involucro as needed to build Docker or Singularity
# containers for tools. Ignored if relevant container resolver is not
# used.
#involucro_auto_init: true
# Conda channels to use when building Docker or Singularity containers
# using involucro.
#mulled_channels: conda-forge,bioconda
# Enable automatic polling of relative tool sheds to see if any
# updates are available for installed repositories. Ideally only one
# Galaxy server process should be able to check for repository
# updates. The setting for hours_between_check should be an integer
# between 1 and 24.
#enable_tool_shed_check: false
# Enable automatic polling of relative tool sheds to see if any
# updates are available for installed repositories. Ideally only one
# Galaxy server process should be able to check for repository
# updates. The setting for hours_between_check should be an integer
# between 1 and 24.
#hours_between_check: 12
# XML config file that contains data table entries for the
# ToolDataTableManager. This file is manually # maintained by the
# Galaxy administrator (.sample used if default does not exist).
# The value of this option will be resolved with respect to
# <config_dir>.
#tool_data_table_config_path: tool_data_table_conf.xml
# XML config file that contains additional data table entries for the
# ToolDataTableManager. This file is automatically generated based on
# the current installed tool shed repositories that contain valid
# tool_data_table_conf.xml.sample files. At the time of installation,
# these entries are automatically added to the following file, which
# is parsed and applied to the ToolDataTableManager at server start
# up.
# The value of this option will be resolved with respect to
# <managed_config_dir>.
#shed_tool_data_table_config: shed_tool_data_table_conf.xml
# Directory where data used by tools is located. See the samples in
# that directory and the Galaxy Community Hub for help:
# https://galaxyproject.org/admin/data-integration
#tool_data_path: tool-data
# Directory where Tool Data Table related files will be placed when
# installed from a ToolShed. Defaults to the value of the
# 'tool_data_path' option.
#shed_tool_data_path: null
# Monitor the tool_data and shed_tool_data_path directories. If
# changes in tool data table files are found, the tool data tables for
# that data manager are automatically reloaded. Watchdog (
# https://pypi.org/project/watchdog/ ) must be installed and available
# to Galaxy to use this option. Other options include 'auto' which
# will attempt to use the watchdog library if it is available but
# won't fail to load Galaxy if it is not and 'polling' which will use
# a less efficient monitoring scheme that may work in wider range of
# scenarios than the watchdog default.
#watch_tool_data_dir: 'false'
# File containing refgenie configuration, e.g.
# /path/to/genome_config.yaml. Can be used by refgenie backed tool
# data tables.
#refgenie_config_file: null
# File that defines the builds (dbkeys) available at sites used by
# display applications and the URL to those sites.
# The value of this option will be resolved with respect to
# <config_dir>.
#build_sites_config_file: build_sites.yml
# File containing old-style genome builds.
# The value of this option will be resolved with respect to
# <tool_data_path>.
#builds_file_path: shared/ucsc/builds.txt
# Directory where chrom len files are kept, currently mainly used by
# trackster.
# The value of this option will be resolved with respect to
# <tool_data_path>.
#len_file_path: shared/ucsc/chrom
# Datatypes config file(s), defines what data (file) types are
# available in Galaxy (.sample is used if default does not exist). If
# a datatype appears in multiple files, the last definition is used
# (though the first sniffer is used so limit sniffer definitions to
# one file).
# The value of this option will be resolved with respect to
# <config_dir>.
#datatypes_config_file: datatypes_conf.xml
# Enable sniffing of compressed datatypes. This can be
# configured/overridden on a per-datatype basis in the
# datatypes_conf.xml file. With this option set to false the
# compressed datatypes will be unpacked before sniffing.
#sniff_compressed_dynamic_datatypes_default: true
# Disable the 'Auto-detect' option for file uploads
#datatypes_disable_auto: false
# Visualizations config directory: where to look for individual
# visualization plugins. The path is relative to the Galaxy root dir.
# To use an absolute path begin the path with '/'. This is a
# comma-separated list.
#visualization_plugins_directory: config/plugins/visualizations
# Interactive tour directory: where to store interactive tour
# definition files. Galaxy ships with several basic interface tours
# enabled, though a different directory with custom tours can be
# specified here. The path is relative to the Galaxy root dir. To use
# an absolute path begin the path with '/'. This is a comma-separated
# list.
#tour_config_dir: config/plugins/tours
# Webhooks directory: where to store webhooks - plugins to extend the
# Galaxy UI. By default none will be loaded. Set to
# config/plugins/webhooks/demo to load Galaxy's demo webhooks. To use
# an absolute path begin the path with '/'. This is a comma-separated
# list. Add test/functional/webhooks to this list to include the demo
# webhooks used to test the webhook framework.
#webhooks_dir: config/plugins/webhooks
# Each job is given a unique empty directory as its current working
# directory. This option defines in what parent directory those
# directories will be created.
# The value of this option will be resolved with respect to
# <data_dir>.
#job_working_directory: jobs_directory
# Mako templates are compiled as needed and cached for reuse, this
# directory is used for the cache
# The value of this option will be resolved with respect to
# <cache_dir>.
#template_cache_path: compiled_templates
# Set to false to disable various checks Galaxy will do to ensure it
# can run job scripts before attempting to execute or submit them.
#check_job_script_integrity: true
# Number of checks to execute if check_job_script_integrity is
# enabled.
#check_job_script_integrity_count: 35
# Time to sleep between checks if check_job_script_integrity is
# enabled (in seconds).
#check_job_script_integrity_sleep: 0.25
# Set the default shell used by non-containerized jobs Galaxy-wide.
# This defaults to bash for all jobs and can be overridden at the
# destination level for heterogeneous clusters. conda job resolution
# requires bash or zsh so if this is switched to /bin/sh for instance
# - conda resolution should be disabled. Containerized jobs always use
# /bin/sh - so more maximum portability tool authors should assume
# generated commands run in sh.
#default_job_shell: /bin/bash
# Whether to enable the tool document cache. This cache stores
# expanded XML strings. Enabling the tool cache results in slightly
# faster startup times. The tool cache is backed by a SQLite database,
# which cannot be stored on certain network disks. The cache location
# is configurable using the ``tool_cache_data_dir`` setting, but can
# be disabled completely here.
#enable_tool_document_cache: false
# Tool related caching. Fully expanded tools and metadata will be
# stored at this path. Per tool_conf cache locations can be configured
# in (``shed_``)tool_conf.xml files using the tool_cache_data_dir
# attribute.
# The value of this option will be resolved with respect to
# <cache_dir>.
#tool_cache_data_dir: tool_cache
# Directory in which the toolbox search index is stored. The value of
# this option will be resolved with respect to <data_dir>.
#tool_search_index_dir: tool_search_index
# Set this to true to delay parsing of tool inputs and outputs until
# they are needed. This results in faster startup times but uses more
# memory when using forked Galaxy processes.
#delay_tool_initialization: false
# Point Galaxy at a repository consisting of a copy of the bio.tools
# database (e.g. https://github.com/bio-tools/content/) to resolve
# bio.tools data for tool metadata.
#biotools_content_directory: null
# Set this to true to attempt to resolve bio.tools metadata for tools
# for tool not resovled via biotools_content_directory.
#biotools_use_api: false
# bio.tools web service request related caching. The type of beaker
# cache used.
#biotools_service_cache_type: file
# bio.tools web service request related caching. The data directory to
# point beaker cache at.
# The value of this option will be resolved with respect to
# <cache_dir>.
#biotools_service_cache_data_dir: biotools/data
# bio.tools web service request related caching. The lock directory to
# point beaker cache at.
# The value of this option will be resolved with respect to
# <cache_dir>.
#biotools_service_cache_lock_dir: biotools/locks
# Citation related caching. Tool citations information maybe fetched
# from external sources such as https://doi.org/ by Galaxy - the
# following parameters can be used to control the caching used to
# store this information.
#citation_cache_type: file
# Citation related caching. Tool citations information maybe fetched
# from external sources such as https://doi.org/ by Galaxy - the
# following parameters can be used to control the caching used to
# store this information.
# The value of this option will be resolved with respect to
# <cache_dir>.
#citation_cache_data_dir: citations/data
# Citation related caching. Tool citations information maybe fetched
# from external sources such as https://doi.org/ by Galaxy - the
# following parameters can be used to control the caching used to
# store this information.
# The value of this option will be resolved with respect to
# <cache_dir>.
#citation_cache_lock_dir: citations/locks
# Mulled resolution caching. Mulled resolution uses external APIs of
# quay.io, these requests are caching using this and the following
# parameters
#mulled_resolution_cache_type: file
# Data directory used by beaker for caching mulled resolution
# requests.
# The value of this option will be resolved with respect to
# <cache_dir>.
#mulled_resolution_cache_data_dir: mulled/data
# Lock directory used by beaker for caching mulled resolution
# requests.
# The value of this option will be resolved with respect to
# <cache_dir>.
#mulled_resolution_cache_lock_dir: mulled/locks
# Seconds until the beaker cache is considered old and a new value is
# created.
#mulled_resolution_cache_expire: 3600
# Configuration file for the object store If this is set and exists,
# it overrides any other objectstore settings.
# The value of this option will be resolved with respect to
# <config_dir>.
#object_store_config_file: object_store_conf.xml
# What Dataset attribute is used to reference files in an ObjectStore
# implementation, this can be 'uuid' or 'id'. The default will depend
# on how the object store is configured, starting with 20.05 Galaxy
# will try to default to 'uuid' if it can be sure this is a new Galaxy
# instance - but the default will be 'id' in many cases. In
# particular, if the name of the directory set in <file_path> is
# `objects`, the default will be set to 'uuid', otherwise it will be
# 'id'.
#object_store_store_by: null
# Galaxy sends mail for various things: subscribing users to the