Set up your own refgenie server

Why

We don't anticipate many people wanting to run their own servers. Typically, you'll only need to run refgenie either from the command-line or via the Python API. These clients can interact with existing refgenie servers to pull down genome assets. But what if you want to build your own server? There are a few use cases where this can make sense.

First, perhaps you want a private, local server running on your internal network. This could speed up access to private refgenie assets across an organization. Or, you may want to make some particular assets available to the community. Building on the refgenie infrastructure will simplify distribution and make it so that your users can download your resource through a familiar interface.

How

It's pretty simple: the software that runs refgenie server is available on GitHub. There, you will find detailed instructions on how to run it yourself. In a nutshell, you'll just run a docker command like this:

docker run --rm -d -p 80:80 \
    -v /path/to/genomes_archive:/genomes \
    --name refgenieservercon \
    refgenieserverim refgenieserver -c /genomes/genome_config.yaml serve 

Mount your archived genomes folder to /genomes in the container, and you're essentially good to go.