Commit 6233211d authored by Evan Read's avatar Evan Read

Merge branch 'russell/add-flag-to-user-cap-docs' into 'master'

Note feature flag for user cap

See merge request gitlab-org/gitlab!50806
parents f6cf53af 87554c21
...@@ -59,7 +59,7 @@ GitLab has several features which can help you manage the number of users: ...@@ -59,7 +59,7 @@ GitLab has several features which can help you manage the number of users:
- Enable the [**Require administrator approval for new sign ups**](../../user/admin_area/settings/sign_up_restrictions.md#require-administrator-approval-for-new-sign-ups) - Enable the [**Require administrator approval for new sign ups**](../../user/admin_area/settings/sign_up_restrictions.md#require-administrator-approval-for-new-sign-ups)
option. option.
- Enable the [User cap](../../user/admin_area/settings/sign_up_restrictions.md#user-cap) - Enable the [User cap](../../user/admin_area/settings/sign_up_restrictions.md#user-cap)
option. **Available in GitLab 13.6 and later**. option. **Available in GitLab 13.7 and later**.
- [Disable new sign-ups](../../user/admin_area/settings/sign_up_restrictions.md), and instead manage new - [Disable new sign-ups](../../user/admin_area/settings/sign_up_restrictions.md), and instead manage new
users manually. users manually.
- View a breakdown of users by role in the [Users statistics](../../user/admin_area/index.md#users-statistics) page. - View a breakdown of users by role in the [Users statistics](../../user/admin_area/index.md#users-statistics) page.
......
...@@ -37,6 +37,9 @@ To require administrator approval for new sign ups: ...@@ -37,6 +37,9 @@ To require administrator approval for new sign ups:
1. Go to **Admin Area > Settings > General** and expand **Sign-up restrictions**. 1. Go to **Admin Area > Settings > General** and expand **Sign-up restrictions**.
1. Select the **Require admin approval for new sign-ups** checkbox, then select **Save changes**. 1. Select the **Require admin approval for new sign-ups** checkbox, then select **Save changes**.
In [GitLab 13.7 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/273258), if an administrator disables this setting, the users in pending approval state are
automatically approved in a background job.
## Require email confirmation ## Require email confirmation
You can send confirmation emails during sign up and require that users confirm You can send confirmation emails during sign up and require that users confirm
...@@ -47,20 +50,39 @@ To enforce confirmation of the email address used for new sign ups: ...@@ -47,20 +50,39 @@ To enforce confirmation of the email address used for new sign ups:
1. Go to **Admin Area > Settings > General** and expand **Sign-up restrictions**. 1. Go to **Admin Area > Settings > General** and expand **Sign-up restrictions**.
1. Select the **Enable email restrictions for sign ups** checkbox, then select **Save changes**. 1. Select the **Enable email restrictions for sign ups** checkbox, then select **Save changes**.
In [GitLab 13.7 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/273258), if an administrator disables this setting, the users in pending approval state are
automatically approved in a background job.
## User cap **(CORE ONLY)** ## User cap **(CORE ONLY)**
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4315) in GitLab 13.6. > - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4315) in GitLab 13.7.
> - It's [deployed behind a feature flag](../../feature_flags.md), enabled by default.
> - It's recommended for production use.
> - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#enable-or-disable-user-cap). **(CORE ONLY)**
When the number of billable users reaches the user cap, any user who is added or requests access must be When the number of billable users reaches the user cap, any user who is added or requests access must be
[approved](../approving_users.md#approving-a-user) by an administrator before they can start using [approved](../approving_users.md#approving-a-user) by an administrator before they can start using
their account. their account.
If an administrator increases or removes the user cap, the users in pending approval state will be If an administrator increases or removes the user cap, the users in pending approval state are
automatically approved in a background job. automatically approved in a background job.
### Enable or disable User cap **(CORE ONLY)**
User cap is under development but ready for production use.
It is deployed behind a feature flag that is **enabled by default**.
[GitLab administrators with access to the GitLab Rails console](../../../administration/feature_flags.md)
can opt to disable it.
To disable it:
```ruby
Feature.disable(:admin_new_user_signups_cap)
```
To enable it:
```ruby
Feature.enable(:admin_new_user_signups_cap)
```
## Soft email confirmation ## Soft email confirmation
> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/47003) in GitLab 12.2. > - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/47003) in GitLab 12.2.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment