CellxGene Dashboard

A simple React dashboard to display and preview CellxGene URLs.

Setup

Development

# Install dependencies
npm install

# Start development server
npm run dev

Docker

# Build the image
docker build -t cellxgene-dash .

# Run with docker-compose
docker-compose up -d

The app will be available at http://localhost:8080

Configuration

1. Copy the example config file:

   cp config.example.json public/config.json

2. Edit public/config.json with your URLs:

   [
     {
       "url": "https://cellxgene.example.com/dataset1/",
       "host": "cellxgene.example.com",
       "path": "dataset1"
     }
   ]

3. The public/config.json file is gitignored to keep credentials safe.

Docker Deployment

Using Pre-built Image from GHCR

Pull and run the latest image from GitHub Container Registry:

docker run -d -p 8080:80 \
  -v $(pwd)/public/config.json:/usr/share/nginx/html/config.json:ro \
  ghcr.io/mskcc/cellxgene-dash:main

Or update docker-compose.yml to use the pre-built image:

version: '3.8'

services:
  cellxgene-dash:
    image: ghcr.io/mskcc/cellxgene-dash:main
    ports:
      - "8080:80"
    volumes:
      - ./public/config.json:/usr/share/nginx/html/config.json:ro
    restart: unless-stopped

Building Locally

When building locally, mount your config.json as a volume:

docker run -d -p 8080:80 \
  -v $(pwd)/public/config.json:/usr/share/nginx/html/config.json:ro \
  cellxgene-dash

Or use docker-compose (recommended):

docker-compose up -d