Standard File server. Used for running your own Standard Notes server | https://standardnotes.org
Switch branches/tags
Clone or download
mobitar Merge pull request #80 from Ricks-ha/master
Update for Docker environment
Latest commit 34b1063 Dec 12, 2018

README.md

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.

Getting started

Requirements

  • Ruby 2.2+
  • Rails 5
  • MySQL 5.6+ database

Instructions

  1. Clone the project:

    git clone https://github.com/standardfile/ruby-server.git
    
  2. Create a .env file in the project's root directory. Add environment variables (see Environment variables for full listing):

    DB_HOST=localhost
    ...
    
  3. Initialize project:

    bundle install
    bower install
    rails db:create db:migrate
    
  4. Start the server:

    rails s
    

Deploying to a live server

You can find instructions on deploying an SN server from scratch here:

Deploying a Standard File server with Amazon EC2 and Nginx

Using Docker

To deploy to a live server using Docker and Docker-Compose, see:

Deploying a private Standard File server using Docker

Environment variables

SECRET_KEY_BASE

Rails secret key used only in production environment

RAILS_ENV

Rails environment, set it to production on production server.

DB_HOST

Database host.

DB_PORT

Database port. 3306 is standard.

DB_DATABASE

Database name.

DB_USERNAME

Database username.

DB_PASSWORD

Database password.

Contributing

Contributions are encouraged and welcome. Currently outstanding items:

  • Test suite

License

Licensed under the GNU AGPLv3: https://www.gnu.org/licenses/agpl-3.0.html