This is a production-ready reference implementation of the Standard File protocol.
A production client is available at https://app.standardnotes.org
You can run your own Standard File server, and use it with any SF compatible client (like Standard Notes). This allows you to have 100% control of your data. This server implementation is built with Ruby on Rails and can be deployed in minutes.
Requirements
- Ruby 2.2+
- Rails 5
- MySQL database
Instructions
-
Clone the project:
git clone https://github.com/standardnotes/ruby-server.git
-
Create a .env file in the project's root directory. Add environment variables (see Environment variables for full listing):
DB_HOST=localhost ...
-
Initialize project:
bundle install rails db:migrate
-
Start the server:
rails s
You can find instructions on deploying an SN server from scratch here:
Deploying a Standard Notes server with Amazon EC2 and Nginx
NOTE_CONTENT_EK
A 256 bit key for encrypting a note's content.
Digest::SHA256.hexdigest(SecureRandom.random_bytes(32))
DB_HOST
Database host.
DB_PORT
Database port. 3306 is standard.
DB_DATABASE
Database name.
DB_USERNAME
Database username.
DB_PASSWORD
Database password.
Contributions are encouraged and welcome. Currently outstanding items:
- Test suite
Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html