📚 Reference

Docker Images Reference

All official Ever Gauzy Docker images and their usage.

Published Images

ImageDescriptionSize
ghcr.io/ever-co/gauzy-apiAPI server~800MB
ghcr.io/ever-co/gauzy-webappAngular web app~200MB
ghcr.io/ever-co/gauzy-api-demoDemo API instance~800MB
ghcr.io/ever-co/gauzy-webapp-demoDemo webapp~200MB
ghcr.io/ever-co/gauzy-desktop-apiDesktop server API~1GB

Tags

TagDescription
latestLatest stable release
developLatest development build
vX.Y.ZSpecific version
sha-xxxxxxxSpecific commit

Basic Usage

API Server

docker run -d \
  --name gauzy-api \
  -p 3000:3000 \
  -e DB_TYPE=sqlite \
  -e JWT_SECRET=your-secret \
  ghcr.io/ever-co/gauzy-api:latest

Web App

docker run -d \
  --name gauzy-webapp \
  -p 4200:4200 \
  -e API_BASE_URL=http://localhost:3000 \
  ghcr.io/ever-co/gauzy-webapp:latest

Docker Compose

services:
  api:
    image: ghcr.io/ever-co/gauzy-api:latest
    ports:
      - "3000:3000"
    env_file: .env

  webapp:
    image: ghcr.io/ever-co/gauzy-webapp:latest
    ports:
      - "4200:4200"

Building Custom Images

docker build -t custom-gauzy-api -f .deploy/api/Dockerfile .

Edit this page

Copyright © 2023-Present Ever Co. LTD.Docs by Sourcey