Setup guide

Build & run

For instructions on how to build & run SciNote - including minimal quick-start setup - visit Build & run section.

Environmental variables

SciNote is configured using environmental variables. To see list of available variables, and a minimal application.yml file, visit Environmental variables section.

Production mode (in Docker containers)

To run SciNote in production mode (in Docker containers), visit the Production mode section.

Rake/rails tasks

SciNote server uses rake/rails tasks for various operations. For details regarding rake/rails tasks, when to run them and how to set them up, visit the Rake/rails tasks section.

Mailer

SciNote needs a configured SMTP mail server to work properly. See environmental variables for configuration of the mailer.

Office Online integration

SciNote can be integrated with an Office Online Server to enable viewing and edition of documents directly in the browser. To enable this integration using the Microsoft Office Online servers, you will need to join the Office Cloud Storage Partner Program and set up the WOPI_* environment variables.

Deploy onto Heroku

Before deploying to Heroku, install heroku client as describe on offical website. To use existing heroku application, add new git remote repository.

git remote add heroku [email protected]:my-random-app-name.git

Or create new heroku application by executing following command.

heroku create

Add additional heroku buildpacks in the same order as specified in .buildpacks:

heroku buildpacks:add --index <i> <buildpack>

e.g. for adding graphviz write:

heroku buildpacks:add --index 2 https://github.com/weibeld/heroku-buildpack-graphviz.git

Before pushing to heroku master branch, some environmental variables should be set.

Heroku environmental variables

For deployment of SciNote onto Heroku, additional environmental variables need to be specified.

Variable	Mandatory	Description
LANG	Yes	The default localization language (e.g. en_US.UTF-8).
RAILS_ENV	Yes	Rails environment: production, test or development.
RACK_ENV	Yes	Rack environment: production, test or development.
RAILS_SERVE_STATIC_FILES	Yes	Whether to serve static files. Must be set to enabled.
WEB_CONCURRENCY	Yes	The concurrency of the server. See Heroku specifications for details.
MAX_THREADS	Yes	The max. number of threads. See Heroku specifications for details.
PORT	Yes	The port on which the application should run. See Heroku specifications for details.
RAILS_FORCE_SSL	Yes	If set to 1, enforce SSL communication on all levels of application.
DATABASE_URL	Yes	Full URL for connecting to PostgreSQL database.

Testing

In current version, only model tests are implemented for SciNote. To execute them, call rails test:models.