User management Rake tasks

Tier: Free, Premium, Ultimate Offering: Self-managed

GitLab provides Rake tasks for managing users. Administrators can also use the Admin area to manage users.

Add user as a developer to all projects

To add a user as a developer to all projects, run: 

# omnibus-gitlab
sudo gitlab-rake gitlab:import:user_to_projects[username@domain.tld]

# installation from source
bundle exec rake gitlab:import:user_to_projects[username@domain.tld] RAILS_ENV=production

Add all users to all projects

To add all users to all projects, run: 

# omnibus-gitlab
sudo gitlab-rake gitlab:import:all_users_to_all_projects

# installation from source
bundle exec rake gitlab:import:all_users_to_all_projects RAILS_ENV=production

Administrators are added as maintainers and all other users are added as developers.

Add user as a developer to all groups

To add a user as a developer to all groups, run: 

# omnibus-gitlab
sudo gitlab-rake gitlab:import:user_to_groups[username@domain.tld]

# installation from source
bundle exec rake gitlab:import:user_to_groups[username@domain.tld] RAILS_ENV=production

Add all users to all groups

To add all users to all groups, run: 

# omnibus-gitlab
sudo gitlab-rake gitlab:import:all_users_to_all_groups

# installation from source
bundle exec rake gitlab:import:all_users_to_all_groups RAILS_ENV=production

Administrators are added as owners so they can add additional users to the group.

Update all users in a given group to project_limit:0 and can_create_group: false

To update all users in given group to project_limit: 0 and can_create_group: false, run: 

# omnibus-gitlab
sudo gitlab-rake gitlab:user_management:disable_project_and_group_creation\[:group_id\]

# installation from source
bundle exec rake gitlab:user_management:disable_project_and_group_creation\[:group_id\] RAILS_ENV=production

It updates all users in the given group, its subgroups and projects in this group namespace, with the noted limits.

Control the number of billable users

Enable this setting to keep new users blocked until they have been cleared by the administrator. Defaults to false: 

block_auto_created_users: false

Disable two-factor authentication for all users

This task disables two-factor authentication (2FA) for all users that have it enabled. This can be useful if the GitLab config/secrets.yml file has been lost and users are unable to sign in, for example.

To disable two-factor authentication for all users, run: 

# omnibus-gitlab
sudo gitlab-rake gitlab:two_factor:disable_for_all_users

# installation from source
bundle exec rake gitlab:two_factor:disable_for_all_users RAILS_ENV=production

Rotate two-factor authentication encryption key

GitLab stores the secret data required for two-factor authentication (2FA) in an encrypted database column. The encryption key for this data is known as otp_key_base, and is stored in config/secrets.yml.

If that file is leaked, but the individual 2FA secrets have not, it’s possible to re-encrypt those secrets with a new encryption key. This allows you to change the leaked key without forcing all users to change their 2FA details.

To rotate the two-factor authentication encryption key:

  1. Look up the old key in the config/secrets.yml file, but make sure you’re working with the production section. The line you’re interested in looks like this: 

    production:
  otp_key_base: fffffffffffffffffffffffffffffffffffffffffffffff

  2. Generate a new secret: 

    # omnibus-gitlab
sudo gitlab-rake secret

# installation from source
bundle exec rake secret RAILS_ENV=production

  3. Stop the GitLab server, back up the existing secrets file, and update the database: 

    # omnibus-gitlab
sudo gitlab-ctl stop
sudo cp config/secrets.yml config/secrets.yml.bak
sudo gitlab-rake gitlab:two_factor:rotate_key:apply filename=backup.csv old_key=<old key> new_key=<new key>

# installation from source
sudo /etc/init.d/gitlab stop
cp config/secrets.yml config/secrets.yml.bak
bundle exec rake gitlab:two_factor:rotate_key:apply filename=backup.csv old_key=<old key> new_key=<new key> RAILS_ENV=production

    The <old key> value can be read from config/secrets.yml (<new key> was generated earlier). The encrypted values for the user 2FA secrets are written to the specified filename. You can use this to rollback in case of error.

  4. Change config/secrets.yml to set otp_key_base to <new key> and restart. Again, make sure you’re operating in the production section. 

    # omnibus-gitlab
sudo gitlab-ctl start

# installation from source
sudo /etc/init.d/gitlab start

If there are any problems (perhaps using the wrong value for old_key), you can restore your backup of config/secrets.yml and rollback the changes: 

# omnibus-gitlab
sudo gitlab-ctl stop
sudo gitlab-rake gitlab:two_factor:rotate_key:rollback filename=backup.csv
sudo cp config/secrets.yml.bak config/secrets.yml
sudo gitlab-ctl start

# installation from source
sudo /etc/init.d/gitlab start
bundle exec rake gitlab:two_factor:rotate_key:rollback filename=backup.csv RAILS_ENV=production
cp config/secrets.yml.bak config/secrets.yml
sudo /etc/init.d/gitlab start

Bulk assign users to GitLab Duo Pro

Tier: Premium, Ultimate Offering: Self-managed, GitLab Dedicated
History

The Rake task for bulk user assignment is available in GitLab 16.9 and later. For GitLab 16.8, use the script bulk_user_assignment.rb instead.

To perform bulk user assignment for GitLab Duo Pro, you can use the following Rake task: 

bundle exec rake duo_pro:bulk_user_assignment DUO_PRO_BULK_USER_FILE_PATH=path/to/your/file.csv

If you prefer to use square brackets in the file path, you can escape them or use double quotes: 

bundle exec rake duo_pro:bulk_user_assignment\['path/to/your/file.csv'\]
# or
bundle exec rake "duo_pro:bulk_user_assignment['path/to/your/file.csv']"

The CSV file should have the following format: 

username
user1
user2
user3
user4
etc..

Ensure that the file contains a header named username, and each subsequent row represents a username for user assignment.

The task might raise the following error messages:

  • User is not found: The specified user was not found.
  • ERROR_NO_SEATS_AVAILABLE: No more seats are available for user assignment.
  • ERROR_INVALID_USER_MEMBERSHIP: The user is not eligible for assignment due to being inactive, a bot, or a ghost.