Back to all templates
Obsidian logo

Obsidian

Application1024MB+ RAM

Note-taking app accessible via web browser with vault sync

notesmarkdownknowledge-management

Deploy Obsidian in 3 Steps

1

Connect Your VPS

Add your server credentials to Server Compass

2

Select Obsidian

Choose from our template library

3

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required
Step-by-step deployment guide

Deploy Obsidian on a VPS with Server Compass

Use the Obsidian template in Server Compass to deploy the LinuxServer browser-accessible Obsidian desktop session on your VPS, then verify the web interface in a browser.

About 6 minutesBrowser verified
1
Step 1

Open the server Apps tab

Select your VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.

Server Compass Apps tab before creating an Obsidian 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 Obsidian

Use the template picker search to find Obsidian in the Server Compass template catalog.

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

Select the Obsidian template

Choose the Obsidian template. Server Compass fills the LinuxServer Obsidian container, persistent config volume, timezone setting, and browser-accessible HTTPS host port.

Obsidian template selected in Server Compass
5
Step 5

Review the Obsidian settings

Confirm the app name and compose service. In this run, the app was named obsidian-demo and used host port 4172.

Reviewing Obsidian project settings and compose service
6
Step 6

Deploy Obsidian

Review the generated timezone value, confirm the HTTPS port is available, and click Deploy Now.

Reviewing Obsidian timezone and port before deployment
7
Step 7

Watch the deployment progress

Keep the deployment modal open while Server Compass uploads the compose file, pulls the Obsidian image, starts the container, and verifies the stack.

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

Confirm Obsidian is running

After deployment finishes, return to the Apps tab and confirm the Obsidian app is marked Running with its application URL available.

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

Open Obsidian in the browser

Open the HTTPS application URL in a browser. For direct IP testing, accept the self-signed certificate warning. The LinuxServer/Selkies web interface confirms the Obsidian desktop session is reachable.

The deployed Obsidian browser desktop session loaded in a browser

After Obsidian Opens

  • Create or open an Obsidian vault after the browser desktop session finishes loading.
  • Replace the self-signed certificate with a trusted HTTPS reverse proxy and access control before exposing this interactive desktop session beyond trusted users.
  • Back up the obsidian_config volume regularly because it stores the application state and vault data.
  • Consider attaching durable external storage before using this deployment for long-term notes.

Verified Result

The LinuxServer/Selkies web interface loaded successfully in a browser.

Obsidian deployment questions

What does the Obsidian template deploy?

It deploys the LinuxServer Obsidian container with a persistent config volume and the Selkies browser interface mapped to a host HTTPS port.

Which port did the tutorial use?

The tutorial used host port 4172, which maps to the Obsidian HTTPS web interface on container port 3001.

Why does the guide stop at the browser desktop session?

The tutorial verifies that the hosted Obsidian session is reachable. Vault creation, sync choices, and plugins depend on how the production notes workspace should be managed.

Should this become a blog post?

No. The deployment guide should live on the Obsidian template detail page and be linked from the reusable template deployment docs page.

Command Line Setup

Install Obsidian Manually

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

1

Access Your VPS Terminal

Use your terminal to securely access your server. You'll need your server's IP address.

terminal
# Connect via SSH
ssh root@your-vps-ip

# Alternative with key file
ssh -i /path/to/key root@your-vps-ip

First time? Make sure Docker is installed on your VPS. Run: curl -fsSL https://get.docker.com | sh

2

Set Up the Deployment Folder

Initialize a project folder on your server.

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

Set Up the Stack Definition

Use this Docker Compose configuration for your deployment:

docker-compose.yml
services:
  obsidian:
    image: lscr.io/linuxserver/obsidian:latest
    security_opt:
      - seccomp:unconfined
    ports:
      - "3000:3000"
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
    volumes:
      - obsidian_config:/config
    shm_size: "1gb"
    restart: unless-stopped

volumes:
  obsidian_config:
Configuration Options
PORTHTTP port to expose(default: 3000)
TIMEZONEServer timezone(default: UTC)
4

Start the Containers

Bring up your containers in detached mode.

terminal
# Start all services
docker compose up -d

# List running containers
docker compose ps

# Watch the logs
docker compose logs -f
5

Set Up Firewall Rules

Allow the application port through your server's firewall.

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

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

Let Server Compass do the heavy lifting.

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

  • Beautiful interface
  • One-click deploys
  • Let's Encrypt SSL
  • Zero downtime
  • Container monitoring
  • Easy rollbacks
Download Server Compass$29 one-time • Lifetime license

After Deployment

After deploying Obsidian with Server Compass, complete these steps to finish setup

1

Access Obsidian via HTTPS

2

Create or open a vault

Need help? Check out our documentation for detailed guides.

Obsidian FAQ

Common questions about self-hosting Obsidian

How do I deploy Obsidian with Server Compass?

Simply download Server Compass, connect to your VPS, and select Obsidian 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 Obsidian?

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

Can I migrate my existing Obsidian data?

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

How do I update Obsidian to the latest version?

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

Is Obsidian free to self-host?

Obsidian 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 Obsidian?

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

Download Server Compass