Redmine

Sassafras fork of Redmine: a flexible project management web application written using Ruby on Rails framework.

More details can be found in the doc directory or on the official website here.

Upstream changelog is here.

Development

Local setup

Official, detailed instructions can be found in the INSTALL file. However, most of what you need for Sassafras should be here.

Official upgrade steps between major versions are documented here.

Multiple environments (e.g. production/development) are NOT well supported. It's recommended to do this setup using production only.

1. Install mysql:

   # For OSX (homebrew)
   brew install [email protected]
   brew link --force [email protected]
   sudo chown -R _mysql:mysql /usr/local/var/mysql
   sudo mysql.server restart

2. Create db: mysql -u root -e "create database redmine;"

3. Copy config files:

   cp config/database.yml{.example,}
   cp config/configuration.yml{.example,}
   cp config/additional_environment.rb{.example,}

4. Edit config/database.yml if needed; should be fine by default

5. Install bundler: gem install bundler

6. Install dependencies: bundle install --without rmagick

   • To fix mysql2 on mac: gem install mysql2 -v '~> 0.5.6' -- --with-ldflags=-L/usr/local/opt/openssl/lib --with-cppflags=-I/usr/local/opt/openssl/include
   • You can try brew install imagemagick@6 if you want rmagick

7. You may need to install a missing dependency if it asks: gem install net-ldap

8. Do some initialization:

   rails generate_secret_token
   RAILS_ENV=production rails db:migrate
   RAILS_ENV=production rails redmine:plugins:migrate

9. Configure access:

   # Probably unnecessary
   # sudo chown -R redmine:redmine files log tmp public/plugin_assets
   
   # Maybe unnecessary
   sudo chmod -R 755 files log tmp public/plugin_assets

10. Verify it works:

    • rails s -e production
    • Open http://localhost:3000/
    • Sign in with credentials admin/admin

11. Load the defaults via http://localhost:3000/admin

Local dev

1. Watch for changes with bundle exec rerun --dir app,config,plugins,public rails s -- -e production
   • Note: if you try to refresh the page before it's ready you'll break things and see Cannot GET /route; simply restart the server in this case (hotkey: r)

Copying data

If you want to mirror the live database, download a dump and then:

1. mysql -u root redmine < dump.sql

Plugin development

See Redmine tutorial for more info.

1. Put any plugins in the plugins/ directory, e.g. for GreenMachine:

   cd plugins
   git clone [email protected]:sassafrastech/greenmachine.git

2. Install new dependencies as usual (from project root, not plugins root): bundle install

3. Restart the server for plugins to take effect

For GreenMachine specifically, docs are here.

Themes

1. Put any themes in the public/themes/ directory, e.g. for Sassafras:

   cd public/themes
   git clone https://github.com/sassafrastech/redmine-circle-theme.git sassafras

2. Restart the server for themes to be available

For the Sassasfras theme specifically, docs are here.

Production

Deploying

1. Push any changes
2. git pull changes manually for any plugins/themes
3. bundle exec cap production deploy
   1. Choose a branch (enter to select default)