Standard Notes Syncing Server
Running your own 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.
- Ruby 2.3+
- Rails 5
- MySQL 5.6+ database
Clone the project:
git clone https://github.com/standardnotes/syncing-server.git
Create a .env file in the project's root directory. See env.sample for required values.
bundle install rails db:create db:migrate
Start the server:
Docker is the quick and easy way to try out Standard Notes. With two commands you'll be up and running.
Dockerfile is enough to get you up and running. Once Docker is installed on your system simply run the following commands to get up and running in Development Mode.
$ docker build -t syncing-server . $ docker run -d \ -p 3000:3000 \ --name my-syncing-server \ syncing-server
You can then access the server via the Desktop application by setting the Sync Server Domain (Under Advanced Options) to
Note: This standalone setup is designed for Development use only. Please use the
docker-compose method for production instances.
Use the included
docker-compose.yml file to build Standard Notes with docker-compose. Once your
.env file 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
.env file I set "EXPOSED_PORT=7459" I could reach the syncing-server via
To stop the server,
cd into this directory again and run
Your MySQL Data will be written to your local disk at
/var/lib/mysql - Be sure to back this up in a production instance.