FreeScript
evertimer_redmine_plugin
by everlabs · version 2026.10.19 · updated 2 days ago
No reviews yet
- Downloads
- 0
- Reviews
- 0
- Size
- 103 KB
- Code check
- Clean
- Licence
- GPL-2.0
- Released
- Nov 2026
Extends the capabilities of the EverTimer Chrome extension
EverTimer Redmine plugin
========================
Extends the Capabilities of the EverTimer Chrome Extension
Compatibility
Tested on Redmine 7.0.1, 6.1.1 and 5.0.5; 4.1.1 compatibility maintained at API level.
Redmine, Ruby, Rails, Status
v7.0.1, v4.0.6, v8.1.3.1, Tested — plugin registered, both migrations forward and back, both endpoints, settings screen, and the extension exercised end-to-end against a restored production-shaped copy
v6.1.1, v3.4.9, v7.2.3, Tested — same subset, same result
v5.0.5, v3.1.3, v6.1.7.2, Tested — installed, migrated and exercised end-to-end on a clean instance
v4.1.1, v2.6.6, v5.2.4.2, API-level compatibility — the plugin source is kept free of APIs introduced after Rails 5.2 / Ruby 2.6, verified by a static sweep of every Ruby file in
Features
This plugin extends the capabilities of the EverTimer Chrome extension by providing two API endpoints:
The plugin directory must be named
The
**Docker (official
Mount the plugin at
With
Configuration
Non-billable time
Non-billable classification is configured per Redmine instance under Administration > Plugins > Evertimer plugin > Configure. You can mark projects, trackers, issue statuses, time-tracking activities and custom-field values as non-billable. Until the settings are saved, all time counts as billable.
The EverTimer extension
Each user connects the extension to Redmine once:
…
========================
Extends the Capabilities of the EverTimer Chrome Extension
Compatibility
Tested on Redmine 7.0.1, 6.1.1 and 5.0.5; 4.1.1 compatibility maintained at API level.
Redmine, Ruby, Rails, Status
v7.0.1, v4.0.6, v8.1.3.1, Tested — plugin registered, both migrations forward and back, both endpoints, settings screen, and the extension exercised end-to-end against a restored production-shaped copy
v6.1.1, v3.4.9, v7.2.3, Tested — same subset, same result
v5.0.5, v3.1.3, v6.1.7.2, Tested — installed, migrated and exercised end-to-end on a clean instance
v4.1.1, v2.6.6, v5.2.4.2, API-level compatibility — the plugin source is kept free of APIs introduced after Rails 5.2 / Ruby 2.6, verified by a static sweep of every Ruby file in
app/, db/, config/ and init.rb. No live 4.1.1 build was tested.Features
This plugin extends the capabilities of the EverTimer Chrome extension by providing two API endpoints:
- User Statistics (
GET /evertimer/user_stats): the sum of TimeEntry hours for today, this week and this month for the requesting user, together with the billable portion of each. Non-billable time is classified through the plugin's own settings screen (non-billable projects, trackers, issue statuses, time-tracking activities and custom-field values). Optionally returns the requesting user's identity with?include=user.
- Custom Fields (
GET /evertimer/custom_fields.json): theTimeEntryCustomFieldrecords visible to the requesting user, narrowed to the twelve attributes EverTimer actually needs to render a custom-field input. This addresses limitations with the core Redmine API endpoint/custom_fields.json, which requires admin privileges and returns comprehensive details unnecessary for EverTimer.
- Check compatibility in the table above. Redmine 7.0.1, 6.1.1 and 5.0.5 are tested; 4.1.1 is compatible at the API level only.
- Enable the REST API. The plugin requires
Enable REST web serviceto be enabled in your Redmine Settings. To do so go to Settings > API and ensure that the Enable REST web service option is checked. You can find it athttps://your-redmine-domain/settings?tab=api
- No extra gems. The plugin ships no
Gemfile, so there is nobundle installstep of its own. - Back up your database before any migration: install, upgrade or rollback. See Redmine backups.
- Clone the plugin into Redmine's
pluginsdirectory:
cd /path/to/redmine/plugins
git clone https://github.com/everlabs/evertimer_redmine_plugin.gitThe plugin directory must be named
evertimer_redmine_plugin — Redmine derives both the plugin identifier and the mirrored asset path (public/plugin_assets/evertimer_redmine_plugin) from the directory name.
- Run the plugin's migrations from the Redmine root:
bundle exec rake redmine:plugins:migrate NAME=evertimer_redmine_plugin RAILS_ENV=productionThe
NAME= argument scopes the run to this plugin only, so other installed plugins are left alone. The migrations add a time_entries (user_id, spent_on) index used by the statistics endpoint.
- Restart Redmine the way your deployment runs it:
- Passenger:
touch tmp/restart.txtin the Redmine root - systemd / Puma:
sudo systemctl restart - Docker:
docker restart
assets/javascripts, assets/stylesheets, used by the settings screen) when it starts. On Redmine 6.0+ in production, if the plugin settings screen opens without its styles or scripts, run bundle exec rake assets:precompile RAILS_ENV=production and restart again.
- Verify the installation:
- Administration > Plugins lists Evertimer plugin 1.0.0.
- The statistics endpoint answers with your API key:
curl -i -H "X-Redmine-API-Key: your_api_key" -H "Accept: application/json" \
https://your-redmine-domain/evertimer/user_stats200 with a JSON body means the plugin works. See Troubleshooting below for anything else.**Docker (official
redmine image)**Mount the plugin at
/usr/src/redmine/plugins/evertimer_redmine_plugin:
services:
redmine:
image: redmine:6.1
volumes:
- ./plugins/evertimer_redmine_plugin:/usr/src/redmine/plugins/evertimer_redmine_plugin
environment:
REDMINE_PLUGINS_MIGRATE: "1"With
REDMINE_PLUGINS_MIGRATE set, the image's entrypoint runs the plugin migrations when the container starts (only with the image's default command). Without it, migrate inside the running container and restart it:
docker exec -it bundle exec rake redmine:plugins:migrate NAME=evertimer_redmine_plugin RAILS_ENV=production
docker restartConfiguration
Non-billable time
Non-billable classification is configured per Redmine instance under Administration > Plugins > Evertimer plugin > Configure. You can mark projects, trackers, issue statuses, time-tracking activities and custom-field values as non-billable. Until the settings are saved, all time counts as billable.
The EverTimer extension
Each user connects the extension to Redmine once:
- In Redmine, open My account (
https://your-redmine-domain/my/account) and copy the API access key (click Show in the sidebar). - Open the EverTimer extension. On first run it opens Settings. Enter the Redmine domain and the API key, then save.
- The statistics circles (today, week, month, billable split) appear once the plugin responds.
…