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
Flatnotes
Application128MB+ RAM
Flat-file note-taking app with markdown support
notesmarkdownsimple
Deploy Flatnotes in 3 Steps
1
Connect Your VPS
Add your server credentials to Server Compass
2
Select Flatnotes
Choose from our template library
3
Deploy & Configure
Fill in settings and click Deploy
No Docker knowledge required
Step-by-step deployment guide
Deploy Flatnotes on a VPS with Server Compass
Use the Flatnotes template in Server Compass to deploy a self-hosted self-hosted note-taking app with flat-file markdown storage on your VPS, then verify the Flatnotes 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 Flatnotes
Use the template picker search to find Flatnotes in the Server Compass template catalog.
4
Step 4Select the Flatnotes template
Choose the Flatnotes template. Server Compass fills the Flatnotes image, host port, generated login credentials, session secret, and persistent notes data volume.
5
Step 5Review the Flatnotes settings
Confirm the app name and compose services. In this run, the app was named flatnotes-demo and used host port 8080.
6
Step 6Deploy Flatnotes
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 Flatnotes image, starts the container, and verifies the stack.
8
Step 8Confirm Flatnotes is running
After deployment finishes, return to the Apps tab and confirm the Flatnotes app is marked Running with its application URL available.
9
Step 9Open Flatnotes in the browser
Open the application URL in a browser. The Flatnotes web UI confirms the site is reachable.
After Flatnotes Opens
- Complete the Flatnotes installer, create the administrator account, and add tracked websites before production use.
- Configure note storage and user access, HTTPS, email, and user access before production use.
- Add a domain and HTTPS before exposing the notes workspace to users.
- Back up the Flatnotes data volume before relying on it for production notes.
Flatnotes deployment questions
What does the Flatnotes template deploy?
It deploys Flatnotes with a persistent data volume for markdown notes.
Which port did the tutorial use?
The tutorial used host port 8080, which maps to the Flatnotes web server on container port 80.
Why does the guide stop at the first-run web UI?
The tutorial verifies the clean first-run web UI because real notes, users, and access settings depend on the production server.
Should this become a blog post?
No. The deployment guide should live on the Flatnotes template detail page and be linked from the reusable template deployment docs page.
Manual Deployment Guide
Manual Flatnotes Setup
For terminal enthusiasts: deploy Flatnotes manually with these simple steps.
1
Connect to Your Remote Server
Begin by establishing a secure connection to your server through the terminal.
terminal
# Access your VPS
ssh root@YOUR_SERVER_IP
# With SSH key authentication
ssh -i ~/.ssh/your-private-key root@YOUR_SERVER_IPFirst time? Ensure Docker is installed first: curl -fsSL https://get.docker.com | sh
2
Set Up Your App Folder
Create a dedicated folder for your application files.
terminal
# Create and navigate to project directory
mkdir -p ~/apps/flatnotes
cd ~/apps/flatnotes3
Set Up Docker Compose
Create the following docker-compose.yml in your project directory:
docker-compose.yml
services:
flatnotes:
image: dullage/flatnotes:latest
ports:
- "8080:8080"
environment:
- FLATNOTES_AUTH_TYPE=password
- FLATNOTES_USERNAME=admin
- FLATNOTES_PASSWORD=<your-password>
- FLATNOTES_SECRET_KEY=<your-secret-key>
volumes:
- flatnotes_data:/data
restart: unless-stopped
volumes:
flatnotes_data:
Environment Configuration
PORTHost port(default: 8080)USERNAMEUsername(default: admin)PASSWORDPasswordSECRET_KEYSecret key4
Spin Up the Stack
Run Docker Compose to launch your application.
terminal
# Launch the stack
docker compose up -d
# Verify container status
docker compose ps
# Follow the logs
docker compose logs --follow5
Open the Application Port
Configure UFW to allow traffic to your application.
terminal
# Allow the application port through firewall
sudo ufw allow 8080/tcp
sudo ufw reload
# Access your app at:
# http://your-server-ip:8080Skip the Terminal
Make it simple with Server Compass.
Deploy Flatnotes without touching the command line. Server Compass gives you a clean UI for one-click deployments.
- No terminal required
- Point-and-click setup
- Auto SSL certificates
- Rolling deployments
- Health monitoring
- Instant rollbacks
Download Server Compass$29 one-time • Lifetime license
After Deployment
After deploying Flatnotes with Server Compass, complete these steps to finish setup
1
Create your account
2
Start taking notes
Need help? Check out our documentation for detailed guides.
Flatnotes FAQ
Common questions about self-hosting Flatnotes
How do I deploy Flatnotes with Server Compass?
Simply download Server Compass, connect to your VPS, and select Flatnotes 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 Flatnotes?
Flatnotes requires a minimum of 128MB 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 Flatnotes data?
Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard Flatnotes backup and restore procedures.
How do I update Flatnotes to the latest version?
Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest Flatnotes image will be pulled and deployed with zero downtime.
Is Flatnotes free to self-host?
Flatnotes 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 Flatnotes?
Download Server Compass and deploy Flatnotes to your VPS in under 3 minutes. No Docker expertise required.
Download Server Compass