Redmine使用手册.doc

安装Redmine系统要求Ruby on Rails 2.0.2 数据库 （参考下面的兼容数据库列表） 可选的：SVN 客户端（版本不低于1.3），用于版本库浏览功能（必须配置到您的 PATH 设置中） RMagick （用于将甘特图输出至PNG图形文件） 支持的数据库：MySQL 4 或更高版本（推荐） PostgreSQL 8 （8.3版本未经充分测试） SQLite 3 （请先阅读: /2007/1/29/using-sqlite3-with-rails ) 安装1. 下载 并解压，或者 检出 Redmine。2. 创建一个空数据库，例如名称为 redmineMySQL数据库：create database redmine character set utf8;3. 复制 config/database.yml.example 到 config/database.yml ，并在此文件中配置 production 环境下的数据库连接参数。以MySQL数据库为例：production: adapter: mysql database: redmine host: localhost username: bduser password: bdpasswd4. 在程序的根目录下运行以下命令来创建数据库结构：rake db:migrate RAILS_ENV=production此命令将创建数据表和管理员帐号。5. 运行以下命令，向数据库中导入默认的配置数据：rake redmine:load_default_data RAILS_ENV=production这一步操作是可选的，但 强烈推荐 您执行它，您也可以从头开始一步步填写自己的配置参数。此命令将导入默认角色、跟踪标签、状态、工作流程和枚举值。6. 运行WEBrick服务器来测试安装：ruby script/server -e production当WEBrick启动后，使用浏览器访问 http:/localhost:3000/ 您将看到系统的欢迎界面。7. 使用默认的用户名和密码登录：用户名: admin 密码: admin 8. 您可以到 管理 & 配置 界面修改系统的配置参数。SMTP服务器配置在 config/environment.rb 文件中，您可以设置您的SMTP服务器的参数：config.action_mailer.smtp_settings: SMTP服务器配置 config.action_mailer.perform_deliveries: 设置为 false 以禁用邮件发送功能 修改此文件后需要重新启动服务器。备份Redmine的备份应该包括： * 数据（保存在redmine数据库中） * 附件（保存在Redmine安装目录的 files 目录中）以下是一个可以进行每天备份的简单脚本程序（假设您使用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升级从SVN检出系统的升级1. 在Redmine根目录运行以下命令：svn update2. 升级数据库（请务必先备份数据库）：rake db:migrate RAILS_ENV=production3. 清空缓存和已有的会话： rake tmp:cache:clear rake tmp:sessions:clear4. 重新启动程序，打开“管理 - 角色和权限”页面来为新功能分配权限（如果需要的话）。下载的发行版本的升级1. 将新下载的程序解压到其它目录。2. 复制数据库配置文件 config/database.yml 到新建的 config 目录。3. 在 config/environment.rb 重新输入SMTP服务器配置参数，而 不要 直接用旧文件覆盖新文件。4. 转到新的Redmine目录，升级数据库（请务必先备份数据库）：rake db:migrate RAILS_ENV=production5. 复制 RAILS_ROOT/files 目录到新的安装目录。6. 重新启动程序，打开“管理 - 角色和权限”页面来为新功能分配权限（如果需要的话）。从其它系统导入TracTrac导入工具导入的内容：用户 组件 里程碑 功能需求(ticket) 功能需求的注释和变更（状态和解决方案） Trac特有的属性（例如解决方案）将被作为Redmine的自定义属性 功能需求文件和自定义属性 Wiki页面及其修改的历史记录 注意：用户密码全部被设置为 trac 如果您的Redmine数据库还没有功能需求，则原来功能需求的编号将保留 所有的自定义属性都将在Redmine中被转换为text类型 您需要 sqlite-ruby gem (gem install sqlite-ruby) 来访问Trac的数据库。开始前，您需要一个空的Redmine数据库， 并已经导入了默认的配置数据（必需） 。参考 安装Redmine以下脚本在 0.10 Trac sqlite数据库环境下测试通过，0.11 数据库应该也可以使用。1. 运行以下命令，其中test是您的Redmine运行环境参数：rake redmine:migrate_from_trac RAILS_ENV=test2. 脚本会询问您Trac的配置信息：Trac directory : /var/trac/myprojectTrac database adapter (sqlite, sqlite3, mysql, postgresql) sqlite:Database encoding UTF-8:Target project identifier : myprojectTrac directory 是指您的Trac环境的根目录。Redmine将在此目录中查找 db/trac.db （如果您选择了sqlite/sqlite3数库的话）和 attachments 目录。如果Trac使用了mysql或者postgresql数据库的话，脚本将询问您连接参数（主机名称、数据库名称、用户名和密码）。Target project identifier 是指将接收导入数据的Redmine项目的标识符，如果该项目不存在将会被自动创建。4. 脚本导入数据过程如下：Deleting dataMigrating components.Migrating milestones.Migrating custom fields.Migrating tickets.Migrating wiki.Components: 29/30Milestones: 14/14Tickets: 1275/1275Ticket files: 106/106Custom values: 4409/4409Wiki edits: 102/102脚本将显示所有导入对象的总数。此时您将可以在Redmine看到一个Myproject项目，此项目中保存着刚刚导入的Trac数据。MantisMantis导入工具导入的内容：用户 项目 项目版本、类别和新闻 项目成员 错误 错误附注、文件、关系和监视器 自定义属性 用户密码都将被设置为 mantis。只有错误文件保存在Mantis数据中（这是Mantis的默认配置）时才能被导入。以下脚本在多种 1.0.x Mantis数据库中测试通过，也应该可以在其它最近的版本下使用。Before starting, you need a fresh Redmine database, with default data loaded (required). See 安装Redmine1. 运行以下命令，其中test是您的Redmine运行环境参数：rake redmine:migrate_from_mantis RAILS_ENV=test2. 脚本会询问您Mantis的数据库配置信息：Please enter settings for your Mantis databaseadapter mysql:host localhost:database bugtracker: mantisusername root:password :encoding UTF-8:输入您的Mantis数据库的适配器、主机名称、数据库名称、用户名、密码和编码方式，或者使用默认值。适配器可以是mysq（默认）或者postgresql。3. 脚本导入数据过程如下：Migrating users.Migrating projects.Migrating bugs.Migrating news.Migrating custom fields.Users: 15/15Projects: 13/13Memberships: 10/10Versions: 33/33Categories: 4/4Bugs: 180/180Bug notes: 336/336Bug files: 46/46Bug relations: 11/11Bug monitors: 8/8News: 3/3Custom fields: 2/2脚本将显示所有导入对象的总数。系统配置应用程序标题标题显示在页面的头部。欢迎文字显示在系统主页上的文字。可以包含HTML标记。主题您可以选择一个自定义的主题。Redmine内置了一个Alternate主题，此主题主要是会根据问题的优先级在问题列表中显示不同颜色。界面截图：主题保存在 public/themes/ 目录中。更多资料请查看主题。默认语言当系统无法判断用户浏览器的语言时将使用默认语言。在向多个用户发送邮件时也将使用默认语言。 默认值是：英语日期格式使您可以选择如何显示日期：根据用户的语言 ：将按照用户的语言选择显示给用户的日期格式 其它格式 ：日期将始终按照选定的格式显示 默认值是：根据用户的语言附件大小限制上传附件的限制（单位：KB）。 默认值是：2048（即2MB）主机名称安装应用程序的主机名称。主机名称将作为连接显示在发送给用户的邮件中。协议协议用于在通知邮件中生成连接。 默认值是：http文本格式在问题、新闻、文档等的描述信息中使用的文本格式化方法。压缩Wiki历史文档使您可以压缩wiki的历史文档（以节省数据库空间）。 默认值是：无RSS Feed内容条数限制在RSS Feed中最多的记录条数。 默认值是：15认证要求认证如果此选项选中，匿名用户将无法看到任何页面。用户必须登录才能访问。 默认值是：未选中自动登录此选项允许用户使用自动登录功能。 默认值是：禁用允许自注册此选项使您可以启用或禁用新用户的自注册：禁用 ：用户不能注册 通过邮件认证激活帐号 ：新注册的用户会收到一封激活邮件来激活其帐号（用户必须提供有效的邮箱地址）。 手动激活帐号 (默认值) ：新注册的用户必须经过管理员的认证。用户注册完成后，管理员将收到一封邮件通知其有用户等待激活。 自动激活帐号 ：用户注册完成后即可登录。 忘记密码如果此选项选中，忘记密码功能可用。 默认值是：选中问题跟踪允许不同项目之间的问题关联如果选中，可以在不同项目的问题之间建立关联。 默认值是：未选中在项目页面上默认显示子项目的问题如果选中，上级项目的问题列表、日历和甘特图上会同时显示子项目的问题。 默认值是：选中问题输出条目的限制将问题输出到CSV或这PDF格式的时候可以包含的最大问题数量。 默认值是：500问题列表中显示的默认列此设置使您可以选择在问题列表中默认显示的列。只有设置为“用于所有项目”的自定义属性会在此出现。邮件通知邮件发件人地址发送给用户的邮件中显示的发件人地址。使用密件抄送 (bcc)如果选中，通知邮件将使用密件抄送来发送。 默认值是：选中邮件签名您可以在此输入系统发送邮件时使用的签名。版本库自动获取程序变更如果此选项被选中，当用户查看版本库时系统会自动获取版本库中的新修订。默认值是：选中您可以禁用此选项，然后在后台通过Repository#fetch_changesets命令来定时获取所有版本库的新修订。例如：ruby script/runner Repository.fetch_changesets -e production启用用于版本库管理的Web Service只有当您安装了自动创建SVN版本库的脚本时才可激活此选项。 默认值是：未选中版本库编码此选项使您可以指定版本库中文件的编码方式（可以输入逗号分割的多个值）。这些编码用来将文件内容和差别内容转换成UTF-8编码，以便他们能在浏览器中正确显示。当输入了多个编码后，系统将使用第一个与文件内容相符的编码。例如，对于法语用户，此选项可设置为：UTF-8, ISO 8859-15, CP1252对于日语用户：ISO-2022-JP, EUC-JP, UTF-8, SHIF_JIS, WINDOWS-31J在提交信息中引用问题当从版本库中提取数据时，系统将会在提交信息中搜索其引用的问题或者解决的问题的编号。这些选项使您可以定义一些关键字，从而在提交信息中自动引用问题或解决问题，并定义已解决问题的状态。默认的关键字有：引用问题：refs, references, IssueID 解决问题：fixes, closes 没有为解决问题定义默认的状态，如果您希望能够自动关闭问题则需要自己指定应用后的状态。如果您不希望使用关键字来引用问题，就在 用于引用问题的关键字 处填入一个星号：*。这样所有在提交信息中发现的问题编号都将被连接到变更中。使用默认关键字的提交信息的例子：This commit refs #1, #2 and fixes #3这条信息会引用问题1和问题2，并将自动解决问题3。关键字后的问题编号可以使用空格、逗号或者&来分隔。译注：自动解决问题指自动将问题状态设置为已解决。角色和权限角色使您可以定义项目成员的权限。项目的每个用户都担任该项目的一种角色。一个用户可以在不同项目中担任不同角色。您可以创建新角色或者对现有角色进行修改。如果项目中的角色没有指定给任何用户，那么此角色可以被删除。角色的属性名称: 角色的显示名称 问题可指派给此角色: 如果不选中，那么项目的问题不能指派给担任此角色的用户。 权限当修改角色时，您可以通过复选框选中或者取消该角色执行各种操作的权限。系统角色Redmine中有2种系统角色：“非成员（Non member）”和“匿名（Anonymous）”。它们被Redmine系统内部使用，因此不可删除。非成员（Non member） ：此角色定义了已在系统中注册但是并非该项目成员时所拥有的权限。 匿名（Anonymous） ：此角色定义了匿名用户（即未注册的）在该项目中拥有的权限。 请注意这些权限只对公开项目起作用，因为对于内部项目来说非项目成员根本无法看到该项目。问题跟踪系统跟踪标签跟踪标签是指问题的不同类型。您可以为每种跟踪标签定义不同的工作流程。如果您新建了一种跟踪标签，您必须要为其定义工作流程才能正确的使用它。您可以让新建的跟踪标签从已有跟踪标签复制其工作流程（在新建跟踪标签页面上，在“从以下项目中复制工作流程”列表框中选择一个现有的跟踪标签即可）。问题状态已关闭的问题 ：表示问题已经被关闭（可以将多种状态声明为关闭） 默认值 ： 新建问题的默认状态（只有一种状态可以作为默认状态） 工作流程工作流程使您可以定义不同角色的项目成员被允许针对不同类型的问题所做的问题状态变更。在工作流程设置界面，选择您希望修改的工作流程的角色和跟踪标签，然后点击“编辑”。此页面使您可以设置选中角色和跟踪标签被允许的状态变更。当前状态一栏表示问题的初始状态。“可变更的新状态”栏表示问题可以变更到的状态。注意：您需要将“变更问题状态（Change issue status）”权限授予一个角色，此角色才能修改现有问题的状态。（请参阅角色与权限）在上述例子中，“开发人员”角色可以将“错误”问题从“新建”状态变更为“已指派”或“已解决”。而“已指派”状态可以变更为“已解决”。“错误”问题的所有其它状态开发人员都不能更改。自定义属性自定义属性使您可以为项目、问题或用户添加附加的信息。自定义属性可以使用以下类型：整数: 正整数或负整数 文字: 单行字符串 长段文字: 多行文字 日期: 日期 布尔量: 复选框 列表: 下拉列表框 每个自定义属性可以定义一些校验规则：最小 - 最大 长度 ：属性的最小长度和最大长度（0表示没有限制） 正则表达式 ：使用正则表达式来对属性进行校验 例如A-Z4d+$ ： 开头是4个大写字母，后面是一个或多个数字0-9*$ : 只有字符 没有数字可能的值: 列表属性的可能值。点击!/images/add.png!图标可以添加更多的可能值。 项目的自定义属性必填: 该属性是创建或保存项目时必须填写的属性 问题的自定义属性必填: 该属性是创建或保存问题时必须填写的属性 用于所有项目: 如果选中，该属性可以用于所有项目。如果不选，每个项目都可以选择是否使用该属性（请参阅项目配置）。 用户的自定义属性必填: 该属性是创建或保存用户时必须填写的属性管理项目项目列表项目： 项目名称 描述： 项目的简要说明 公开： 如果有 图标，所有人都可以看到该项目。非公开项目只有由项目管理员分配了权限的用户才能够访问。 子项目： 该项目所拥有的子项目的数量 创建于： 项目被创建的日期。 存档： 您可以点击 图标来对项目进行存档。存档后的项目对用户是不可见的。管理员可以将其取消存档（仍保留其原有内容）。存档项目时，所有子项目也将被存档。 删除： 对项目进行彻底删除，与存档不同，被删除项目将无法恢复。请慎重使用此功能。 新建或编辑项目请参考 项目配置.管理用户用户列表帐号状态图标表示帐号已经被锁定。被锁定帐号的用户无法登录和访问系统。 图标表示该用户还没有激活自己的帐号。 锁定/解锁按钮用来锁定或解锁用户的帐号。新建或编辑用户管理员用户拥有系统和所有项目的所有权限。在编辑状态下，密码栏保留空白表示不对用户的密码进行修改。LDAP认证Redmine内置对 LDAP轻型目录访问协议 认证的支持，并可使用一个或多个LDAP目录。声明 LDAP打开 管理-配置-认证，点击右下角的 LDAP认证 。点击新建认证模式并输入如下信息：名称: 任意的目录名称 主机: LDAP主机名称 端口: LDAP端口（默认为389） LDAPS: 如果需要使用LDAPS来访问目录则选中此选项 帐号: 如果您的LDAP可以匿名访问则保持空白，否则输入可以访问LDAP的用户名 密码: 帐号对应的密码 Base DN: LDAP目录树的顶层DN（专有名称，distinguished name） 登录属性: 将被作为Redmine用户名使用的LDAP属性的名称 如果此时Redmine用户的帐号被配置为使用LDAP认证，那么他们应该可以使用其LDAP用户名和密码登录了。如果要对此进行测试，可以新建一个与其LDAP帐号相同Redmine用户，在新建用户页面上的认证模式下拉列表框中选择刚才新建的LDAP（只有当LDAP被声明后，该下拉列表才会出现），密码处保持空白。然后使用LDAP的用户名和密码登录Redmine。即时用户生成如果选中了 即时用户生成 ，当LDAP用户首次登录到Redmine时，系统会为其自动创建Redmine帐号。您必须同时输入创建Redmine帐号所必需的那些LDAP属性的名称（名字，姓氏，邮件地址）。下面是一个典型的使用Active Directory的例子：Name = My DirectoryHost = Port = 389LDAPS = noAccount = MyDomainUserNamePassword = Base DN = CN=users,DC=host,DC=domain,DC=orgOn-the-fly user creation = yesAttributesLogin = sAMAccountNameFirstname = givenNameLastname = sNEmail = mail请注意LDAP属性的名称是 区分大小写的.故障排除如果您希望使用即时用户生成，请确认Redmine可以从您的LDAP获取创建用户所必需的所有属性。例如，如果您的LDAP中没有用户的合法邮件地址，即时用户生成将无法正常工作（当您登录时会出现“无效的用户名或密码”错误）。同时也要确认您没有将用户的任何自定义属性设置为 必填 。这些自定义属性也会造成即时用户生成失败。用户帐号我的帐号此界面使您可以修改自己的帐号设置：姓名、邮件地址、语言。邮件通知在通知选项下拉列表可以选择：收取我的所有项目的通知 选择收取其中某些项目的通知 收取我跟踪或者参与（是问题报告者或者被指派处理）的项目的通知 密码修改密码时，需要输入旧密码和2次新密码。密码长度应在4到12个字符之间。如果您的帐号使用外部认证方式（LDAP），则您无法在Redmine中修改密码。我的工作台此页面可以显示您的项目的多种信息。使用“个性化定制本页”功能，您可以选择在此页面上显示何种信息及其显示的位置。忘记密码如果您忘记了密码，请按照以下步骤获取新密码。在登录界面上，点击 忘记密码 。输入您的邮件地址并提交。随后系统将发送一封包含修改密码连接的邮件到您的邮箱中。请注意，此功能有可能被管理员关闭。同时，如果您的帐号使用外部认证方式（LDAP），则此功能也无法使用。注册通过注册，您可以无需管理员介入就获得一个帐号。点击界面右上角的 注册 按钮。填写表单并提交后，一封确认邮件将被发送给您。使用邮件中的连接来激活您的帐号即可。请注意，此功能有可能被管理员关闭。项目配置信息公开 ：如果选中，此项目可以被所有用户查看，包括那些不属于本项目成员的用户。如果不选，则只有项目成员可以根据其角色访问。 上级项目 ：您可以指定上级项目。项目的层次最多为2层。本项目的上级项目不能是本项目的子项目。当创建子项目时，上级项目的所有成员都将成为子项目的成员。 名称: 项目的显示名称（必须唯一）。 描述: 将显示在项目概述页面上的描述信息。 标识符: 系统内部使用的标识符（必须唯一）。项目创建后，标识符将无法修改。 自定义属性: 为该项目中的问题选择可用的自定义属性。自定义属性只能由管理员来定义。 模块您可以在此页面选择该项目中可用的模块。当模块先被禁用又被重新启用后，其数据仍将保留。例如您禁用了一个项目的“问题跟踪”模块，现有的问题并不会被删除，当您重新启用该模块后可以继续查看这些问题。用户您可以在此界面定义项目成员及其角色。一个用户在一个项目中只能担任一种角色（可以在其它项目中担任其它角色）。用户的角色决定了他在项目中的权限。当您为A项目创建了一个子项目B后，A项目的所有用户都将成为B项目的用户。版本项目的版本使您可以对变更情况进行跟踪和计划。您可以将问题指定到某个版本，并在路线图上查看每个版本对应的问题。问题类别问题类别使您可以对问题进行组织。例如，类别可以与项目的不同模块一一对应。Wiki每个项目都可以拥有自己的wiki。要使用wiki，只需要给wiki主页起个名字然后点击“保存”。版本库每个项目可以与一个版本库关联。当版本库配置完成后，你可以浏览并查看版本库的变化。版本库的变化同时也将显示在活动页面。讨论区每个项目可以拥有一个或多个讨论区。问题列表应用和保存过滤器问题列表默认只显示打开的问题。可以对标准属性和自定义属性进行自定义的查询。当过滤器设置好之后，点击 可以刷新问题列表。点击 来清除过滤器。点击 可以保存自定义查询。在保存页面上需要输入自定义查询的名字，选择希望显示在问题列表上的属性（标准属性和自定义属性都可以显示）。选中公开则使所有人都能看到该自定义查询，否则只有您可以看到它。自定义查询保存后，将会被列到右边栏上。快捷菜单在问题列表中的问题上单击右键时将会打开快捷菜单（Opera用户使用C