Standard File Server, Ruby Implementation
This is a production-ready reference implementation of the Standard File protocol.
A production client is available at https://app.standardnotes.org
Running your own server
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.
- Ruby 2.2+
- Rails 5
- MySQL 5.6+ database
Clone the project:
git clone https://github.com/standardfile/ruby-server.git
Create a .env file in the project's root directory. Add environment variables (see Environment variables for full listing):
bundle install bower install rails db:create db:migrate
Start the server:
Deploying to a live server
You can find instructions on deploying an SN server from scratch here:
To deploy to a live server using Docker and Docker-Compose, see:
Rails secret key used only in production environment
Rails environment, set it to
production on production server.
Database port. 3306 is standard.
Contributions are encouraged and welcome. Currently outstanding items:
- Test suite
Licensed under the GNU AGPLv3: https://www.gnu.org/licenses/agpl-3.0.html