Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
afbd1e13
Commit
afbd1e13
authored
Apr 25, 2021
by
Jay Elmore
Committed by
Suzanne Selhorn
Apr 25, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Fix tense issues raised by Vale
parent
23430da7
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
11 additions
and
11 deletions
+11
-11
doc/administration/raketasks/ldap.md
doc/administration/raketasks/ldap.md
+11
-11
No files found.
doc/administration/raketasks/ldap.md
View file @
afbd1e13
...
@@ -10,8 +10,8 @@ The following are LDAP-related Rake tasks.
...
@@ -10,8 +10,8 @@ The following are LDAP-related Rake tasks.
## Check
## Check
The LDAP check Rake task
will test
the
`bind_dn`
and
`password`
credentials
The LDAP check Rake task
tests
the
`bind_dn`
and
`password`
credentials
(if configured) and
will list
a sample of LDAP users. This task is also
(if configured) and
lists
a sample of LDAP users. This task is also
executed as part of the
`gitlab:check`
task, but can run independently
executed as part of the
`gitlab:check`
task, but can run independently
using the command below.
using the command below.
...
@@ -27,7 +27,7 @@ sudo gitlab-rake gitlab:ldap:check
...
@@ -27,7 +27,7 @@ sudo gitlab-rake gitlab:ldap:check
sudo
-u
git
-H
bundle
exec
rake gitlab:ldap:check
RAILS_ENV
=
production
sudo
-u
git
-H
bundle
exec
rake gitlab:ldap:check
RAILS_ENV
=
production
```
```
By default, the task
will return
a sample of 100 LDAP users. Change this
By default, the task
returns
a sample of 100 LDAP users. Change this
limit by passing a number to the check task:
limit by passing a number to the check task:
```
shell
```
shell
...
@@ -38,7 +38,7 @@ rake gitlab:ldap:check[50]
...
@@ -38,7 +38,7 @@ rake gitlab:ldap:check[50]
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/14735) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.2.
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/14735) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.2.
The following task
will run
a
[
group sync
](
../auth/ldap/index.md#group-sync
)
immediately. This is valuable
The following task
runs
a
[
group sync
](
../auth/ldap/index.md#group-sync
)
immediately. This is valuable
when you'd like to update all configured group memberships against LDAP without
when you'd like to update all configured group memberships against LDAP without
waiting for the next scheduled group sync to be run.
waiting for the next scheduled group sync to be run.
...
@@ -61,9 +61,9 @@ bundle exec rake gitlab:ldap:group_sync
...
@@ -61,9 +61,9 @@ bundle exec rake gitlab:ldap:group_sync
## Rename a provider
## Rename a provider
If you change the LDAP server ID in
`gitlab.yml`
or
`gitlab.rb`
you
will
need
If you change the LDAP server ID in
`gitlab.yml`
or
`gitlab.rb`
you need
to update all user identities or users
will be un
able to sign in. Input the
to update all user identities or users
aren't
able to sign in. Input the
old and new provider and this task
will update
all matching identities in the
old and new provider and this task
updates
all matching identities in the
database.
database.
`old_provider`
and
`new_provider`
are derived from the prefix
`ldap`
plus the
`old_provider`
and
`new_provider`
are derived from the prefix
`ldap`
plus the
...
@@ -81,8 +81,8 @@ main:
...
@@ -81,8 +81,8 @@ main:
`main`
is the LDAP server ID. Together, the unique provider is
`ldapmain`
.
`main`
is the LDAP server ID. Together, the unique provider is
`ldapmain`
.
> **Warning**: If you input an incorrect new provider
users will be unable
> **Warning**: If you input an incorrect new provider
, users cannot sign in.
to sign in.
If this happens, run the task again with the incorrect provider
If this happens, run the task again with the incorrect provider
as the
`old_provider`
and the correct provider as the
`new_provider`
.
as the
`old_provider`
and the correct provider as the
`new_provider`
.
**Omnibus Installation**
**Omnibus Installation**
...
@@ -119,7 +119,7 @@ User identities were successfully updated
...
@@ -119,7 +119,7 @@ User identities were successfully updated
### Other options
### Other options
If you do not specify an
`old_provider`
and
`new_provider`
you will be prompted
If you do not specify an
`old_provider`
and
`new_provider`
the task prompts you
for them:
for them:
**Omnibus Installation**
**Omnibus Installation**
...
@@ -141,7 +141,7 @@ What is the old provider? Ex. 'ldapmain': ldapmain
...
@@ -141,7 +141,7 @@ What is the old provider? Ex. 'ldapmain': ldapmain
What is the new provider? Ex. 'ldapcustom': ldapmycompany
What is the new provider? Ex. 'ldapcustom': ldapmycompany
```
```
This task
s also accepts the
`force`
environment variable which will skip
the
This task
also accepts the
`force`
environment variable, which skips
the
confirmation dialog:
confirmation dialog:
```
shell
```
shell
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment