Galaxy Documentation
Galaxy is an open, web-based platform for accessible, reproducible, and transparent computational biomedical research.
For more information on the Galaxy Project, please visit the https://galaxyproject.org
This site contains documentation for administrators and developers. For user documentation, and admin and developer tutorials, please visit the Galaxy Training Network.
The community also maintains a list of awesome Galaxy resources related to all aspects of Galaxy.
- Releases
- 24.1 Galaxy Release (June 2024)
- 24.0 Galaxy Release (March 2024)
- 23.2 Galaxy Release (January 2024)
- 23.1 Galaxy Release (June 2023)
- 23.0 Galaxy Release (April 2023)
- May 2022 Galaxy Release (v 22.05)
- January 2022 Galaxy Release (v 22.01)
- September 2021 Galaxy Release (v 21.09)
- May 2021 Galaxy Release (v 21.05)
- January 2021 Galaxy Release (v 21.01)
- September 2020 Galaxy Release (v 20.09)
- May 2020 Galaxy Release (v 20.05)
- January 2020 Galaxy Release (v 20.01)
- September 2019 Galaxy Release (v 19.09)
- May 2019 Galaxy Release (v 19.05)
- January 2019 Galaxy Release (v 19.01)
- September 2018 Galaxy Release (v 18.09)
- May 2018 Galaxy Release (v 18.05)
- January 2018 Galaxy Release (v 18.01)
- September 2017 Galaxy Release (v 17.09)
- May 2017 Galaxy Release (v 17.05)
- January 2017 Galaxy Release (v 17.01)
- October 2016 Galaxy Release (v 16.10)
- July 2016 Galaxy Release (v 16.07)
- April 2016 Galaxy Release (v 16.04)
- January 2016 Galaxy Release (v 16.01)
- October 2015 Galaxy Release (v 15.10)
- July 2015 Galaxy Release (v 15.07)
- May 2015 Galaxy Release (v 15.05)
- March 2015 Galaxy Release (v 15.03)
- January 2015 Galaxy Release (v 15.01)
- October 2014 Galaxy Release (v 14.10)
- August 2014 Galaxy Release (v 14.08)
- June 2014 Galaxy Release (v 14.06)
- April 2014 Galaxy Release (v 14.04)
- February 2014 Galaxy Release (v 14.02)
- November 2013 Galaxy Release (v 13.11)
- August 2013 Galaxy Release (v 13.08)
- June 2013 Galaxy Release (v 13.06)
- April 2013 Galaxy Release (v 13.04)
- February 2013 Galaxy Release (v 13.02)
- January 2013 Galaxy Release (v 13.01)
- Galaxy Releases older than v 13.01
- Administration
- Supported Python versions
- Framework Dependencies
- Galaxy Configuration
- Logging Configuration
- Production Environments
- Connecting Users and Data
- Security considerations
- Proxying Galaxy with NGINX
- Proxying Galaxy with Apache
- Scaling and Load Balancing
- Connecting to a Cluster
- Galaxy Job Configuration
- Collecting Job Metrics
- Authentication
- Tool Panel Administration
- Tool data
- Message queue
- Dependency Resolvers in Galaxy
- Containers in Galaxy
- Conda for Tool Dependencies
- Galaxy Database Schema Migrations
- Galaxy Reports
- Scripts & Tricks
- Configuration Options
- Migrating from uWSGI to Gunicorn and FastAPI
- Special topics
- Development
- Galaxy Tool XML File
- API Design Guidelines
- How SQLAlchemy sessions are handled in Galaxy
- Build a job runner
- Finding and improving slow Galaxy code
- Data managers
- Data Types
- How Do I…
- Writing Tests for Galaxy
- Debugging Galaxy Tests
- Debugging tests that run out of memory
- Debugging Galaxy
- Debugging Galaxy: Slurm Compute Cluster
- Translating the Interface
- Creating Galaxy Releases
- Creating Galaxy Point Releases
- Galaxy API
- Tool Shed API
- Application Documentation
Indices and tables
Building this Documentation
If you have your own copy of the Galaxy source code, you can also generate your own version of this documentation. Run the following command from the Galaxy’s root:
$ make docs
The generated documentation will be in doc/build/html/
and can be viewed with a web browser. Note that you will need to install Sphinx and other module dependencies which are listed in the Makefile in the Galaxy root folder.