https://github.com/smithsonian/vagrant-galaxy
Vagrant launcher for Galaxy
https://github.com/smithsonian/vagrant-galaxy
Last synced: over 1 year ago
JSON representation
Vagrant launcher for Galaxy
- Host: GitHub
- URL: https://github.com/smithsonian/vagrant-galaxy
- Owner: Smithsonian
- License: mit
- Created: 2013-09-24T16:56:26.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2015-08-24T16:49:35.000Z (almost 11 years ago)
- Last Synced: 2023-03-24T19:10:07.076Z (over 3 years ago)
- Language: Shell
- Size: 218 KB
- Stars: 8
- Watchers: 11
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
vagrant-galaxy
==============
Vagrant launcher for Galaxy (http://galaxyproject.org/)
Requirements
------------
* Download and install VirtualBox (https://www.virtualbox.org/)
* Download and install Vagrant (http://www.vagrantup.com/)
* Download and install Fabric (http://fabfile.org/)
Note - the easiest way to install Fabric is through pip (or easy_install):
```
pip install fabric
```
Installation
------------
```
git clone https://github.com/Smithsonian/vagrant-galaxy.git
cd vagrant-galaxy
vagrant up
```
Point your browser at http://localhost:8080/ after starting up the galaxy server. You can do this via fabric (see below), for convenience, or you can do it manually like so:
```
vagrant ssh
cd /vagrant/galaxy-dist
./run.sh --daemon
```
Usage
-----
### Running Galaxy via fabric
To start the galaxy server, the included fabric file provides some convenience functions.
```
fab vagrant galaxy:start
```
Likewise, there are options for stopping, restarting, and checking the status of the galaxy server.
```
fab vagrant galaxy:stop
fab vagrant galaxy:restart
fab vagrant galaxy:status
```
You can find a full list of available fabric functions by typing the following:
```
fab list
```
### Running a local toolshed
Running a toolshed server inside the local VM is a convenient way to run deployment tests for
your custom galaxy tools. You can develop your tool (including wrappers, tests, datatypes,
dependencies, etc) on the galaxy instance, then upload the package to the toolshed and test
installing it back on the galaxy instance.
The syntax is identical to starting the galaxy server:
```
fab vagrant toolshed:start
fab vagrant toolshed:stop
fab vagrant toolshed:restart
fab vagrant toolshed:status
```
### Admin users
For both the galaxy and toolshed servers, the default admin user is vagrant@galaxy.local
Simply create a new user in each webapp with that e-mail address to access the admin menus
(or add your own admin user to the config files).
### Modifying galaxy's configuration files with fabric
This feature is still in development, but the basic usage is as follows:
```
fab vagrant config:OPTION,VALUE
```
Future direction
----------------
* Add other virtual providers: VMWare and AWS
* Replace the shell provisioner with ansible or fabric