Flatnotes

Application128MB+ RAM

Flat-file note-taking app with markdown support

Download Server Compass View Documentation

notesmarkdownsimple

Deploy Flatnotes in 3 Steps

Connect Your VPS

Add your server credentials to Server Compass

Select Flatnotes

Choose from our template library

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required

Manual Deployment Guide

Manual Flatnotes Setup

For terminal enthusiasts: deploy Flatnotes manually with these simple steps.

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_IP

First time? Ensure Docker is installed first: curl -fsSL https://get.docker.com | sh

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/flatnotes

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)

PASSWORDPassword

SECRET_KEYSecret key

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

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:8080

Skip 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

Create your account

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.