Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 1.43 KB

Deployment.md

File metadata and controls

39 lines (24 loc) · 1.43 KB
Raw

Deployment

Remote deployment

If you are running the service on a remote server, you'll need to use HTTPS and tell Zarrcade how to address your server. You can point Uvicorn to your SSL certificate and set your BASE_URL like this:

BASE_URL=https://myserver.mydomain.org:8000 uvicorn zarrcade.serve:app --host 0.0.0.0 \
    --ssl-keyfile certs/cert.key --ssl-certfile certs/cert.crt --reload

You can also set BASE_URL and other configuration options in the settings.yaml file. See the configuration documentation for more details.

Running with Docker

To run the service locally using Docker, simply start the container and mount your OME-Zarr data:

docker run -it -v /root/data/dir:/data -p 8000:8000 ghcr.io/janeliascicomp/zarrcade

Production Deployment

Using an Nginx reverse proxy server is usually preferred for production deployments. You can run Nginx and Uvicorn using the Docker Compose configuration in the ./docker folder. Make sure you have Docker and Docker Compose installed on your system before proceeding.

First, create a .env file in the ./docker folder. You can copy the template like this:

cd docker
cp env.template .env

Customize the .env file and then start the services:

docker compose up -d