Linkwarden

Application512MB+ RAM

Collaborative bookmark manager for collecting, organizing, and preserving web content

Download Server Compass View Documentation

bookmarkslinksarchivingcollaboration

Deploy Linkwarden in 3 Steps

Connect Your VPS

Add your server credentials to Server Compass

Select Linkwarden

Choose from our template library

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required

CLI Deployment

Deploy Linkwarden Yourself

Want full control? Here's how to deploy Linkwarden yourself using Docker Compose.

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

Create the App Directory

Organize your deployment by creating a dedicated project folder.

terminal

# Create and navigate to project directory
mkdir -p ~/apps/linkwarden
cd ~/apps/linkwarden

Write Your docker-compose.yml

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

docker-compose.yml

services:
  linkwarden:
    image: ghcr.io/linkwarden/linkwarden:latest
    ports:
      - "3000:3000"
    environment:
      - DATABASE_URL=postgresql://postgres:<your-db-password>@postgres:5432/linkwarden
      - NEXTAUTH_SECRET=<your-nextauth-secret>
      - NEXTAUTH_URL=http://localhost:3000
      - MEILI_ADDR=http://meilisearch:7700
      - MEILI_MASTER_KEY=<your-meili-key>
    volumes:
      - linkwarden_data:/data/data
    restart: unless-stopped
    depends_on:
      postgres:
        condition: service_healthy
      meilisearch:
        condition: service_started

  postgres:
    image: postgres:16-alpine
    environment:
      - POSTGRES_PASSWORD=<your-db-password>
      - POSTGRES_DB=linkwarden
    volumes:
      - linkwarden_db:/var/lib/postgresql/data
    restart: unless-stopped
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U postgres -d linkwarden"]
      interval: 10s
      timeout: 5s
      retries: 5
      start_period: 30s

  meilisearch:
    image: getmeili/meilisearch:v1.12.8
    environment:
      - MEILI_MASTER_KEY=<your-meili-key>
    volumes:
      - linkwarden_meili:/meili_data
    restart: unless-stopped

volumes:
  linkwarden_data:
  linkwarden_db:
  linkwarden_meili:

Required Settings

PORTHost port to expose(default: 3000)

DB_PASSWORDDatabase password

NEXTAUTH_SECRETSession secret

MEILI_KEYSearch key

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

Open Firewall Ports

Open the required port in your firewall to allow access.

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

Want the easy way? Try Server Compass.

Skip the terminal and deploy Linkwarden with a visual interface. Configure everything with clicks, not commands.

Visual config editor
Instant deployment
Automatic HTTPS
Smooth updates
Live monitoring
Quick rollbacks

Download Server Compass$29 one-time • Lifetime license

After Deployment

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

Open the Linkwarden URL in your browser

Create your account

Start saving and organizing bookmarks

Need help? Check out our documentation for detailed guides.

Linkwarden FAQ

Common questions about self-hosting Linkwarden

How do I deploy Linkwarden with Server Compass?

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

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

Can I migrate my existing Linkwarden data?

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

How do I update Linkwarden to the latest version?

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

Is Linkwarden free to self-host?

Linkwarden 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.