- Introduction
- Version Compatibility
- Installation
- Configuration
- Agile Board Overview
- How to View the Agile Board
- How to Use the Global Agile Board
- How to Add a New Issue from the Agile Board
- How to Update an Issue from the Agile Board
- How to Change Issue Status with Drag and Drop
- How to Customize Card Fields
- How to Configure Board Columns and WIP Limits
- How to Search and Filter Issues
- How to Use Grouping and Swimlanes
- How to Use the Backlog
- How to Create and Manage Sprints
- How to Assign Issues to a Sprint
- How to Use Scrum Board View
- How to Use Version Planning in Backlog
- How to Create Custom Agile Boards
- How to Edit or Remove Custom Agile Boards
- How to Configure Tracker and Priority Icons
- How to Enable and Use Story Points
- Troubleshooting
- Frequently Asked Questions
- Uninstallation
- Conclusion
Introduction #
Redmineflux Agile Board is a modern Agile planning and execution Plugin for Redmine that helps teams manage work visually across project boards, global boards, and backlog planning views. It supports Kanban and Scrum workflows, drag-and-drop issue movement, double-click card editing, board settings, grouping, WIP limits, sprint planning, saved custom boards, and optional Story Points. This updated plugin is designed for high performance, clearer board layouts, and a more flexible user experience than earlier Agile Board versions.
Version Compatibility #
Supported Redmine versions:
- 5.0.x
- 5.1.x
- 6.0.x
Installation #
To install the Redmineflux Agile Board plugin:
- Make sure Redmine is already installed and working.
- Extract the plugin archive.
- Upload the folder to
Redmine/plugins/agile_board. - Do not rename the plugin folder.
- Install required gems:
bundle install - Run database migrations.
For production:
RAILS_ENV=production bundle exec rails redmine:plugins:migrate
For development:
RAILS_ENV=development bundle exec rails redmine:plugins:migrate - Restart Redmine.
Configuration #
To enable Agile Board for a project:
- Log in as Administrator.
- Open the target project.
- Go to Settings.
- Open the Modules tab.
- Enable Agile Board.
- Save the changes.
After enabling the module:
- The project shows an Agile Board tab.
- The project also shows a Backlog tab.
- Logged-in users can access the Global Agile Board from the top navigation menu.
To configure plugin-level options:
- Go to Administration.
- Open Plugins.
- Find Redmineflux Agile Board.
- Click Configure.
From plugin configuration, administrators can manage:
- Maximum WIP limit
- Story Points feature toggle
- Story Point values
- Tracker icons
- Priority icons
Agile Board Overview #
The new Agile Board plugin includes three main working areas:
- Project Agile Board Use this to manage issues inside a single project.
- Global Agile Board Use this to view and manage issues across all visible projects.
- Backlog Use this to plan work by sprint, version, or unassigned backlog.
Main capabilities include:
- Kanban and Scrum board modes
- Drag-and-drop issue movement
- Double-click card editing
- Search and filtering
- Grouping and swimlanes
- WIP limits
- Card field customization
- Sprint planning
- Version planning
- Saved custom boards
- Tracker and priority icon customization
- Optional Story Points
How to View the Agile Board #
To view the Agile Board for one project:
- Open the project.
- Click Agile Board from the project menu.
To view the Agile Board across projects:
- Log in to Redmine.
- Click Agile Board from the top navigation menu.
The Global Agile Board shows issues from all projects the current user is allowed to see.
How to Use the Global Agile Board #
The Global Agile Board is useful when you want one board view across multiple projects. You can use it to:
- View issues across all visible projects
- Search issues by subject
- Filter by assigned members
- Group issues by project, tracker, priority, author, assignee, category, target version, parent task, or other supported options
- Drag issues between statuses when permissions allow
- Double-click a card to edit issue subject and description
- Show project context directly on issue cards
This is especially useful for team leads, PMs, and managers tracking work across multiple delivery streams.
How to Add a New Issue from the Agile Board #
To add a new issue from the project Agile Board:
- Open the project Agile Board.
- Locate the target column.
- Use the quick add issue option in that column.
- Enter the issue subject.
- Save or confirm the entry.
The new issue is created in the selected status column. Note:
- Issue creation depends on project permissions.
- Some fields may use project defaults until the issue is edited in full detail.
How to Update an Issue from the Agile Board #
Double-click any issue card to open an edit modal where you can update the issue subject and description directly from the board. Changes are immediately reflected on the board after saving.
How to Change Issue Status with Drag and Drop #
To move an issue to another status:
- Open the Project Agile Board or Global Agile Board.
- Locate the issue card.
- Click and drag the card to another status column.
- Drop the card into the target column.
The plugin updates the issue status automatically if:
- The user has edit permission
- The workflow allows the transition
If the workflow blocks that transition, the move will not be applied.
How to Customize Card Fields #
Each board can display different issue details on the cards. To customize card fields:
- Open the board.
- Click the Settings icon.
- Open the Card Fields section.
- Select the fields you want to display.
- Click Apply.
Common card fields include:
- Issue ID
- Subject
- Tracker
- Priority
- Assignee
- Author
- Start date
- Due date
- Estimated time
- Spent time
- Done ratio
- Parent task
- Subtask count
- Description
- Last comment
- Tags
- Category
- Target version
- Comment count
- Attachment count
- Story Points, if enabled at plugin level
How to Configure Board Columns and WIP Limits #
To configure visible columns and WIP limits:
- Open the board.
- Click the Settings icon.
- Open the Board Columns section.
- Enable or disable the statuses you want to display.
- Enter WIP values for the columns where needed.
- Click Apply.
WIP limits help teams control work in progress and make overloaded columns visible. The board settings also include a Column Reordering option. To enable column reordering on the Kanban board:
- Open the Project Agile Board or Global Agile Board.
- Click the Settings icon.
- Enable Column Reordering.
- Click Apply.
After it is enabled:
- You can drag and reorder Kanban status columns directly on the board.
- The updated column order is saved for that board configuration.
- If Column Reordering is disabled, columns stay in their configured order and cannot be dragged.
Notes:
- WIP limits can be configured per status column.
- The plugin-level maximum WIP value is set in plugin configuration.
How to Search and Filter Issues #
The plugin includes a board search experience for fast issue discovery. Typical filtering options include:
- Search by issue subject
- Filter by member
- Query-based issue filters
- Grouping-based board segmentation
- Sprint filter on Scrum board
- Backlog filters for planning views
To search:
- Open the board.
- Use the search field at the top.
- Enter a keyword from the issue subject.
To apply project query filters:
- Open the filter section.
- Choose your conditions.
- Click Apply.
How to Use Grouping and Swimlanes #
Grouping organizes issues into swimlanes. Supported grouping options include:
- None
- Project
- Tracker
- Priority
- Author
- Assignee
- Category
- Target version
- Parent task
- Additional supported group values available in the current board
To apply grouping:
- Open the board.
- Use the Group By option.
- Select the grouping value.
- Apply the change.
The board refreshes and displays grouped swimlanes.
How to Use the Backlog #
The Backlog provides a planning view for sprint and version management. It includes:
- Sprint columns
- Version columns
- Issues not assigned to a sprint or version
- Drag-and-drop assignment
- Search and filters
- Card field settings
- Lazy loading for large datasets
To open the Backlog:
- Open a project.
- Click Backlog.
This view is ideal for sprint planning and release planning.
How to Create and Manage Sprints #
To create a sprint:
- Open the project.
- Go to Settings.
- Open Sprint management.
- Click New Sprint.
- Enter:
- Name
- Description
- Start date
- End date
- Duration, if used
- Status
- Sharing option
- Save the sprint.
To edit a sprint:
- Open Sprint management.
- Select the sprint.
- Update the values.
- Save.
To delete a sprint:
- Open Sprint management.
- Select the sprint.
- Click Delete.
- Confirm the action.
How to Assign Issues to a Sprint #
You can assign issues to a sprint in multiple ways. From issue edit form:
- Open the issue.
- Click Edit.
- Choose a Sprint from the sprint field.
- Save.
From Backlog:
- Open Backlog.
- Drag an issue into the target sprint column.
From bulk update or supported issue actions:
- Select the issues.
- Choose sprint update options.
- Save changes.
How to Use Scrum Board View #
The board supports both Kanban and Scrum modes. To switch to Scrum mode:
- Open the Project Agile Board.
- Click Settings.
- Set Board Type to Scrum.
- Apply the settings.
When Scrum mode is active:
- Sprint selection is available
- The board can be filtered by sprint
- Teams can focus on one sprint at a time
How to Use Version Planning in Backlog #
The Backlog also supports version-based planning. You can:
- View versions as backlog columns
- Drag issues into version columns
- See unassigned issues separately
- Plan releases visually
This gives teams one place to organize sprint work and release work.
How to Create Custom Agile Boards #
Custom Agile Boards let you save different configurations for the same project. You can create different boards for:
- Development teams
- QA teams
- Management reporting
- Scrum planning
- Bug triage
- Release monitoring
To create a custom board:
- Open the project Agile Board.
- Open the saved board or board sidebar.
- Choose the option to create a new custom board.
- Enter board details.
- Select:
- Columns
- Card fields
- Totals
- Filters
- Grouping
- Save the board.
How to Edit or Remove Custom Agile Boards #
To edit a saved board:
- Open the project Agile Board.
- Open the custom board list.
- Select the board.
- Click Edit.
- Update the configuration.
- Save changes.
To remove a saved board:
- Open the custom board list.
- Select the board.
- Click Delete or Remove.
- Confirm.
Saved boards can also include visibility and sharing rules depending on permissions.
How to Configure Tracker and Priority Icons #
The plugin supports icon customization for:
- Trackers
- Priorities
To configure icons:
- Go to Administration.
- Open Plugins.
- Find Agile Board.
- Click Configure.
- Choose icons for each tracker and priority.
- If the selected icon is a text symbol, you can also set its color.
- Save the configuration.
These icons appear on issue cards and improve visual scanning.
How to Enable and Use Story Points #
Story Points are now controlled by a plugin-level setting. Important:
- Story Points are disabled by default.
- If disabled, the feature is hidden across the Agile system.
- If enabled, Story Points are available on Project Agile Board, Global Agile Board, Backlog, issue forms, and supported board totals.
To enable Story Points:
- Go to Administration.
- Open Plugins.
- Find Agile Board.
- Click Configure.
- Enable Story Points.
- Enter the allowed Story Point values.
- Save the configuration.
To display Story Points on boards:
- Open the board settings.
- Enable Story Points in card fields or totals where needed.
- Apply changes.
If the feature is disabled:
- Story Points are not shown in UI
- Story Point totals are hidden
- Story Point field options are removed from board settings
- Story Point controls are inactive across the Agile plugin
Troubleshooting #
If you face issues with the plugin, try the following:
- Clear browser cache and reload the page.
- Restart the Redmine application.
- Make sure the plugin is installed in
plugins/agile_board. - Re-run plugin migrations:
bundle exec rails redmine:plugins:migrate RAILS_ENV=production - Confirm the Redmine version is supported.
- Verify the project module is enabled in project settings.
- Check user permissions for:
- View Agile Board
- Edit issues
- Manage sprints
- Review Redmine logs for plugin load or controller errors.
- If upgrading to Redmine 6, make sure the plugin code includes Rails 7-compatible serialize declarations.
Frequently Asked Questions #
Q1. What is the difference between Project Agile Board and Global Agile Board?
Project Agile Board shows issues for one project. Global Agile Board shows issues across all projects the current user can access.
Q2. Does the plugin support both Kanban and Scrum?
Yes. Project boards can be used in Kanban or Scrum mode.
Q3. Can I customize the issue cards?
Yes. You can choose visible card fields from the board settings panel.
Q4. Can I save different board layouts for the same project?
Yes. The plugin supports custom saved boards with their own filters, columns, and card settings.
Q5. Can I use sprint planning and version planning?
Yes. Sprint and version planning are available from the Backlog view.
Q6. Are Story Points always enabled?
No. Story Points are controlled by plugin configuration and are disabled by default.
Q7. Can I edit issues directly from the board?
Yes. The plugin supports inline editing and double-click editing for supported actions.
Q8. Does the plugin support Redmine 6?
Yes. The current plugin supports Redmine 6.x.
Uninstallation #
To uninstall the plugin:
- Go to the Redmine installation directory.
- Remove the plugin folder:
plugins/agile_board - If you want to roll back database changes, run:
bundle exec rails redmine:plugins:migrate NAME=agile_board VERSION=0 RAILS_ENV=production - Restart Redmine.
Take a database backup before rollback or uninstallation.
Conclusion #
Redmineflux Agile Board is a modern Agile execution and planning Plugin for Redmine that brings together project boards, global visibility, backlog planning, sprint management, saved custom boards, grouping, WIP control, and optional Story Points in one unified experience. It is designed to give teams a faster, cleaner, and more flexible workflow than previous Agile Board versions.