Back to all templates
Grimoire logo

Grimoire

Application512MB+ RAM

Self-hosted bookmark manager with tags, categories, and full-text search

applicationbookmarksgrimoireopen-sourceself-hosteddocker

Deploy Grimoire in 3 Steps

1

Connect Your VPS

Add your server credentials to Server Compass

2

Select Grimoire

Choose from our template library

3

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required
Step-by-step deployment guide

Deploy Grimoire on a VPS with Server Compass

Use the Grimoire template in Server Compass to deploy a self-hosted bookmark manager on your VPS, then verify the sign-up page loads.

About 10 minutesBrowser verified
1
Step 1

Open the server Apps tab

Select the tutorial-vps 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 a Grimoire 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 Grimoire

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

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

Select the Grimoire template

Choose the Grimoire template. Server Compass fills the bookmark app service, persistent data volume, public origin, and public web port.

Grimoire template selected in Server Compass
5
Step 5

Review the Grimoire settings

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

Reviewing Grimoire project settings and compose service
6
Step 6

Deploy Grimoire

Review the generated compose settings, confirm the Grimoire web port is available, and click Deploy.

Reviewing Grimoire web port before deployment
7
Step 7

Watch the deployment progress

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

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

Confirm Grimoire is running

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

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

Open Grimoire in the browser

Open the application URL in a browser. The Grimoire sign-up page confirms the bookmark manager is reachable.

The deployed Grimoire web UI loaded in a browser

After Grimoire Opens

  • Create the first account immediately; the first signup becomes the administrator.
  • Set PUBLIC_ORIGIN to the final HTTPS URL when moving behind a domain.
  • Back up the Grimoire data volume because it stores the PocketBase database and bookmarks.
  • Disable open registration after your users have registered.
  • Create harmless test tags and categories before importing a real bookmark library.
  • Restrict access with a reverse proxy, VPN, or firewall for production use.
  • Keep the Grimoire image updated for application and dependency fixes.

Verified Result

The Grimoire web interface loaded successfully from the deployed container.

Grimoire deployment questions

What does the Grimoire template deploy?

It deploys Grimoire as a single-container bookmark manager with persistent PocketBase-backed storage.

Which port did the tutorial use?

The tutorial used host port 4229, which maps to the Grimoire web UI on container port 5173.

Does Grimoire need setup after deployment?

Sign up as the first user, create a harmless test bookmark, then disable open registration if the instance is shared.

Should this become a blog post?

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

After Deployment

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

1

Visit the URL and create your account

2

Disable open registration from admin settings

3

Install the browser extension to add bookmarks quickly

4

Create categories and tags to organize your library

5

Configure full-text search and screenshot service in settings

Need help? Check out our documentation for detailed guides.

Grimoire FAQ

Common questions about self-hosting Grimoire

How do I deploy Grimoire with Server Compass?

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

Grimoire 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 Grimoire data?

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

How do I update Grimoire to the latest version?

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

Is Grimoire free to self-host?

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

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

Download Server Compass