Redmine - 安装--中文官方帮助手册.doc

Redmine - 安装-中文官方帮助手册Redmine安装需求操作系统Redmine可以运行在Unix、LInux、Mac和Windows系统上，只要Ruby能够运行的平台，它都可以运行。Ruby & Ruby on RailsRedmine不同版本需要的Ruby的版本支持。Redmine 版本支持的 Ruby 版本要求的 Rails 版本要求的 Rack 版本current trunkruby 1.8.6, 1.8.7Rails 2.3.5Rack 1.0.1trunk from r2493 to r2886ruby 1.8.6, 1.8.7Rails 2.2.2trunk before r2493ruby 1.8.6, 1.8.7Rails .xruby 1.8.6, 1.8.7Rails 2.3.5Rack .xruby 1.8.6, 1.8.7Rails .xruby 1.8.6Rails 2.0.2官方的发布版本中包括了相应的Rail版本，存放在vendor目录。所以不需要特别改动。如果你从Redmine源代码库中获取代码，你可能要在你机器上安装特定的Rail版本，运行命令：gem install rails -v=2.3.5说明：需要RubyGems 1.3.1需要Rake0.8.3数据库MYSQL 4.1或更高（推荐）确保安装了C绑定，它可以显著的改进Ruby的性能。你可以通过运行gem install mysql 命令得到它们。目前Ruby MySQL gem不支持MySQL 5.1 。PostgreSQL 8确保你的数据库日期类型设置成ISO（PostgreSQL 默认设置）。你可以使用下面命令设置它：ALTER DATABASE redmine_db SET datestyle=ISO,MDY; 一些在PostgreSQL8.4.0和8.4.1中的错误将会影响到Redmine（#4259, #4314），这些错误已经在PostgreSQL8.4.2中修复。确保安装了PostgreSQL的Ruby适配器，你可以通过下面的命令获得（只运行其中一个）：gem install postgres-pr gem install pg （在SSL连接下工作，编译时需要你使用操作系统的开发库、包） Ubuntu OS: 用下面命令安装开发包 （或类似）: sudo aptitude install libdbd-pg-ruby1.8 SQLite 3 可选组件配置管理程序（例如. svn），用于浏览项目库（必须在你的路径下可用）。 查看 RedmineRepositories 对配置管理软件兼容性和需求。 RMagick （将甘特图导出成png图片） Ruby OpenID Library （可以支持OpenID） 仅在Redmine trunk / 0.9-dev Version 2 或以后版本需要。 安装1.下载并解压缩存档文件，或者签出Redmine。2. 创建一个空的数据库及相应的用户，命名为Redmine。举例如下：MySQL数据库:create database redmine character set utf8;create user redminelocalhost identified by my_password;grant all privileges on redmine.* to redminelocalhost;PostgreSQL数据库:CREATE ROLE redmine LOGIN ENCRYPTED PASSWORD my_password NOINHERIT VALID UNTIL infinity;CREATE DATABASE redmine WITH ENCODING=UTF8 OWNER=redmine;3.复制配置文件config/database.yml.example to config/database.yml，然后按照你数据库的配置编辑该文件的“production”环境。MySQL数据库例子：production: adapter: mysql database: redmine host: localhost username: redmine password: my_password如果你的服务没有运行在标准端口(3306)上,请使用以下配置:production: adapter: mysql database: redmine host: localhost port: 3307 username: redmine password: my_passwordPostgreSQL 数据库例子（默认端口）：production: adapter: postgresql database: host: username: password: encoding: utf8 schema_search_path: (default - public)4. 生成会话存储密钥。Redmine的主干r2493 及以后版本需要，发布版本0.8.7及以后版本需要。Redmine默认存储会话数据在cookies中，所以需要生成一个密钥。 可以运行以下命令实现：RAILS_ENV=production rake config/initializers/session_store.rb如果你使用Redmine 的SVN r3055以后的版本，上述文件是不存在的；从 r3054版本以后不赞成使用。在这些版本中可以使用以下命令 rake generate_session_store5. 创建数据库结构。在应用程序根目录下运行以下命令，会创建数据库表及administrator用户：RAILS_ENV=production rake db:migrate6. 在数据库中插入默认配置数据。运行以下命令：RAILS_ENV=production rake redmine:load_default_data这一步骤是可选的，但强烈建议你使用。当然你可以自己定义你的配置。默认会导入角色、跟踪、状态、工作流枚举值。7. 设置权限注意：Windows 用户必须跳过这一步。运行Redmine的用户必须具有以下子文件夹的写权限：files, log, tmp （如果最后一个不存在请创建）。假设你用一个redmine用户运行Redmine：mkdir tmp public/plugin_assetssudo chown -R redmine:redmine files log tmp public/plugin_assetssudo chmod -R 755 files log tmp public/plugin_assets8.运行WEBrick web服务，测试安装的程序：ruby script/server webrick -e production一旦WEBrick启动，在你的浏览器中输入http:/localhost:3000/。你就可以看到应用的欢迎页面。9. 使用默认管理员账户登录：o 用户名: admin o 密码: admin 你可以在管理&设置中修改应用设置。SMTP服务器配置复制配置文件config/email.yml.example 到config/email.yml，然后按照你的SMTP服务器设置编辑该文件。详细看 email配置例子。不要忘记在修改之后重启你的应用服务。备份Redmine的备份包括： 数据（存储在你的Redmine数据库中） 附件（存储在你的Redmine安装目录下的files文件夹中） 下面是一个用于每日备份的简单的Shell脚本。（假设你使用的是MYSQL数据库）：# Database/usr/bin/mysqldump -u -p | gzip /path/to/backup/db/redmine_date +%y_%m_%d.gz# Attachmentsrsync -a /path/to/redmine/files /path/to/backup/files在Windows安装提示在 上获取ruby安装程序并安装。从开始菜单中选择Start Command Prompt with Ruby按着下面命令的提示做。把命令：RAILS_ENV=production rake db:migrateRAILS_ENV=production rake redmine:load_default_data 修改成 set RAILS_ENV=productionrake db:migraterake redmine:load_default_data你可能需要安装mysql gem，使用这个命令 gem install mysql 安装。在某些情况下需要拷贝 libmysql.dll 文件到你的 ruby/bin 目录下。不是所有的 libmysql.dll 文件都可用，请使用 /svn/trunk/InstantRails-win/InstantRails/mysql/bin/libmySQL.dll 。替代手动安装那些不喜欢手动安装的用户，可以在下载页面下载第三方Redmine包。RedmineInstalling Redmine Installing Redmine Requirements Operating system Ruby & Ruby on Rails Database Optional components Installation SMTP server Configuration Backups Notes on Windows installation Alternative to manual installationRequirementsOperating systemRedmine should run on most Unix, Linux, Mac and Windows systems as long as Ruby is available on this platform.Ruby & Ruby on RailsThe required Ruby and Ruby on Rails versions for a given Redmine version is:Redmine versionSupported Ruby versionsRequired Rails versionRequired Rack versioncurrent trunkruby 1.8.6, 1.8.7Rails 2.3.5Rack 1.0.1trunk from r2493 to r2886ruby 1.8.6, 1.8.7Rails 2.2.2trunk before r2493ruby 1.8.6, 1.8.7Rails .xruby 1.8.6, 1.8.7Rails 2.3.5Rack .xruby 1.8.6, 1.8.7Rails .xruby 1.8.6Rails 2.0.2Official releases include the appropriate Rails version in their vendor directory. So no particular action is needed.If you checkout the source from the Redmine repository, you can install a specific Rails version on your machine by running:gem install rails -v=2.3.5Notes: RubyGems 1.3.1 is required Rake 0.8.3 is requiredDatabase MySQL 4.1 or higher (recommended) o make sure to install the C bindings for Ruby that dramatically improve performance. You can get them by running gem install mysql.o the Ruby MySQL gem currently does not support MySQL 5.1 PostgreSQL 8 o make sure your database datestyle is set to ISO (Postgresql default setting). You can set it using: ALTER DATABASE redmine_db SET datestyle=ISO,MDY;o some bugs in PostgreSQL 8.4.0 and 8.4.1 affect Redmine behaviour (#4259, #4314), they are fixed in PostgreSQL 8.4.2o make sure to install the PosgreSQL adapter for Ruby. You can get it by running (one of the following): gem install postgres-pr gem install pg (works with SSL connections, may need development libraries/packages for your OS before it will compile) Ubuntu OS: development libraries can be installed with (or similiar): sudo aptitude install libdbd-pg-ruby1.8 SQLite 3Optional components SCM binaries (eg. svn), for repository browsing (must be available in your PATH). See RedmineRepositories for SCM compatibility and requirements. RMagick (to enable Gantt export to png image) Ruby OpenID Library (to enable OpenID support) only on Redmine trunk / 0.9-dev Version 2 or greater is required.Installation1. Download and extract the archive or checkout Redmine.2. Create an empty database and accompanying user named redmine for example.For MySQL:create database redmine character set utf8;create user redminelocalhost identified by my_password;grant all privileges on redmine.* to redminelocalhost;For PostgreSQL:CREATE ROLE redmine LOGIN ENCRYPTED PASSWORD my_password NOINHERIT VALID UNTIL infinity;CREATE DATABASE redmine WITH ENCODING=UTF8 OWNER=redmine;3. 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:production: adapter: mysql database: redmine host: localhost username: redmine password: my_passwordIf 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_passwordExample for a PostgreSQL database (default port):production: adapter: postgresql database: host: username: password: encoding: utf8 schema_search_path: (default - public)4. Generate a session store secret. This is required on the trunk version of Redmine at r2493 or above and the released 0.8.7 version or above.Redmine stores session data in cookies by default, which requires a secret to be generated. This can be done by running:RAILS_ENV=production rake config/initializers/session_store.rbIf youre using an SVN version of Redmine post r3055, the above file will no longer exist; it was deprecated as of r3054. On these versions, runrake generate_session_store5. Create the database structure, by running the following command under the application root directory:RAILS_ENV=production rake db:migrateIt will create tables and an administrator account.6. Insert default configuration data in database, by running the following command:RAILS_ENV=production rake redmine:load_default_dataThis step is optional but highly recommended, as you can define your own configuration from scratch. It will load default roles, trackers, statuses, workflows and enumerations.7. Setting up permissionsNB: Windows users have to skip this section.The user who runs Redmine must have write permission on the following subdirectories: files, log, tmp (create the last one if not present).Assuming you run Redmine with a redmine user:mkdir tmp public/plugin_assetssudo chown -R redmine:redmine files log tmp public/plugin_assetssudo chmod -R 755 files log tmp public/plugin_assets8. Test the installation by running WEBrick web server:ruby script/server webrick -e productionOnce WEBrick has started, point your browser to http:/localhost:3000/. You should now see the application welcome page.9. Use default administrator account to log in: login: admin password: adminYou can go to Admin & Settings to modify application settings.SMTP server ConfigurationCopy config/email.yml.example to config/email.yml and edit this file to adjust your SMTP settings.See the email configuration examples.Dont forget to restart the application after any change.BackupsRedmine 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 ca