Skip to content

Latest commit

 

History

History
104 lines (61 loc) · 2.74 KB

INSTALL.md

File metadata and controls

104 lines (61 loc) · 2.74 KB
Raw

Development Setup

Basically, to get started you need git, ruby (>= 2.4) and bundler and follow these steps:

  1. Install nodejs:

frab needs a javascript runtime. You should use nodejs, as it is easier to install than v8.

apt-get install nodejs
  1. Install Imagemagick and file:

These are dependencies of the paperclip gem. Imagemagick tools need to be installed to identify and resize images.

Imagemagick and file should be easy to install using your OS's preferred package manager (apt-get, yum, brew etc.).

  1. Clone the repository

    git clone git://github.com/frab/frab.git

  2. cd into the directory:

    cd frab

  3. Modify settings:

Settings are defined via environment variables. frab uses dotenv files to set these variables. The variables for development mode are set in .env.development. You can also use .env.local for local overrides.

  1. Run setup

    bin/setup

  2. Start the server

To start frab in the development environment simply run

rails server

Navigate to http://localhost:3000/ and login as "admin@example.org" with password "test123".

Vagrant Server

frab can more easily be tested by using vagrant with chef recipes taking care of the installation process. More information can be found in these github projects:

Docker

See Docker Readme

Production Deployment

  1. Installing database drivers

Instead of running bin/setup you need to run bundle install manually, so you can choose your database gems. To avoid installing database drivers you don't want to use, exclude drivers with

bundle install --without="postgresql mysql"

  1. Create (and possibly modify) the database configuration:

    cp config/database.yml.template config/database.yml

  2. Configuration

In Production make sure the config variables are set, copy and edit the file env.example to .env.production.

  1. Precompile assets

    rake assets:precompile

  2. Security considerations

If you are running frab in a production environment you have to take additional steps to build a secure and stable site.

  • Change the password of the initial admin account
  • Change the initial secret token
  • Add a content disposition header, so attachments get downloaded and are not displayed in the browser. See ./public/system/attachments/.htaccess for an example.
  • Add a gem like exception_notification to get emails in case of errors.
  1. Start the server

To start frab in the production environment run

RACK_ENV=production bundle rails s

Note that when seeding the database in production mode, the password for admin@example.org will be a random one. It will be printed to the console in when rake db:seed is invoked.