Docker deployment guide

Introduction

Powerhouse provides official Docker images for deploying your applications in containerized environments. This guide covers the available Docker images, how to use them with Docker Compose, and the environment variables you can configure.

Docker deployment is ideal for:

• Production environments that require consistent, reproducible deployments
• Development teams that want to share a common environment
• CI/CD pipelines that need automated testing and deployment
• Cloud platforms like AWS ECS, Google Cloud Run, or Kubernetes

Available Docker Images

Powerhouse publishes three official Docker images to the GitHub Container Registry (ghcr.io):

1. Connect

The Connect image provides the Powerhouse web application frontend with an embedded Nginx server.

ghcr.io/powerhouse-inc/powerhouse/connect

Available tags:

• latest - Latest stable release
• dev - Development builds
• staging - Staging builds
• vX.Y.Z - Specific version tags (e.g., v1.0.0)

2. Switchboard

The Switchboard image provides the backend API server that handles document synchronization and GraphQL endpoints.

ghcr.io/powerhouse-inc/powerhouse/switchboard

Available tags:

• latest - Latest stable release
• dev - Development builds
• staging - Staging builds
• vX.Y.Z - Specific version tags (e.g., v1.0.0)

3. Academy

The Academy image provides the documentation website.

ghcr.io/powerhouse-inc/powerhouse/academy

Available tags:

• latest - Latest stable release
• dev - Development builds
• staging - Staging builds
• vX.Y.Z - Specific version tags (e.g., v1.0.0)

Quick Start with Docker Compose

The easiest way to run Powerhouse locally is using Docker Compose. Create a docker-compose.yml file or use the one provided in the repository:

name: powerhouse

services:
  connect:
    image: ghcr.io/powerhouse-inc/powerhouse/connect:dev
    environment:
      - DATABASE_URL=postgres://postgres:postgres@postgres:5432/postgres
      - BASE_PATH=/
    ports:
      - "127.0.0.1:3000:4000"
    networks:
      - powerhouse_network
    depends_on:
      postgres:
        condition: service_healthy

  switchboard:
    image: ghcr.io/powerhouse-inc/powerhouse/switchboard:dev
    environment:
      - DATABASE_URL=postgres://postgres:postgres@postgres:5432/postgres
    ports:
      - "127.0.0.1:4000:4001"
    networks:
      - powerhouse_network
    depends_on:
      postgres:
        condition: service_healthy

  postgres:
    image: postgres:16.1
    ports:
      - "127.0.0.1:5444:5432"
    environment:
      - POSTGRES_PASSWORD=postgres
      - POSTGRES_DB=postgres
      - POSTGRES_USER=postgres
    networks:
      - powerhouse_network
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U postgres"]
      interval: 5s
      timeout: 3s
      retries: 3

networks:
  powerhouse_network:
    name: powerhouse_network

Running the Stack

Start all services:

docker compose up -d

View logs:

docker compose logs -f

Stop all services:

docker compose down

After starting, you can access:

• Connect: http://localhost:3000
• Switchboard: http://localhost:4000

Environment Variables

Connect Environment Variables

Variable	Description	Default
PORT	Port the server listens on	4000
PH_CONNECT_BASE_PATH	Base URL path for the application	/
PH_PACKAGES	Comma-separated list of packages to install at startup	""
PH_CONNECT_SENTRY_DSN	Sentry DSN for error tracking	""
PH_CONNECT_SENTRY_ENV	Sentry environment name	""
DATABASE_URL	PostgreSQL connection string	Required

Feature Flags

Variable	Description	Default
PH_CONNECT_DEFAULT_DRIVES_URL	Default drives URL to load	""
PH_CONNECT_ENABLED_EDITORS	Enabled editor types (* for all)	"*"
PH_CONNECT_DISABLED_EDITORS	Disabled editor types	""
PH_CONNECT_PUBLIC_DRIVES_ENABLED	Enable public drives	"true"
PH_CONNECT_CLOUD_DRIVES_ENABLED	Enable cloud drives	"true"
PH_CONNECT_LOCAL_DRIVES_ENABLED	Enable local drives	"true"
PH_CONNECT_SEARCH_BAR_ENABLED	Enable search bar	"false"
PH_CONNECT_DISABLE_ADD_PUBLIC_DRIVES	Disable adding public drives	"false"
PH_CONNECT_DISABLE_ADD_CLOUD_DRIVES	Disable adding cloud drives	"false"
PH_CONNECT_DISABLE_ADD_LOCAL_DRIVES	Disable adding local drives	"false"
PH_CONNECT_DISABLE_DELETE_PUBLIC_DRIVES	Disable deleting public drives	"false"
PH_CONNECT_DISABLE_DELETE_CLOUD_DRIVES	Disable deleting cloud drives	"false"
PH_CONNECT_DISABLE_DELETE_LOCAL_DRIVES	Disable deleting local drives	"false"
PH_CONNECT_HIDE_DOCUMENT_MODEL_SELECTION_SETTINGS	Hide document model selection	"true"

Renown Authentication

