Back to all templates
Immich logo

Immich

Application4096MB+ RAM

Self-hosted photo and video backup (Google Photos alternative)

photosbackupgoogle-photos-alternative

Deploy Immich in 3 Steps

1

Connect Your VPS

Add your server credentials to Server Compass

2

Select Immich

Choose from our template library

3

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required
Step-by-step deployment guide

Deploy Immich on a VPS with Server Compass

Use the Immich template in Server Compass to deploy a self-hosted photo and video backup server with PostgreSQL, Redis, machine learning, and upload storage, then verify the welcome screen in a browser.

About 8 minutesBrowser verified
1
Step 1

Open the server Apps tab

Select your VPS, open the Apps tab, and start a new app deployment.

Server Compass Apps tab before creating a Immich app
2
Step 2

Choose an app template

Click New App and choose the template deployment path so Server Compass can load the built-in catalog.

Choosing to deploy an app from a Server Compass template
3
Step 3

Search for Immich

Use the template picker search to find Immich.

Searching for Immich in the Server Compass template picker
4
Step 4

Select the Immich template

Choose the Immich template. Server Compass fills the app image, published server URL, host port, and PostgreSQL, Redis, machine learning, and upload storage.

Immich template selected in Server Compass
5
Step 5

Review the Immich settings

Confirm the app name, compose services, and generated configuration.

Reviewing Immich project settings and compose services
6
Step 6

Deploy Immich

Review the generated environment values, confirm the port is available, and click Deploy Now.

Reviewing Immich server URL and port before deployment
7
Step 7

Watch the deployment progress

Keep the deployment modal open while Server Compass pulls images, starts services, and verifies the stack.

Server Compass deploying the Immich template on the VPS
8
Step 8

Confirm Immich is running

After deployment finishes, confirm the Immich app is marked Running.

Immich template running in the Server Compass Apps tab
9
Step 9

Open Immich in the browser

Open the application URL in a browser. The Immich welcome screen confirms the app is reachable.

The deployed Immich welcome screen loaded in a browser

After Immich Opens

  • Create the first Immich admin user before production use.
  • Confirm upload storage and backup policy before importing phone photos and videos.
  • Add a domain and HTTPS before exposing the photo backup server to users.
  • Back up the Immich upload and PostgreSQL volumes before relying on the server for production photo libraries.

Verified Result

Immich loaded successfully and displayed the welcome screen.

Immich deployment questions

What does the Immich template deploy?

It deploys Immich with PostgreSQL, Redis, machine learning, and upload storage.

Which port did the tutorial use?

The tutorial used host port 2283, which maps to the Immich web server on container port 2283.

Command Line Setup

Install Immich Manually

Set up Immich yourself using Docker Compose and the command line.

1

Remote into Your Server

Initiate a secure shell connection to your server using the command below.

terminal
# Connect to your VPS
ssh root@your-server-ip

# Or with a specific SSH key
ssh -i ~/.ssh/your-key root@your-server-ip

First time? Docker required! Install it with: curl -fsSL https://get.docker.com | sh

2

Create the App Directory

Organize your deployment by creating a dedicated project folder.

terminal
# Create and navigate to project directory
mkdir -p ~/apps/immich
cd ~/apps/immich
3

Write Your docker-compose.yml

Create a new docker-compose.yml file and paste this configuration:

docker-compose.yml
services:
  immich-server:
    image: ghcr.io/immich-app/immich-server:release
    ports:
      - "2283:2283"
    environment:
      - DB_HOSTNAME=db
      - DB_USERNAME=immich
      - DB_PASSWORD=<your-db-password>
      - DB_DATABASE_NAME=immich
      - REDIS_HOSTNAME=redis
    volumes:
      - immich_upload:/usr/src/app/upload
      - /etc/localtime:/etc/localtime:ro
    restart: unless-stopped
    depends_on:
      - db
      - redis

  immich-machine-learning:
    image: ghcr.io/immich-app/immich-machine-learning:release
    volumes:
      - immich_model_cache:/cache
    restart: unless-stopped

  db:
    image: tensorchord/pgvecto-rs:pg16-v0.2.1
    environment:
      - POSTGRES_USER=immich
      - POSTGRES_PASSWORD=<your-db-password>
      - POSTGRES_DB=immich
    volumes:
      - postgres_data:/var/lib/postgresql/data
    restart: unless-stopped

  redis:
    image: redis:7-alpine
    restart: unless-stopped

volumes:
  immich_upload:
  immich_model_cache:
  postgres_data:
Configuration Options
PORTHost port(default: 2283)
DB_PASSWORDDB password
4

Launch the Containers

Start the services and tail the logs to verify startup.

terminal
# Spin up containers
docker compose up -d

# Verify deployment
docker compose ps

# Check logs for errors
docker compose logs -f
5

Open Firewall Ports

Open the required port in your firewall to allow access.

terminal
# Allow the application port through firewall
sudo ufw allow 2283/tcp
sudo ufw reload

# Access your app at:
# http://your-server-ip:2283
Skip the Terminal

Want the easy way? Try Server Compass.

No terminal needed. Deploy Immich through a visual dashboard with automatic configuration.

  • Visual config editor
  • Instant deployment
  • Automatic HTTPS
  • Smooth updates
  • Live monitoring
  • Quick rollbacks
Download Server Compass$29 one-time • Lifetime license

Immich FAQ

Common questions about self-hosting Immich

How do I deploy Immich with Server Compass?

Simply download Server Compass, connect to your VPS, and select Immich from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.

What are the system requirements for Immich?

Immich requires a minimum of 4096MB RAM. We recommend a VPS with at least 8192MB RAM for optimal performance. Any modern Linux server with Docker support will work.

Can I migrate my existing Immich data?

Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard Immich backup and restore procedures.

How do I update Immich to the latest version?

Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest Immich image will be pulled and deployed with zero downtime.

Is Immich free to self-host?

Immich is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.

Ready to Self-Host Immich?

Download Server Compass and deploy Immich to your VPS in under 3 minutes. No Docker expertise required.

Download Server Compass