Back to all templates
Habitica logo

Habitica

Application1024MB+ RAM

Gamified habit tracker and to-do list — level up your real life

applicationautomationhabiticaopen-sourceself-hosteddocker

Deploy Habitica in 3 Steps

1

Connect Your VPS

Add your server credentials to Server Compass

2

Select Habitica

Choose from our template library

3

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required
Step-by-step deployment guide

Deploy Habitica on a VPS with Server Compass

Use the Habitica template in Server Compass to deploy a self-hosted gamified habit tracker on your VPS, then verify the signup/login page.

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 Habitica 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 Habitica

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

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

Select the Habitica template

Choose the Habitica template. Server Compass fills the Habitica server service, MongoDB dependency, public base URL, admin email, and web port.

Habitica template selected in Server Compass
5
Step 5

Review the Habitica settings

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

Reviewing Habitica project settings and compose service
6
Step 6

Deploy Habitica

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

Reviewing Habitica 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 Habitica image, starts the container, and verifies the stack.

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

Confirm Habitica is running

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

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

Open Habitica in the browser

Open the application URL in a browser. The Habitica signup/login page confirms the gamified habit tracker is reachable and ready for first-run setup.

The deployed Habitica web UI loaded in a browser

After Habitica Opens

  • Register with the email configured as ADMIN_EMAIL if you need admin tools later.
  • Put Habitica behind HTTPS before inviting real users.
  • Back up the MongoDB volume because it stores all users, tasks, and progress.
  • Restrict or moderate new registrations before sharing the URL publicly.
  • Keep the Habitica server image updated for Node.js and application security fixes.

Verified Result

The Habitica signup/login page loaded successfully from the deployed container.

Habitica deployment questions

What does the Habitica template deploy?

It deploys the Habitica server image with a MongoDB container and persistent mongo_data volume.

Which port did the tutorial use?

The tutorial used host port 4106, which maps to the Habitica web UI on container port 3000.

Does Habitica need setup after deployment?

Yes. Register the first account, preferably with the ADMIN_EMAIL value used during deployment, then configure habits, dailies, to-dos, and party settings.

Should this become a blog post?

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

After Deployment

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

1

Visit BASE_URL and register your account

2

Verify the email matches ADMIN_EMAIL to enable admin tools

3

Set up your daily habits and to-dos

4

Invite friends to a party for group quests

Need help? Check out our documentation for detailed guides.

Habitica FAQ

Common questions about self-hosting Habitica

How do I deploy Habitica with Server Compass?

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

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

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

How do I update Habitica to the latest version?

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

Is Habitica free to self-host?

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

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

Download Server Compass