Standard Notes is an open-source note-taking app that protects your data with verified end-to-end encryption. Only you control the decryption keys. It seamlessly syncs your encrypted notes and files across unlimited devices, keeps them available offline, and actively protects your content from external access.
Thinking about self-hosting this service? We guide you step-by-step through the setup and configuration and show you everything you need to consider.
Before installing Standard Notes, make sure your hosting environment meets the following requirements to ensure smooth installation and optimal performance.
| Hardware | Minimum | ZAP Hosting Recommendation |
|---|---|---|
| CPU | 1 vCPU core | 4 vCPU cores |
| RAM | 2 GB | 4 GB |
| Storage | 5 GB | 25 GB |
The software requires all necessary dependencies to be installed and to run on a supported operating system. Verify that your server meets the following requirements before starting the installation:
Dependencies: Docker (Engine 26+ and Compose)
Operating System: Latest version of Ubuntu/Debian with Docker 26+ support
Ensure all dependencies are installed and the correct OS version is used to avoid compatibility issues when installing Standard Notes.
Before setting up Standard Notes, you need to prepare your system. This includes updating your operating system and installing all required dependencies. This preparation ensures a stable environment and helps prevent issues during or after installation.
To run your system with the latest software and security updates, first perform an update by running:
sudo apt update && sudo apt upgrade -y
This ensures your system has the latest security patches and software versions before installation.
After the update completes, you can start installing dependencies. Standard Notes runs on your server using multiple Docker containers. Docker must be installed first. Run the following commands:
curl -fsSL https://get.docker.com -o get-docker.sh
sh get-docker.sh
A detailed guide on installing and using Docker is available in our Docker tutorial.
Once all requirements are met and preparations are complete, you can start installing Standard Notes.
First, create a folder to hold all configuration and setup files. This folder will be your working directory for the installation.
mkdir standardnotes
cd standardnotes
Next, create a .env file in your working directory and fill it with the default values from the project's sample configuration:
touch .env
curl https://raw.githubusercontent.com/standardnotes/server/main/.env.sample > .env
This file contains only the minimally required variables for a functional setup. The full list of currently used variables can be found here: docker-entrypoint.sh
Open the .env file and ensure all keys in the KEYS section are set correctly. Generate random values for each required environment variable with:
openssl rand -hex 32
Insert these values into your .env file. Standard Notes requires a bootstrap script for LocalStack. Download it to your working directory and make it executable:
curl https://raw.githubusercontent.com/standardnotes/server/main/docker/localstack_bootstrap.sh > localstack_bootstrap.sh
chmod +x localstack_bootstrap.sh
Download the official sample configuration and save it as docker-compose.yml in your working folder. This file defines all container services needed for Standard Notes.
curl https://raw.githubusercontent.com/standardnotes/server/main/docker-compose.example.yml > docker-compose.yml
When everything is ready, pull the latest images and start the services in the background:
docker compose pull && docker compose up -d
You can customize the default configuration in the provided docker-compose.yml file to fit your individual needs. An important area is the server service, where you can change port mappings in the ports property. This determines which host ports the application will be accessible through—helping avoid conflicts with other services or adapting your network setup.
Securing the database is another crucial step. Replace default passwords with strong, randomly generated strings. You can create a secure password like this:
openssl rand -hex 12
Add the generated value as DB_PASSWORD in the .env file. The same value must also be set for MYSQL_ROOT_PASSWORD and MYSQL_PASSWORD in the docker-compose.yml to keep the containers synchronized.
These configuration changes ensure your installation not only works but is also secure and tailored to your environment.
To set up your account in Standard Notes, click the avatar icon at the bottom right of the app. In the menu that appears, select “Create Account” to create a new user profile. Enter a valid email address and a secure password.
Before completing the process, open the “Advanced Options” section. Under “Sync Server,” select the “Custom” option and enter your own server’s IP address and port in the format IP:Port. This way, your notes will sync not via the official Standard Notes service but through your self-hosted server.
Congratulations! You have successfully installed and configured Standard Notes on your VPS/Dedicated Server. We also recommend checking out the following resources to help with server configuration:
- Standardnotes.com – Official website
- Standardnotes.com/help – Standard Notes Help Center (Documentation)
Do you have specific questions not answered here? Our team is available daily for further questions or support—just get in touch! 🙂