Version 1.3.0 · Redmine 5.1 and 6 · GPLv2
This manual covers installation, configuration and daily use of the atori Checklist plugin.
The plugin adds a per-issue checklist section to the Redmine issue view. Items live directly on the issue they belong to; there is no separate entity, no project-wide template, no global registry. Every change to a checklist item – add, rename, tick, untick, remove, clear – is written to the issue's journal, so the full history is available where users already look for it.
Key concepts:
cd /path/to/redmine
unzip at_checklist-1.4.0.zip -d plugins/
bundle exec rake redmine:plugins:migrate NAME=at_checklist RAILS_ENV=production
# restart Redminecd /path/to/redmine
git clone <repo-url> plugins/at_checklist
bundle exec rake redmine:plugins:migrate NAME=at_checklist RAILS_ENV=production
# restart RedmineAfter restart, log in as administrator and open Administration → Plugins. The Checklist plugin should appear with version 1.3.0.
cd /path/to/redmine
bundle exec rake redmine:plugins:migrate NAME=at_checklist VERSION=0 RAILS_ENV=production
rm -rf plugins/at_checklist
# restart RedmineThe rake task removes the single table the plugin owns (at_checklist_items). Existing issue data is untouched.
The plugin is wired in as a project module and is off by default.
Two independent permissions are available under Administration → Roles and permissions → Checklist:
| Permission | Scope | Typical role |
|---|---|---|
| View checklist | Read-only access to checklists | Reporter |
| Manage checklist | Add / rename / tick / remove items | Developer, Manager |
Separating view from manage lets reporters follow progress without being able to alter items.
When the module is enabled, a Checklist section is added to the issue view via Redmine's issue-view hook. No additional menu item is added, no additional page needs to be opened – the checklist lives next to the description.
Click Add in the checklist section, type the subject, confirm with Enter. The item appears immediately and a journal entry is written on the issue.
To add several items in one go, paste multiple lines into the input field. Each line becomes one checklist item, and a single aggregated journal entry records the batch. Useful for importing checklist templates that you keep in a text editor or wiki.
Click the checkbox next to an item. The done flag flips and a journal entry is written ("marked as done" / "marked as open"). The progress bar updates without a page reload.
Click the item text to turn it into an editable field, change it, confirm with Enter. The change is journaled with both the old and new subject ("renamed from X to Y"), so the edit history is reconstructible.
Click the × next to an item. A journal entry records the removal including the subject that was deleted. No confirmation prompt for individual items – keeps the common case fast.
Click Remove all at the top of the checklist, confirm the prompt. Every item is deleted and a single journal entry records the count of items that were removed.
The issue journal is the authoritative history. Use the issue's History tab to review every checklist change, including who made it and when. No separate logs, exports or reports are required.
Checklist section doesn't appear on the issue. Verify that the Checklist module is enabled in the project settings and that the user has the View checklist permission in one of their roles on that project.
Adding or editing doesn't work. Check whether the user has the Manage checklist permission. The buttons stay visible with only the view permission because the section shows the raw items, but write operations will be rejected.
Progress bar seems off. Reload the issue page. The progress ratio is computed on the server from the current item set; a stale browser view after a concurrent edit by another user is the most common cause.
Bulk add created only one item instead of many. Make sure the multi-line input comes from a source that uses actual line breaks (Enter key presses) rather than literal \n sequences. Pasting from plain-text editors generally works; pasting from spreadsheet cells sometimes strips newlines.
Support is included for twelve months from the date of purchase and covers bug reports, configuration questions and compatibility issues.
E-mail: support@atori.de Initial response: within 48 hours on business days.
When reporting issues, please include:
log/production.log, if available