Customizing modules per project

Ensuring that flexibility comes first, Redmine's projects are flexible in the sense of modules. So, modules that are going to be used in a project can be chosen on a per-project basis.

Getting ready

Make sure that your Redmine user has permissions to create and edit projects.

How to do it…

Modules are chosen immediately at the formation of a new project or later in the Project Settings tab. Please keep in mind that your users will see modules only if their roles are granted permission. To create a new project and choose modules for it, perform the following steps:

1. Click the Projects link at top left of the screen in the main Redmine menu.
2. After this, click New project, and you will get a screen that looks like the following:
   

Just below the required project details section is a Modules section with checkboxes and module names. To turn the module on and off, just tick or untick the checkbox.

Existing projects

Modules can be activated or deactivated even for existing projects. If your user has proper permissions, you should be able to see Settings in the main project menu. Once clicked, the Modules tab should be visible, which displays the modules screen with module on/off checkboxes and a Save button.

How it works…

This feature enables modules such as Documents or News to be used on a per-project basis, meaning that each project can but does not have to use any of the modules available in the Redmine system. From a technical standpoint, settings about each project are stored in the database and can be edited either through New project or Project Settings from inside Redmine. Once a module is ticked, it is displayed in a main menu for that particular project, as displayed in this image:

Once unticked, the module disappears from the project's main menu.

Tip

Module-related data stays in the database after the module is deactivated. It will become visible once the module is active again.

There's more…

Some plugins may be displayed as a module and turned on or off on this same page on a per-project basis.