http://www.redmine.org/projects/redmine/wiki/RedmineInstall
Step 1 - Redmine application
下载redmine http://www.redmine.org/projects/redmine/wiki/Download
解压换gem源,国外的很慢
gem sources --add http://gems.ruby-china.org/ --remove http://rubygems.org/
解压缩redmine
vim Gemfile 修改第一行
source 'https://gems.ruby-china.org/'
创建数据库和用户
MySQL
CREATE DATABASE redmine CHARACTER SET utf8;
CREATE USER 'redmine'@'localhost' IDENTIFIED BY 'my_password';
GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost';
For versions of MySQL prior to 5.0.2 - skip the 'create user' step and instead:
GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost' IDENTIFIED BY 'my_password';
PostgreSQL
CREATE ROLE redmine LOGIN ENCRYPTED PASSWORD 'my_password' NOINHERIT VALID UNTIL 'infinity';
CREATE DATABASE redmine WITH ENCODING='UTF8' OWNER=redmine;
SQL Server
The database, login and user can be created within SQL Server Management Studio with a few clicks.
If you prefer the command line option with SQLCMD, here's some basic example:
Show SQL
Step 3 - Database connection configuration
配置数据库连接
Copy config/database.yml.example to config/database.yml and edit this file in order to configure your
database settings for "production" environment.
Example for a MySQL database using ruby 1.8 or jruby:
production:
adapter: mysql
database: redmine
host: localhost
username: redmine
password: my_password
Example for a MySQL database using ruby 1.9 (adapter must be set to mysql2):
production:
adapter: mysql2
database: redmine
host: localhost
username: redmine
password: my_password
If your server is not running on the standard port (3306), use this configuration instead:
production:
adapter: mysql
database: redmine
host: localhost
port: 3307
username: redmine
password: my_password
Example for a PostgreSQL database (default port):
production:
adapter: postgresql
database: <your_database_name>
host: <postgres_host>
username: <postgres_user>
password: <postgres_user_password>
encoding: utf8
schema_search_path: <database_schema> (default - public)
Example for a SQL Server database (default host localhost, default port 1433):
production:
adapter: sqlserver
database: redmine
username: redmine # should match the database user name
password: redminepassword # should match the login password
Step 4 - Dependencies installation
安装需要的依赖包
Redmine uses Bundler to manage gems dependencies.
gem install bundler
Then you can install all the gems required by Redmine using the following command:
bundle install --without development test
Optional dependencies
RMagick (allows the use of ImageMagick to manipulate images for PDF and PNG export)
If ImageMagick is not installed on your system, you should skip the installation of the rmagick gem using:
bundle install --without development test rmagick
If you have trouble installing rmagick on Windows, refer to this HowTo.
Database adapters
Redmine automatically installs the adapter gems required by your database configuration by reading it from
the config/database.yml file (eg. if you configured only a connection using the mysql2 adapter, then only
the mysql2 gem will be installed).
Don't forget to re-run bundle install --without development test ... after adding or removing adapters in
the config/database.yml file!
Additional dependencies (Gemfile.local)
If you need to load gems that are not required by Redmine core (eg. Puma, fcgi), create a file named
Gemfile.local at the root of your redmine directory. It will be loaded automatically when running bundle install.
Example:
# Gemfile.local gem 'puma'
Step 5 - Session store secret generation
This step generates a random key used by Rails to encode cookies storing session data thus preventing their tampering.
Generating a new secret token invalidates all existing sessions after restart.
with Redmine 1.4.x:
bundle exec rake generate_session_store
with Redmine 2.x:
bundle exec rake generate_secret_token
Alternatively, you can store this secret in config/secrets.yml:
http://guides.rubyonrails.org/upgrading_ruby_on_rails.html#config-secrets-yml
Step 6 - Database schema objects creation
创建数据库的表
Create the database structure, by running the following command under the application root directory:
RAILS_ENV=production bundle exec rake db:migrate
Windows syntax:
set RAILS_ENV=production
bundle exec rake db:migrate
It will create tables by running all migrations one by one then create the set of the permissions and the
application administrator account, named admin.
Ubuntu troubleshooting:
If you get this error with Ubuntu:
Rake aborted! no such file to load -- net/https
Then you need to install libopenssl-ruby1.8 just like this: apt-get install libopenssl-ruby1.8.
Step 7 - Database default data set
Insert default configuration data in database, by running the following command:
RAILS_ENV=production bundle exec rake redmine:load_default_data
Redmine will prompt you for the data set language that should be loaded; you can also define the REDMINE_LANG
environment variable before running the command to a value which will be automatically and silently picked
up by the task.
E.g.:
Unices:
RAILS_ENV=production REDMINE_LANG=fr bundle exec rake redmine:load_default_data
Windows:
set RAILS_ENV=production
set REDMINE_LANG=fr
bundle exec rake redmine:load_default_data
Step 8 - File system permissions
NB: Windows users can skip this section.
The user account running the application must have write permission on the following subdirectories:
files (storage of attachments)
log (application log file production.log)
tmp and tmp/pdf (create these ones if not present, used to generate PDF documents among other things)
public/plugin_assets (assets of plugins)
E.g., assuming you run the application with a redmine user account:
mkdir -p tmp tmp/pdf public/plugin_assets
chown -R redmine:redmine files log tmp public/plugin_assets
chmod -R 755 files log tmp public/plugin_assets
Step 9 - Test the installation
Test the installation by running WEBrick web server:
with Redmine 1.4.x:
bundle exec ruby script/server webrick -e production
with Redmine 2.x:
bundle exec ruby script/rails server webrick -e production
with Redmine 3.x:
bundle exec rails server webrick -e production
Once WEBrick has started, point your browser to http://localhost:3000/. You should now see the application
welcome page.
Note: Webrick is not suitable for production use, please only use webrick for testing that the installation
up to this point is functional. Use one of the many other guides in this wiki to setup redmine to use either
Passenger (aka mod_rails), FCGI or a Rack server (Unicorn, Thin, Puma, hellip;) to serve up your redmine.
Step 10 - Logging into the application
Use default administrator account to log in:
login: admin
password: admin
You can go to Administration menu and choose Settings to modify most of the application settings.
Configuration
Redmine settings are defined in a file named config/configuration.yml.
If you need to override default application settings, simply copy config/configuration.yml.example to
config/configuration.yml and edit the new file; the file is well commented by itself, so you should have
a look at it.
These settings may be defined per Rails environment (production/development/test).
Important : don't forget to restart the application after any change.
Email / SMTP server settings
Email configuration is described in a dedicated page.
SCM settings
This configuration section allows you to:
override default commands names if the SCM binaries present in the PATH variable doesn't use the standard name
(Windows .bat/NaNd names won't work)
specify the full path to the binary
Examples (with Subversion):
Command name override:
scm_subversion_command: "svn_replacement.exe"
Absolute path:
scm_subversion_command: "C:\Program Files\Subversion\bin\svn.exe"
Attachment storage settings
You can set a path where Redmine attachments will be stored which is different from the default 'files'
directory of your Redmine instance using the attachments_storage_path setting.
Examples:
attachments_storage_path: /var/redmine/files
attachments_storage_path: D:/redmine/files
Logging configuration
Redmine defaults to a log level of :info, writing to the log subdirectory. Depending on site usage,
this can be a lot of data so to avoid the contents of the logfile growing without bound, consider rotating them,
either through a system utility like logrotate or via theconfig/additional_environment.rb file.
To use the latter, copy config/additional_environment.rb.example to config/additional_environment.rb and add the
following lines. Note that the new logger defaults to a high log level and hence has to be explicitly set to info.
#Logger.new(PATH,NUM_FILES_TO_ROTATE,FILE_SIZE) config.logger = Logger.new('/path/to/logfile.log', 2, 1000000)
config.logger.level = Logger::INFO
Backups
Redmine backups should include:
data (stored in your redmine database)
attachments (stored in the files directory of your Redmine install)
Here is a simple shell script that can be used for daily backups (assuming you're using a mysql database):
# Database /usr/bin/mysqldump -u <username> -p<password> <redmine_database> |
gzip > /path/to/backup/db/redmine_`date +%y_%m_%d`.gz # Attachments
rsync -a /path/to/redmine/files /path/to/backup/files
Notes on Linux/Unix installation
Be sure to disable security hardenning tools during the installation process if you run into bizarre
permission problems. These problems are mostly silent and can be caused by tools like extended ACLs,
SELinux, or AppArmor. There tools are mostly used in big companies with a strict security policy,
default Linux/Unix distributions settings shouldn't be a problem.
Notes on Windows installation
There is an prebuilt installer of Ruby MRI available from http://rubyinstaller.org.
After installing it, select Start Command Prompt with Ruby in the start menu.
Specifying the RAILS_ENV environment variable:
When running command as described in this guide, you have to set the RAILS_ENV environment variable
using a separate command.
I.e. commands with the following syntaxes:
RAILS_ENV=production <any commmand>
<any commmand> RAILS_ENV=production
have to be turned into 2 subsequent commands:
set RAILS_ENV=production <any commmand>
MySQL gem installation issue:
You may need to manually install the mysql gem using the following command:
gem install mysql