This repo contains two primary resources:
- Setup scripts, config files, and a Dockerfile to create a docker image which encapsulates the WDK and OAuth dependencies of MicrobiomeDB into a single service
- A docker-compose.yml file that combines the image in (1) with EDA and VDI elements into a single stack, providing an entire MicrobiomeDB website
- Clone this repo.
- Run the script bin/cloneProjects.sh to build out a project_home containing the GUS project dependencies of MicrobiomeDB. Some of these projects may be private and require special github credentials to access. Note some of the projects are checked out as master and a few are on j21tc9 branches. The OAuth2Server project is also cloned as part of the image build and is also on a j21tc9 branch.
- Run
make docker
ormake dockernocache
if you've made recent changes. - This will create a local docker image for WDK/OAuth tagged with
mbio-wdk:latest
. If you want to run this image remotely you will have to take care of deploying it to DockerHub or another repository.
To run the full stack, you first need a configuration file containing the required environment variables needed by the stack. Start with the provided env.sample
(TODO: add advice for variable population).
Running a dev stack locally involves three pieces:
- Running sshuttle so VEuPathDB resources are still available (this will be true until we migrate everything to postgres)
- Running traefik as a front-end router
- Running the stack
sshuttle {configuration proprietary: see systems team>}