Skip to content

Latest commit

 

History

History
273 lines (206 loc) · 5.01 KB

README.md

File metadata and controls

273 lines (206 loc) · 5.01 KB
Raw

Redmine::Installer

Installation

Add this line to your application's Gemfile:

gem 'redmine-installer'

And then execute:

$ bundle

Or install it yourself as:

$ gem install redmine-installer

Usage

redmine GLOBAL_ARGUMENTS ACTION ARGUMENTS

Global arguments

arguments default value description
--verbose / -v false show verbosed output
--locale / -l en languages for application

Shortcut

Some commands have defined shortcut for quicker access. Fox example:

redmine install package

# is equal as

redmine i package

Commands shortcut.

i -> install
u -> upgrade
b -> backup

Common arguments

arguments default description
--environment / --env / -e production environment for redmine

Instalation

You can instal redmine package from archive or git.

Steps:

  • 1. Redmine root - where should be new redmine located
  • 2. Load package - extract package
  • 3. Database configuration - you can choose type of DB which you want to use
  • 4. Email sending configuration - email sending configuration
  • 5. Install - install commands are executed
  • 6. Moving redmine - redmine is moved from temporarily folder to given redmine_root
  • 7. Webserve configuration - generating webserver configuration

From archive

Supported archives are .zip and .tar.gz.

# minimal
redmine install PATH_TO_PACKAGE

# full
redmine install PATH_TO_PACKAGE --env ENV1,ENV2,ENV3

From git

# minimal
redmine install GIT_REPO --source git

# full
redmine install GIT_REPO --source git --branch GIT_BRANCH --env ENV1,ENV2,ENV3
Arguments
argumnest default description
--branch / -b master branch of git defined by GIT_REPO

Upgrade

You can upgrade current redmine by archive or currently defined git repository. If your redmine contain plugins which are not part of new package - all these plugins will be kept otherwise are replaced with those from package.

Final step will ask you if you want save steps configuration. If you say YES, configuration will be stored as profile so next time you can upgrade redmine faster.

redmine upgrade PACKAGE --profile PROFILE_ID

Profiles are stored on HOME_FOLDER/.redmine-installer-profiles.yml.

Steps:

  • 1. Redmine root - where should be new redmine located
  • 2. Load package - extract package
  • 3. Validation - current redmine should be valid
  • 4. Backup - backup current redmine (see backup section)
  • 5. Upgrading - install commands are executed
  • 6. Moving redmine - redmine is moved from temporarily folder to given redmine_root
  • 7. Profile saving - generating profile (see profile section)

From archive

# minimal
redmine upgrade PATH_TO_PACKAGE

# full
redmine upgrade PATH_TO_PACKAGE --env ENV1,ENV2,ENV3

From git

# minimal
redmine upgrade --source git

# full
redmine upgrade --source git --env ENV1,ENV2,ENV3

Backup

redmine backup

Steps:

  • 1. Redmine root - where should be new redmine located
  • 2. Validation - current redmine should be valid
  • 3. Backup - backup current redmine (see backup section)
  • 4. Profile saving - generating profile (see profile section)

You can choose one of 3 types.

Type Description
Full backup archive full redmine_root folder with all you databases defined at config/database.yml
Backup archive
  • files folder
  • config/database.yml, config/configuration.yml
  • databases
Only database archive only databases

Examples

Simple install and ugrade

$ wget http://www.redmine.org/releases/redmine-2.3.0.zip
$ wget http://www.redmine.org/releases/redmine-2.5.0.zip

$ redmine install redmine-2.3.0.zip
$ redmine upgrade redmine-2.5.0.zip

Set languages

$ redmine --locale cs install redmine-2.3.0.zip

Install from git

$ redmine install [email protected]:redmine/redmine.git --source git
$ redmine upgrade --source git

Install from git with specific branch

$ redmine install [email protected]:redmine/redmine.git --source git --branch 2.3-stable
$ redmine upgrade --source git