The Standard Notes syncing server
You can run your own Standard Notes server and use it with any Standard Notes app. This allows you to have 100% control of your data. This server is built with Ruby on Rails and can be deployed in minutes.
Clone the project:
git clone --branch master https://github.com/standardnotes/syncing-server.git
.envfile in the project's root directory. See .env.sample for required values.
Initialize the project:
bundle install bundle exec rails db:create db:migrate
Start the server:
bundle exec rails server
syncing-serveruses RSpec for tests.
To execute all of the test specs, run the following command at the root of the project directory:
bundle exec rspec
Code coverage report is available within the
DISABLE_USER_REGISTRATIONenvironment variable to
Docker is the quick and easy way to try out Standard Notes. We highly recommend using our official Docker hub image.
Before you start make sure you have a
.envfile copied from the sample
.env.sampleand configured with your parameters.
If your intention is not contributing but just running the app we recommend using our official image from Docker hub like this:
docker run -d -p 3000:3000 --env-file=your-env-file standardnotes/syncing-server
Or if you want to use the
developbranch that is in a work-in-progress state please use:
docker run -d -p 3000:3000 --env-file=your-env-file standardnotes/syncing-server:dev
You can then access the server via the Desktop application by setting the Sync Server Domain (Under Advanced Options) to
You can deploy your own Standard Notes server with one click on Heroku:
You can run your own Standard Notes server on a Raspberry Pi using
sudo apt install -y libffi-dev libssl-dev
sudo apt install -y python3 python3-pip
sudo pip3 install docker-compose
.envfile and run:
docker-compose -f docker-compose.yml -f docker-compose.raspberry-pi.yml up -d
Tested on a *Raspberry Pi 4 Model B***
For contributing we highly recommend you use our docker-compose setup that is provided in this repository.
Use the included docker-compose.yml file to build Standard Notes with
docker-compose. Once your
.envfile has been copied and configured, simply run:
docker-compose up -d
This should load the syncing-server and MySQL database containers and run the necessary migrations. You should then be able to reach the server at
http://localhost:[EXPOSED_PORT]. For example, if inside of my
.envfile I set "EXPOSED_PORT=7459" I could reach the syncing-server via
To stop the server,
cdinto this directory again and run
Your MySQL Data will be written to your local disk in the
datafolder to keep it persistent between container runs.