Running locally

The Reservoir Genome Browser can be run locally to view files on your computer without uploading to the hosted instance at resgen.io.

Usage requires a license. If you already have a resgen subscription, you can get a license from resgen.io.

If you don't have a license, you are entitled to run locally and host directories with a maximum of 10 datasets.

Starting locally

Starting locally will start resgen as a server on your local computer. You can access the UI at http://localhost:1807 (The port can be changed using the --port flag in the commands below)

resgen-manage start ~/my-directory

If you are on an M* Mac you'll need to add --platform=linux/arm64/v8 for the right Docker image to be used.

resgen-manage start ~/my-directory --platform=linux/arm64/v8

Create local user

Even when running locally you need to set up a user:

resgen manage create-user ~/my-directory

Synchronize datasets

Resgen maintains its own database of datasets, you'll need to synchronize manually when anything is added to the directory outside of resgen.

resgen manage sync-datasets ~/my-directory

Getting logs

If an error occurs, you can get the latest logs:

resgen manage logs ~/my-directory [nginx,uwsgi,celery]

The last parameter specifies the service to get logs for. In the majority of cases this will be uwsgi.