Skip to content

5xRuby/redmine_user_cf_scope

Repository files navigation

Redmine User Custom Field Scope

A Redmine plugin that extends the built-in User format custom field with three user-selection scopes, instead of the default project-members-only behavior.

Features

When configuring a custom field with the User format, you can now choose one of three scopes:

Scope Description
Project Users Only members of the current project (default Redmine behavior). Role filtering is still available.
Specific Group All active users who belong to a chosen system-wide group.
All Active Users Every active user in the Redmine instance.

Requirements

Dependency Minimum version
Redmine 5.1
RedMica 2.3
Ruby 3.2
Rails 7.1

Tested with: Redmine 6.1 / RedMica 4.0 on Ruby 3.2 and Rails 8.1.

No database migration is required. The scope settings are stored in the existing format_store column on the custom_fields table.

Installation

1. Copy the plugin into your Redmine plugins directory.

# From your Redmine root
git clone https://github.com/your-org/redmine_user_cf_scope plugins/redmine_user_cf_scope

Or copy the directory manually if you are not using git:

cp -r /path/to/redmine_user_cf_scope /path/to/redmine/plugins/

2. Restart the Redmine server.

# Puma (typical production setup)
bundle exec pumactl restart

# Or a simple process restart
rails server

No rake redmine:plugins:migrate step is needed — the plugin adds no new tables or columns.

Usage

  1. Go to Administration → Custom Fields and create or edit a custom field with format User.
  2. Under User Scope, select the desired option:
    • Project Users — keeps the existing role-filter UI below it.
    • Specific Group — a dropdown appears to pick the target group.
    • All Active Users — no extra configuration needed.
  3. Save the custom field. The scope takes effect immediately when users fill in the field on issues (or whichever entity the custom field is attached to).

Uninstallation

Remove the plugin directory and restart the server.

rm -rf plugins/redmine_user_cf_scope

Existing custom field values are unaffected. Custom fields that used a non-default scope will fall back to Project Users behavior (because user_scope will be blank) until the field is reconfigured or the plugin is reinstalled.

License

GNU General Public License v2 or later — same license as Redmine itself.

Author

Mu-Fan Teng (a.k.a. Owaru Ryudo)

About

Available to choose specific user groups for Redmine's User custom field

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors