-
Notifications
You must be signed in to change notification settings - Fork 1k
/
galaxy.yml.sample
1780 lines (1474 loc) · 82.2 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.
#
uwsgi:
# The address and port on which to listen. By default, only listen to
# localhost (galaxy will not be accessible over the network). Use
# ':8080' to listen on all available network interfaces.
http: 127.0.0.1:8080
# By default uWSGI allocates a very small buffer (4096 bytes) for the
# headers of each request. If you start receiving "invalid request
# block size" in your logs, it could mean you need a bigger buffer. We
# recommend at least 16384.
buffer-size: 16384
# Number of web server (worker) processes to fork after the
# application has loaded. If this is set to greater than 1, thunder-
# lock likely should be enabled below.
processes: 1
# Number of threads for each web server process.
threads: 4
# Number of threads for serving static content and handling internal
# routing requests.
offload-threads: 2
# Mapping to serve style content.
static-map: /static/style=static/style/blue
# Mapping to serve the remainder of the static content.
static-map: /static=static
# Mapping to serve the favicon.
static-map: /favicon.ico=static/favicon.ico
# Enable the master process manager. Disabled by default for maximum
# compatibility with CTRL+C, but should be enabled for use with
# --daemon and/or production deployments.
master: false
# Path to the application's Python virtual environment. If using Conda
# for Galaxy's framework dependencies (not tools!), do not set this.
virtualenv: .venv
# Path to the application's Python library.
pythonpath: lib
# The entry point which returns the web application (e.g. Galaxy,
# Reports, etc.) that you are loading.
module: galaxy.webapps.galaxy.buildapp:uwsgi_app()
# Mount the web application (e.g. Galaxy, Reports, etc.) at the given
# URL prefix. Cannot be used together with 'module:' above.
#mount: /galaxy=galaxy.webapps.galaxy.buildapp:uwsgi_app()
# Make uWSGI rewrite PATH_INFO and SCRIPT_NAME according to mount-
# points. Set this to true if a URL prefix is used.
manage-script-name: false
# It is usually a good idea to set this to ``true`` if processes is
# greater than 1.
thunder-lock: false
# Cause uWSGI to respect the traditional behavior of dying on SIGTERM
# (its default is to brutally reload workers)
die-on-term: true
# Cause uWSGI to gracefully reload workers and mules upon receipt of
# SIGINT (its default is to brutally kill workers)
hook-master-start: unix_signal:2 gracefully_kill_them_all
# Cause uWSGI to gracefully reload workers and mules upon receipt of
# SIGTERM (its default is to brutally kill workers)
hook-master-start: unix_signal:15 gracefully_kill_them_all
# Feature necessary for proper mule signal handling
py-call-osafterfork: true
# Ensure application threads will run if `threads` is unset.
enable-threads: true
galaxy:
# When running multiple Galaxy instances under separate URL prefixes
# on a single hostname, you will want to set this to the same path as
# the prefix set in the uWSGI "mount" configuration option above. This
# value becomes the "path" attribute set in the cookie so the cookies
# from one instance will not clobber those from another.
#cookie_path: ''
# By default, Galaxy uses a SQLite database at
# 'database/universe.sqlite'. You may use a SQLAlchemy connection
# string to specify an external database instead. This string takes
# many options which are explained in detail in the config file
# documentation.
#database_connection: 'sqlite:///./database/universe.sqlite?isolation_level=IMMEDIATE'
# 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: ''
# 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
# Enable's 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).
#install_database_connection: 'sqlite:///./database/universe.sqlite?isolation_level=IMMEDIATE'
# 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
# Where dataset files are stored. It must accessible at the same path
# on any cluster nodes that will run Galaxy jobs, unless using Pulsar.
#file_path: database/files
# Where temporary files are stored. It must accessible at the same
# path on any cluster nodes that will run Galaxy jobs, unless using
# Pulsar.
#new_file_path: database/tmp
# 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).
#tool_config_file: 'config/tool_conf.xml,config/shed_tool_conf.xml'
# Enable / disable checking if any tools defined in the above non-shed
# tool_config_files (i.e., tool_conf.xml) have been migrated from the
# Galaxy code distribution to the Tool Shed. This functionality is
# largely untested in modern Galaxy releases and has serious issues
# such as #7273 and the possibility of slowing down Galaxy startup, so
# the default and recommended value is False.
#check_migrate_tools: false
# Tool config maintained by tool migration scripts. If you use the
# migration scripts to install tools that have been migrated to the
# tool shed upon a new release, they will be added to this tool config
# file.
#migrated_tools_config: 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.
#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
# Path to the directory in which tool dependencies are placed. This
# is used by the Tool Shed to install dependencies and can also be
# used by administrators to manually install or link to dependencies.
# For details, see: https://galaxyproject.org/admin/config/tool-
# dependencies Set the string to None 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 will
# fail.
#tool_dependency_dir: database/dependencies
# The dependency resolvers config file specifies an ordering and
# options for how Galaxy resolves tool dependencies (requirement tags
# in Tool XML). The default ordering is to the use the Tool Shed for
# tools installed that way, use local Galaxy packages, and then use
# Conda if available. See https://github.com/galaxyproject/galaxy/blob
# /dev/doc/source/admin/dependency_resolvers.rst for more information
# on these options.
#dependency_resolvers_config_file: config/dependency_resolvers_conf.xml
# conda_prefix is the location on the filesystem where Conda packages
# and environments are installed IMPORTANT: Due to a current
# limitation in conda, the total length of the conda_prefix and the
# job_working_directory path should be less than 50 characters!
#conda_prefix: <tool_dependency_dir>/_conda
# 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: 'iuc,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
# 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 the following 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.
#use_cached_dependency_manager: false
# By default the tool_dependency_cache_dir is the _cache directory of
# the tool dependency directory
#tool_dependency_cache_dir: <tool_dependency_dir>/_cache
# 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).
#tool_sheds_config_file: config/tool_sheds_conf.xml
# Set to True to enable monitoring of 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'
# Set to True to enable monitoring of dynamic job rules. If changes
# are found, rules are automatically reloaded. Takes the same values
# as the 'watch_tools' option.
#watch_job_rules: 'false'
# As of 18.09, Galaxy defaults to setting up the object store
# configuration for output datasets during the job queue step in job
# handlers. This should generally provide for more robust job
# submission, more configurability, and a better user experience but
# may in some cases slightly slow down the job handler job setup
# process. On the off chance that an admin would like to or need to
# optimize job handlers at the expense of user experience and web
# handling this option will remain for some time by setting this
# option to true. This behavior however should be considered
# deprecated and this option will likely be removed in future versions
# of Galaxy. For more information see
# https://github.com/galaxyproject/galaxy/issues/6513.
#legacy_eager_objectstore_initialization: false
# Enable Galaxy to fetch Docker 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 . These containers are highly beta and
# availability will vary by tool. This option will additionally only
# be used for job destinations with Docker enabled.
#enable_beta_mulled_containers: false
# Container resolvers configuration (beta). Setup a file describing
# container resolvers to use when discovering containers for Galaxy.
# If this is set to None, the default containers loaded is determined
# by enable_beta_mulled_containers.
#containers_resolvers_config_file: ''
# 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.
#involucro_path: database/dependencies/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
# Enable use of an in-memory registry with bi-directional
# relationships between repositories (i.e., in addition to lists of
# dependencies for a repository, keep an in-memory registry of
# dependent items for each repository.
#manage_dependency_relationships: false
# 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).
#tool_data_table_config_path: config/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.
#shed_tool_data_table_config: 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 tool_data_path.
#shed_tool_data_path: tool-data
# Set to True to enable monitoring of 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 old-style genome builds
#builds_file_path: tool-data/shared/ucsc/builds.txt
# Directory where chrom len files are kept, currently mainly used by
# trackster
#len_file_path: tool-data/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).
#datatypes_config_file: config/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. Defaults to "config/plugins/visualizations".
#visualization_plugins_directory: config/plugins/visualizations
# Interactive environment plugins root directory: where to look for
# interactive environment plugins. By default none will be loaded.
# Set to config/plugins/interactive_environments to load Galaxy's
# stock plugins. These will require Docker to be configured and have
# security considerations, so proceed with caution. The path is
# relative to the Galaxy root dir. To use an absolute path begin the
# path with '/'. This is a comma separated list.
#interactive_environment_plugins_directory: null
# To run interactive environment containers in Docker Swarm mode (on
# an existing swarm), set this option to True and set
# `docker_connect_port` in the IE plugin config (ini) file(s) of any
# IE plugins you have enabled and ensure that you are not using any
# `docker run`-specific options in your plugins' `command_inject`
# options (swarm mode services run using `docker service create`,
# which has a different and more limited set of options). This option
# can be overridden on a per-plugin basis by using the `swarm_mode`
# option in the plugin's ini config file.
#interactive_environment_swarm_mode: false
# Galaxy can run a "swarm manager" service that will monitor
# utilization of the swarm and provision/deprovision worker nodes as
# necessary. The service has its own configuration file.
#swarm_manager_config_file: config/swarm_manager_conf.yml
# 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.
#job_working_directory: database/jobs_directory
# If using a cluster, Galaxy will write job scripts and stdout/stderr
# to this directory.
#cluster_files_directory: database/pbs
# Mako templates are compiled as needed and cached for reuse, this
# directory is used for the cache
#template_cache_path: database/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
# 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.
#citation_cache_data_dir: database/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.
#citation_cache_lock_dir: database/citations/lock
# Tools with a number of outputs not known until runtime can write
# these outputs to a directory for collection by Galaxy when the job
# is done. Previously, this directory was new_file_path, but using one
# global directory can cause performance problems, so using
# job_working_directory ('.' or cwd when a job is run) is encouraged.
# By default, both are checked to avoid breaking existing tools.
#collect_outputs_from: 'new_file_path,job_working_directory'
# Configuration file for the object store If this is set and exists,
# it overrides any other objectstore settings.
#object_store_config_file: config/object_store_conf.xml
# Galaxy sends mail for various things: subscribing users to the
# mailing list if they request it, password resets, reporting dataset
# errors, and sending activation emails. To do this, it needs to send
# mail through an SMTP server, which you may define here (host:port).
# Galaxy will automatically try STARTTLS but will continue upon
# failure.
#smtp_server: ''
# If your SMTP server requires a username and password, you can
# provide them here (password in cleartext here, but if your server
# supports STARTTLS it will be sent over the network encrypted).
#smtp_username: ''
# If your SMTP server requires a username and password, you can
# provide them here (password in cleartext here, but if your server
# supports STARTTLS it will be sent over the network encrypted).
#smtp_password: ''
# If your SMTP server requires SSL from the beginning of the
# connection
#smtp_ssl: false
# On the user registration form, users may choose to join a mailing
# list. This is the address used to subscribe to the list. Uncomment
# and leave empty if you want to remove this option from the user
# registration form.
#mailing_join_addr: [email protected]
# Datasets in an error state include a link to report the error.
# Those reports will be sent to this address. Error reports are
# disabled if no address is set. Also this email is shown as a
# contact to user in case of Galaxy misconfiguration and other events
# user may encounter.
#error_email_to: ''
# Email address to use in the 'From' field when sending emails for
# account activations, workflow step notifications and password
# resets. We recommend using string in the following format: Galaxy
# Project <[email protected]> If not configured, '<galaxy-
# no-reply@HOSTNAME>' will be used.
#email_from: ''
# URL of the support resource for the galaxy instance. Used in
# activation emails.
#instance_resource_url: 'https://galaxyproject.org/'
# E-mail domains blacklist is used for filtering out users that are
# using disposable email address during the registration. If their
# address domain matches any domain in the blacklist, they are refused
# the registration.
#blacklist_file: config/disposable_email_blacklist.conf
# Registration warning message is used to discourage people from
# registering multiple accounts. Applies mostly for the main Galaxy
# instance. If no message specified the warning box will not be shown.
#registration_warning_message: Please register only one account - we provide this service free of charge and have limited computational resources. Multi-accounts are tracked and will be subjected to account termination and data deletion.
# User account activation feature global flag. If set to "False", the
# rest of the Account activation configuration is ignored and user
# activation is disabled (i.e. accounts are active since
# registration). The activation is also not working in case the SMTP
# server is not defined.
#user_activation_on: false
# Activation grace period (in hours). Activation is not forced (login
# is not disabled) until grace period has passed. Users under grace
# period can't run jobs. Enter 0 to disable grace period. Users with
# OpenID logins have grace period forever.
#activation_grace_period: 3
# Shown in warning box to users that were not activated yet. In use
# only if activation_grace_period is set.
#inactivity_box_content: 'Your account has not been activated yet. Feel free to browse around and see what''s available, but you won''t be able to upload data or run jobs until you have verified your email address.'
# Password expiration period (in days). Users are required to change
# their password every x days. Users will be redirected to the change
# password screen when they log in after their password expires. Enter
# 0 to disable password expiration.
#password_expiration_period: 0
# Galaxy Session Timeout This provides a timeout (in minutes) after
# which a user will have to log back in. A duration of 0 disables this
# feature.
#session_duration: 0
# You can enter tracking code here to track visitor's behavior through
# your Google Analytics account. Example: UA-XXXXXXXX-Y
#ga_code: ''
# Galaxy can display data at various external browsers. These options
# specify which browsers should be available. URLs and builds
# available at these browsers are defined in the specifield files. If
# use_remote_user = True, display application servers will be denied
# access to Galaxy and so displaying datasets in these sites will
# fail. display_servers contains a list of hostnames which should be
# allowed to bypass security to display datasets. Please be aware
# that there are security implications if this is allowed. More
# details (including required changes to the proxy server config) are
# available in the Apache proxy documentation on the Galaxy Community
# Hub. The list of servers in this sample config are for the UCSC
# Main, Test and Archaea browsers, but the default if left commented
# is to not allow any display sites to bypass security (you must
# uncomment the line below to allow them).
#display_servers: 'hgw1.cse.ucsc.edu,hgw2.cse.ucsc.edu,hgw3.cse.ucsc.edu,hgw4.cse.ucsc.edu,hgw5.cse.ucsc.edu,hgw6.cse.ucsc.edu,hgw7.cse.ucsc.edu,hgw8.cse.ucsc.edu,lowepub.cse.ucsc.edu'
# To disable the old-style display applications that are hardcoded
# into datatype classes, set enable_old_display_applications = False.
# This may be desirable due to using the new-style, XML-defined,
# display applications that have been defined for many of the
# datatypes that have the old-style. There is also a potential
# security concern with the old-style applications, where a malicious
# party could provide a link that appears to reference the Galaxy
# server, but contains a redirect to a third-party server, tricking a
# Galaxy user to access said site.
#enable_old_display_applications: true
# Show a message box under the masthead.
#message_box_visible: false
# Show a message box under the masthead.
#message_box_content: ''
# Class of the message box under the masthead. Possible values are:
# 'info' (the default), 'warning', 'error', 'done'.
#message_box_class: info
# Append "/{brand}" to the "Galaxy" text in the masthead.
#brand: ''
# Format string used when showing date and time information. The
# string may contain: - the directives used by Python time.strftime()
# function (see
# https://docs.python.org/library/time.html#time.strftime ), - $locale
# (complete format string for the server locale), - $iso8601 (complete
# format string as specified by ISO 8601 international standard).
#pretty_datetime_format: $locale (UTC)
# Default localization for Galaxy UI. Allowed values are listed at the
# end of client/galaxy/scripts/nls/locale.js. With the default value
# (auto), the locale will be automatically adjusted to the user's
# navigator language. Users can override this settings in their user
# preferences if the localization settings are enabled in
# user_preferences_extra_conf.yml
#default_locale: auto
# URL (with schema http/https) of the Galaxy instance as accessible
# within your local network - if specified used as a default by pulsar
# file staging and Jupyter Docker container for communicating back
# with Galaxy via the API. If you are attempting to setup GIEs on Mac
# OS X with Docker for Mac - this should likely be the IP address of
# your machine on the virtualbox network (vboxnet0) setup for the
# Docker host VM. This can found by running ifconfig and using the IP
# address of the network vboxnet0.
#galaxy_infrastructure_url: 'http://localhost:8080'
# If the above URL cannot be determined ahead of time in dynamic
# environments but the port which should be used to access Galaxy can
# be - this should be set to prevent Galaxy from having to guess. For
# example if Galaxy is sitting behind a proxy with REMOTE_USER enabled
# - infrastructure shouldn't talk to Python processes directly and
# this should be set to 80 or 443, etc... If unset this file will be
# read for a server block defining a port corresponding to the webapp.
#galaxy_infrastructure_web_port: 8080
# The URL of the page to display in Galaxy's middle pane when loaded.
# This can be an absolute or relative URL.
#welcome_url: /static/welcome.html
# The URL linked by the "Galaxy/brand" text.
#logo_url: /
# The URL linked by the "Galaxy Help" link in the "Help" menu.
#helpsite_url: ''
# The URL linked by the "Wiki" link in the "Help" menu.
#wiki_url: 'https://galaxyproject.org/'
# The URL linked by the "Support" link in the "Help" menu.
#support_url: 'https://galaxyproject.org/support/'
# Enable integration with a custom Biostar instance.
#biostar_url: ''
# Enable integration with a custom Biostar instance.
#biostar_key_name: ''
# Enable integration with a custom Biostar instance.
#biostar_key: ''
# Enable integration with a custom Biostar instance.
#biostar_enable_bug_reports: true
# Enable integration with a custom Biostar instance.
#biostar_never_authenticate: false
# The URL linked by the "How to Cite Galaxy" link in the "Help" menu.
#citation_url: 'https://galaxyproject.org/citing-galaxy'
# The URL linked by the "Search" link in the "Help" menu.
#search_url: 'https://galaxyproject.org/search/'
# The URL linked by the "Mailing Lists" link in the "Help" menu.
#mailing_lists_url: 'https://galaxyproject.org/mailing-lists'
# The URL linked by the "Videos" link in the "Help" menu.
#screencasts_url: 'https://vimeo.com/galaxyproject'
# Points to the GenomeSpace UI service which will be used by the
# GenomeSpace importer and exporter tools
#genomespace_ui_url: 'https://gsui.genomespace.org/jsui/'
# The URL linked by the "Terms and Conditions" link in the "Help"
# menu, as well as on the user registration and login forms and in the
# activation emails.
#terms_url: ''
# The URL linked by the "Galaxy Q&A" link in the "Help" menu The
# Galaxy Q&A site is under development; when the site is done, this
# URL will be set and uncommented.
#qa_url: null
# Serve static content, which must be enabled if you're not serving it
# via a proxy server. These options should be self explanatory and so
# are not documented individually. You can use these paths (or ones
# in the proxy server) to point to your own styles.
#static_enabled: true
# Serve static content, which must be enabled if you're not serving it
# via a proxy server. These options should be self explanatory and so
# are not documented individually. You can use these paths (or ones
# in the proxy server) to point to your own styles.
#static_cache_time: 360
# Serve static content, which must be enabled if you're not serving it
# via a proxy server. These options should be self explanatory and so
# are not documented individually. You can use these paths (or ones
# in the proxy server) to point to your own styles.
#static_dir: static/
# Serve static content, which must be enabled if you're not serving it
# via a proxy server. These options should be self explanatory and so
# are not documented individually. You can use these paths (or ones
# in the proxy server) to point to your own styles.
#static_images_dir: static/images
# Serve static content, which must be enabled if you're not serving it
# via a proxy server. These options should be self explanatory and so
# are not documented individually. You can use these paths (or ones
# in the proxy server) to point to your own styles.
#static_favicon_dir: static/favicon.ico
# Serve static content, which must be enabled if you're not serving it
# via a proxy server. These options should be self explanatory and so
# are not documented individually. You can use these paths (or ones
# in the proxy server) to point to your own styles.
#static_scripts_dir: static/scripts/
# Serve static content, which must be enabled if you're not serving it
# via a proxy server. These options should be self explanatory and so
# are not documented individually. You can use these paths (or ones
# in the proxy server) to point to your own styles.
#static_style_dir: static/june_2007_style/blue
# Serve static content, which must be enabled if you're not serving it
# via a proxy server. These options should be self explanatory and so
# are not documented individually. You can use these paths (or ones
# in the proxy server) to point to your own styles.
#static_robots_txt: static/robots.txt
# Incremental Display Options
#display_chunk_size: 65536
# For help on configuring the Advanced proxy features, see:
# https://docs.galaxyproject.org/en/master/admin/production.html
# Apache can handle file downloads (Galaxy-to-user) via mod_xsendfile.
# Set this to True to inform Galaxy that mod_xsendfile is enabled
# upstream.
#apache_xsendfile: false
# The same download handling can be done by nginx using X-Accel-
# Redirect. This should be set to the path defined in the nginx
# config as an internal redirect with access to Galaxy's data files
# (see documentation linked above).
#nginx_x_accel_redirect_base: ''
# If using compression in the upstream proxy server, use this option
# to disable gzipping of library .tar.gz and .zip archives, since the
# proxy server will do it faster on the fly.
#upstream_gzip: false
# The following default adds a header to web request responses that
# will cause modern web browsers to not allow Galaxy to be embedded in
# the frames of web applications hosted at other hosts - this can help
# prevent a class of attack called clickjacking
# (https://www.owasp.org/index.php/Clickjacking). If you configure a
# proxy in front of Galaxy - please ensure this header remains intact
# to protect your users. Uncomment and leave empty to not set the `X
# -Frame-Options` header.
#x_frame_options: SAMEORIGIN
# nginx can also handle file uploads (user-to-Galaxy) via
# nginx_upload_module. Configuration for this is complex and explained
# in detail in the documentation linked above. The upload store is a
# temporary directory in which files uploaded by the upload module
# will be placed.
#nginx_upload_store: ''
# This value overrides the action set on the file upload form, e.g.
# the web path where the nginx_upload_module has been configured to
# intercept upload requests.
#nginx_upload_path: ''
# Galaxy can also use nginx_upload_module to receive files staged out
# upon job completion by remote job runners (i.e. Pulsar) that
# initiate staging operations on the remote end. See the Galaxy nginx
# documentation for the corresponding nginx configuration.
#nginx_upload_job_files_store: ''
# Galaxy can also use nginx_upload_module to receive files staged out
# upon job completion by remote job runners (i.e. Pulsar) that
# initiate staging operations on the remote end. See the Galaxy nginx
# documentation for the corresponding nginx configuration.
#nginx_upload_job_files_path: ''
# Galaxy can upload user files in chunks without using nginx. Enable
# the chunk uploader by specifying a chunk size larger than 0. The
# chunk size is specified in bytes (default: 100MB).
#chunk_upload_size: 104857600
# Have Galaxy manage dynamic proxy component for routing requests to
# other services based on Galaxy's session cookie. It will attempt to
# do this by default though you do need to install node+npm and do an
# npm install from `lib/galaxy/web/proxy/js`. It is generally more
# robust to configure this externally, managing it however Galaxy is
# managed. If True, Galaxy will only launch the proxy if it is
# actually going to be used (e.g. for Jupyter).
#dynamic_proxy_manage: true
# As of 16.04 Galaxy supports multiple proxy types. The original
# NodeJS implementation, alongside a new Golang single-binary-no-
# dependencies version. Valid values are (node, golang)
#dynamic_proxy: node
# The NodeJS dynamic proxy can use an SQLite database or a JSON file
# for IPC, set that here.
#dynamic_proxy_session_map: database/session_map.sqlite
# Set the port and IP for the the dynamic proxy to bind to, this must
# match the external configuration if dynamic_proxy_manage is False.
#dynamic_proxy_bind_port: 8800
# Set the port and IP for the the dynamic proxy to bind to, this must
# match the external configuration if dynamic_proxy_manage is False.
#dynamic_proxy_bind_ip: 0.0.0.0
# Enable verbose debugging of Galaxy-managed dynamic proxy.
#dynamic_proxy_debug: false
# The dynamic proxy is proxied by an external proxy (e.g. apache
# frontend to nodejs to wrap connections in SSL).
#dynamic_proxy_external_proxy: false
# Additionally, when the dynamic proxy is proxied by an upstream
# server, you'll want to specify a prefixed URL so both Galaxy and the
# proxy reside under the same path that your cookies are under. This
# will result in a url like https://FQDN/galaxy-prefix/gie_proxy for
# proxying
#dynamic_proxy_prefix: gie_proxy
# This attribute governs the minimum length of time between
# consecutive HTTP/WS requests through the proxy, before the proxy
# considers a container as being inactive and kills it.
#dynamic_proxy_golang_noaccess: 60
# In order to kill containers, the golang proxy has to check at some
# interval for possibly dead containers. This is exposed as a
# configurable parameter, but the default value is probably fine.
#dynamic_proxy_golang_clean_interval: 10
# The golang proxy needs to know how to talk to your docker daemon.
# Currently TLS is not supported, that will come in an update.
#dynamic_proxy_golang_docker_address: 'unix:///var/run/docker.sock'
# The golang proxy uses a RESTful HTTP API for communication with
# Galaxy instead of a JSON or SQLite file for IPC. If you do not
# specify this, it will be set randomly for you. You should set this
# if you are managing the proxy manually.
#dynamic_proxy_golang_api_key: ''
# If True, Galaxy will attempt to configure a simple root logger if a
# "loggers" section does not appear in this configuration file.
#auto_configure_logging: true
# Verbosity of console log messages. Acceptable values can be found
# here: https://docs.python.org/library/logging.html#logging-levels A
# custom debug level of "TRACE" is available for even more verbosity.
#log_level: DEBUG
# Controls where and how the server logs messages. If unset, the
# default is to log all messages to standard output at the level
# defined by the `log_level` configuration option. Configuration is
# described in the documentation at:
# https://docs.galaxyproject.org/en/master/admin/config_logging.html
#logging: null
# Print database operations to the server log (warning, quite
# verbose!).
#database_engine_option_echo: false
# Print database pool operations to the server log (warning, quite
# verbose!).
#database_engine_option_echo_pool: false
# Turn on logging of application events and some user events to the
# database.
#log_events: true
# Turn on logging of user actions to the database. Actions currently
# logged are grid views, tool searches, and use of "recently" used
# tools menu. The log_events and log_actions functionality will
# eventually be merged.
#log_actions: true
# Fluentd configuration. Various events can be logged to the fluentd
# instance configured below by enabling fluent_log.
#fluent_log: false
# Fluentd configuration. Various events can be logged to the fluentd
# instance configured below by enabling fluent_log.
#fluent_host: localhost
# Fluentd configuration. Various events can be logged to the fluentd
# instance configured below by enabling fluent_log.
#fluent_port: 24224
# Sanitize all HTML tool output. By default, all tool output served
# as 'text/html' will be sanitized thoroughly. This can be disabled
# if you have special tools that require unaltered output. WARNING:
# disabling this does make the Galaxy instance susceptible to XSS
# attacks initiated by your users.
#sanitize_all_html: true
# Whitelist sanitization file. Datasets created by tools listed in
# this file are trusted and will not have their HTML sanitized on
# display. This can be manually edited or manipulated through the
# Admin control panel -- see "Manage Display Whitelist"
#sanitize_whitelist_file: config/sanitize_whitelist.txt
# By default Galaxy will serve non-HTML tool output that may
# potentially contain browser executable JavaScript content as plain
# text. This will for instance cause SVG datasets to not render
# properly and so may be disabled by setting the following option to
# True.
#serve_xss_vulnerable_mimetypes: false
# Return a Access-Control-Allow-Origin response header that matches
# the Origin header of the request if that Origin hostname matches one