1
Step 1Open 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.
Back to all templates
CodiMD
Application512MB+ RAM
Real-time collaborative markdown editor (HedgeDoc-compatible)
applicationdocscodimdopen-sourceself-hosteddocker
Deploy CodiMD in 3 Steps
1
Connect Your VPS
Add your server credentials to Server Compass
2
Select CodiMD
Choose from our template library
3
Deploy & Configure
Fill in settings and click Deploy
No Docker knowledge required
Step-by-step deployment guide
Deploy CodiMD on a VPS with Server Compass
Use the CodiMD template in Server Compass to deploy a self-hosted collaborative markdown editor web UI on your VPS, then verify the setup screen.
About 10 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 CodiMD
Use the template picker search to find CodiMD in the Server Compass template catalog.
4
Step 4Select the CodiMD template
Choose the CodiMD template. Server Compass fills the CodiMD web service, PostgreSQL database, upload volume, generated session secret, and public web port.
5
Step 5Review the CodiMD settings
Confirm the app name and compose service. In this run, the app was named codimd-demo and used host port 4051.
6
Step 6Deploy CodiMD
Review the generated compose settings, confirm the CodiMD web port is available, and click Deploy.
7
Step 7Watch the deployment progress
Keep the deployment modal open while Server Compass uploads the compose file, pulls the CodiMD image, starts the container, and verifies the stack.
8
Step 8Confirm CodiMD is running
After deployment finishes, return to the Apps tab and confirm the CodiMD app is marked Running with its application URL available.
9
Step 9Open CodiMD in the browser
Open the application URL in a browser. The CodiMD setup or main page confirms the collaborative markdown editor web UI is reachable.
After CodiMD Opens
- Place CodiMD behind HTTPS before storing or sharing real files.
- Change the generated admin password immediately after first login.
- Disable anonymous editing before using CodiMD for private production notes.
- Back up the CodiMD config volume because it stores provider settings and the database.
- Put CodiMD behind HTTPS before sharing note links.
- Create a small test note before migrating real team notes.
- Keep the CodiMD image updated for dependency and security fixes.
Verified Result
The CodiMD web interface loaded successfully from the deployed container.
CodiMD deployment questions
What does the CodiMD template deploy?
It deploys the CodiMD collaborative markdown editor web UI with PostgreSQL database and persistent upload volume.
Which port did the tutorial use?
The tutorial used host port 4051, which maps to the CodiMD web UI on container port 3000.
Does CodiMD need setup after deployment?
Yes. Register the first account or configure anonymous note editing according to your team policy.
Should this become a blog post?
No. The deployment guide should live on the CodiMD template detail page and be linked from the reusable template deployment docs page.
After Deployment
After deploying CodiMD with Server Compass, complete these steps to finish setup
1
Visit the application URL
2
Register an account or sign in anonymously
3
Create your first markdown note
4
Share notes via the URL or set per-note permissions
Need help? Check out our documentation for detailed guides.
CodiMD FAQ
Common questions about self-hosting CodiMD
How do I deploy CodiMD with Server Compass?
Simply download Server Compass, connect to your VPS, and select CodiMD 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 CodiMD?
CodiMD 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 CodiMD data?
Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard CodiMD backup and restore procedures.
How do I update CodiMD to the latest version?
Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest CodiMD image will be pulled and deployed with zero downtime.
Is CodiMD free to self-host?
CodiMD 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 CodiMD?
Download Server Compass and deploy CodiMD to your VPS in under 3 minutes. No Docker expertise required.
Download Server Compass