1
Step 1Open 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.
Back to all templates
Linkwarden
Application512MB+ RAM
Collaborative bookmark manager for collecting, organizing, and preserving web content
bookmarkslinksarchivingcollaboration
Deploy Linkwarden in 3 Steps
1
Connect Your VPS
Add your server credentials to Server Compass
2
Select Linkwarden
Choose from our template library
3
Deploy & Configure
Fill in settings and click Deploy
No Docker knowledge required
Step-by-step deployment guide
Deploy Linkwarden on a VPS with Server Compass
Use the Linkwarden template in Server Compass to deploy a self-hosted collaborative bookmark management stack with PostgreSQL and Meilisearch on your VPS, then verify the Linkwarden web UI in a browser.
About 7 minutesBrowser verified
2
Step 2Choose an app template
Click New App and choose the template deployment path so Server Compass can load the built-in catalog.
3
Step 3Search for Linkwarden
Use the template picker search to find Linkwarden in the Server Compass template catalog.
4
Step 4Select the Linkwarden template
Choose the Linkwarden template. Server Compass fills the Linkwarden image, host port, generated secrets, PostgreSQL, Meilisearch, and persistent bookmark data volumes.
5
Step 5Review the Linkwarden settings
Confirm the app name and compose services. In this run, the app was named linkwarden-demo and used host port 3000.
6
Step 6Deploy Linkwarden
Review the generated environment values, confirm the port is available, and click Deploy Now.
7
Step 7Watch the deployment progress
Keep the deployment modal open while Server Compass uploads the compose file, pulls the Linkwarden image, starts the container, and verifies the stack.
8
Step 8Confirm Linkwarden is running
After deployment finishes, return to the Apps tab and confirm the Linkwarden app is marked Running with its application URL available.
9
Step 9Open Linkwarden in the browser
Open the application URL in a browser. The Linkwarden web UI confirms the site is reachable.
After Linkwarden Opens
- Create the first Linkwarden user before production use.
- Configure bookmark preservation, browser extensions, HTTPS, email, and user access before production use.
- Add a domain and HTTPS before exposing the bookmark dashboard to users.
- Back up the Linkwarden PostgreSQL, Meilisearch, and bookmark data volumes before relying on it for production bookmarks.
Linkwarden deployment questions
What does the Linkwarden template deploy?
It deploys Linkwarden with PostgreSQL and Meilisearch backing services plus persistent database volumes.
Which port did the tutorial use?
The tutorial used host port 3000, which maps to the Linkwarden web server on container port 3000.
Why does the guide stop at the first-run web UI?
The tutorial verifies the clean first-run web UI because real bookmarks, users, browser extensions, and access rules depend on the production server.
Should this become a blog post?
No. The deployment guide should live on the Linkwarden template detail page and be linked from the reusable template deployment docs page.
CLI Deployment
Deploy Linkwarden Yourself
Want full control? Here's how to deploy Linkwarden yourself using Docker Compose.
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-ipFirst 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/linkwarden
cd ~/apps/linkwarden3
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 passwordNEXTAUTH_SECRETSession secretMEILI_KEYSearch key4
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 -f5
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:3000Skip 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
1
Open the Linkwarden URL in your browser
2
Create your account
3
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.
Ready to Self-Host Linkwarden?
Download Server Compass and deploy Linkwarden to your VPS in under 3 minutes. No Docker expertise required.
Download Server Compass