Variable	Description	Default
PH_CONNECT_RENOWN_URL	Renown authentication service URL	"https://auth.renown.id"
PH_CONNECT_RENOWN_NETWORK_ID	Renown network identifier	"eip155"
PH_CONNECT_RENOWN_CHAIN_ID	Renown chain ID	1

Switchboard Environment Variables

Core Configuration

Variable	Description	Default
PORT	Port the server listens on	4001
PH_SWITCHBOARD_PORT	Alias for PORT	$PORT
DATABASE_URL	PostgreSQL or SQLite connection string	"dev.db"
PH_SWITCHBOARD_DATABASE_URL	Alias for DATABASE_URL	"dev.db"
BASE_PATH	Base URL path for the API	"/"
PH_PACKAGES	Comma-separated list of packages to install at startup	""

Authentication

Variable	Description	Default
AUTH_ENABLED	Enable authentication	"false"
ADMINS	Comma-separated list of admin wallet addresses	""
USERS	Comma-separated list of user wallet addresses	""
GUESTS	Comma-separated list of guest wallet addresses	""
FREE_ENTRY	Allow unauthenticated access when auth is enabled	"false"

Error Tracking & Monitoring

Variable	Description	Default
SENTRY_DSN	Sentry DSN for error tracking	""
SENTRY_ENV	Sentry environment name (e.g., "production", "staging")	""
PYROSCOPE_SERVER_ADDRESS	Pyroscope server address for performance profiling	""

Installing Custom Packages

Both Connect and Switchboard support installing custom Powerhouse packages at container startup using the PH_PACKAGES environment variable.

services:
  connect:
    image: ghcr.io/powerhouse-inc/powerhouse/connect:dev
    environment:
      - PH_PACKAGES=@powerhousedao/todo-demo-package,@powerhousedao/another-package

Packages are installed using the ph install command before the service starts.

Image Architecture

Connect Image

The Connect image is based on Alpine Linux and includes:

• Node.js and pnpm
• Nginx with Brotli compression
• The ph-cmd CLI tool
• A pre-initialized Powerhouse project

At startup, the entrypoint script:

1. Installs any packages specified in PH_PACKAGES
2. Builds the Connect frontend with ph connect build
3. Configures and starts Nginx to serve the built files

Switchboard Image

The Switchboard image is based on Node.js 22 and includes:

• pnpm package manager
• The ph-cmd CLI tool
• Prisma CLI for database migrations
• A pre-initialized Powerhouse project

At startup, the entrypoint script:

1. Installs any packages specified in PH_PACKAGES
2. Runs Prisma database migrations (if using PostgreSQL)
3. Starts the Switchboard server with ph switchboard

Production Considerations

Using Specific Version Tags

For production deployments, always use specific version tags instead of latest or dev:

services:
  connect:
    image: ghcr.io/powerhouse-inc/powerhouse/connect:v1.0.0
  switchboard:
    image: ghcr.io/powerhouse-inc/powerhouse/switchboard:v1.0.0

Database Persistence

For production, ensure your PostgreSQL data is persisted using volumes:

services:
  postgres:
    image: postgres:16.1
    volumes:
      - postgres_data:/var/lib/postgresql/data
    environment:
      - POSTGRES_PASSWORD=your-secure-password
      - POSTGRES_DB=powerhouse
      - POSTGRES_USER=powerhouse

volumes:
  postgres_data:

Health Checks

The provided docker-compose.yml includes health checks for PostgreSQL. Services wait for the database to be healthy before starting, preventing connection errors during startup.

Network Security

The example configuration binds ports to 127.0.0.1 only:

ports:
  - "127.0.0.1:3000:4000"

This prevents direct external access. In production, use a reverse proxy (like Nginx or Traefik) to:

• Terminate SSL/TLS
• Handle load balancing
• Provide additional security headers

Environment File

For better security, use a .env file instead of hardcoding credentials:

# .env
POSTGRES_PASSWORD=your-secure-password
DATABASE_URL=postgres://powerhouse:your-secure-password@postgres:5432/powerhouse

services:
  switchboard:
    image: ghcr.io/powerhouse-inc/powerhouse/switchboard:latest
    env_file:
      - .env

Troubleshooting

Container Won't Start

Check the logs for errors:

docker compose logs connect
docker compose logs switchboard

Database Connection Issues

Ensure the database is ready before services start:

docker compose logs postgres

Verify the DATABASE_URL format:

postgres://user:password@host:port/database

Package Installation Fails

If custom packages fail to install, check:

1. Package name is correct
2. Network connectivity from container
3. Container has access to npm registry

Permission Issues

If you encounter permission issues with volumes:

# Fix ownership
sudo chown -R 1000:1000 ./data

Building Custom Images

You can extend the official images for custom deployments:

FROM ghcr.io/powerhouse-inc/powerhouse/connect:latest

# Install additional packages at build time
RUN ph install @powerhousedao/my-custom-package

# Add custom configuration
COPY my-nginx.conf /etc/nginx/nginx.conf.template

Build and push your custom image:

docker build -t my-registry/my-connect:latest .
docker push my-registry/my-connect:latest

Next Steps

• Learn about Environment Configuration for more detailed setup options
• Explore Publishing Your Project to create your own packages
• Check the Setup Environment Guide for VM-based deployments