Skip to content

Commit a031988

Browse files
committed
README: Tidied up code blocks and bare URLs.
1 parent a609aaf commit a031988

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Default: *false*
6969

7070
#### winCompatibilityMode *(bool|null)*
7171

72-
In some Active Directory instances when "user_dn" is empty (for example when the whole AD is searched for users), LDAP queries fail with the message "ldap_search(): Search: Operations error.". This is further described in https://stackoverflow.com/questions/17742751/ldap-operations-error. The fix described there is applied when **winCompatibilityMode** is set to *true*. Since this has only been tested on one instance, it is recommended to leave this option at *false* and only activate it if you experience the error described above.
72+
In some Active Directory instances when "user_dn" is empty (for example when the whole AD is searched for users), LDAP queries fail with the message "ldap_search(): Search: Operations error.". This is further described in <https://stackoverflow.com/questions/17742751/ldap-operations-error>. The fix described there is applied when **winCompatibilityMode** is set to *true*. Since this has only been tested on one instance, it is recommended to leave this option at *false* and only activate it if you experience the error described above.
7373

7474
Default: *false*
7575

@@ -235,7 +235,7 @@ This varies not only according to which directory software you're using, but als
235235

236236
This must be defined as an array even if you have only 1 user. Be sure to quote user names that have spaces. For example:
237237

238-
```
238+
```yaml
239239
userNamesToIgnore:
240240
- "nobody"
241241
- "Administrator"
@@ -258,7 +258,7 @@ This varies not only according to which directory software you're using, but als
258258
259259
This must be defined as an array even if you have only 1 group. Be sure to quote group names that have spaces. For example:
260260
261-
```
261+
```yaml
262262
groupNamesToIgnore:
263263
- "Managed Service Accounts"
264264
- "Marketing Staff"
@@ -311,7 +311,7 @@ This varies not only according to which directory software you're using, but als
311311
312312
This must be defined as an array even if you have only 1 group. Be sure to quote group names that have spaces. For example:
313313
314-
```
314+
```yaml
315315
groupNamesOfAdministrators:
316316
- "Domain Admins"
317317
- "Enterprise Admins"
@@ -330,7 +330,7 @@ This varies not only according to which directory software you're using, but als
330330
331331
This must be defined as an array even if you have only 1 group. Be sure to quote group names that have spaces. For example:
332332
333-
```
333+
```yaml
334334
groupNamesOfExternal:
335335
- "Domain Guests"
336336
- "Clients"
@@ -360,7 +360,7 @@ Specify the LDAP server name used by this Gitlab instance. You can find this in
360360
361361
**You may need to put "ldap" before this value!** This hasn't been tested across different installation types, but using the Omnibus package it appears if your "gitlab.rb" has the following...
362362
363-
```
363+
```ruby
364364
gitlab_rails['ldap_servers'] = {
365365
'main' => {
366366
...
@@ -374,22 +374,22 @@ gitlab_rails['ldap_servers'] = {
374374

375375
Once you've configured this tool you can run it from a CLI using:
376376

377-
`php bin/console ldap:sync -d`
377+
$ php bin/console ldap:sync -d
378378

379379
Depending on your system's PHP installation you may need to use `php-cli` instead of `php`. (This typically only occurs on WHM/cPanel based servers configured to host PHP via the fast process manager, PHP-FPM.)
380380

381381
**The `-d` option is important for your first run.** This enables "dry run" mode, meaning no changes will be persisted to your Gitlab instances. After running this tool you should evaluate the changes that will be made based on the output, then run it again without the `-d` option to persist the changes.
382382

383383
If you'd like to see more verbose output you can add up to 3 `-v` switches, for example:
384384

385-
`php bin/console ldap:sync -v`
386-
`php bin/console ldap:sync -vv`
387-
`php bin/console ldap:sync -vvv`
385+
$ php bin/console ldap:sync -v
386+
$ php bin/console ldap:sync -vv
387+
$ php bin/console ldap:sync -vvv
388388

389389
If you'd like to only sync with a single Gitlab instance you can specify the name of it as per your configuration as an argument, for example:
390390

391-
`php bin/console ldap:sync athena`
392-
`php bin/console ldap:sync demeter`
391+
$ php bin/console ldap:sync athena
392+
$ php bin/console ldap:sync demeter
393393

394394
## Built With
395395

@@ -425,6 +425,6 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use
425425

426426
You may obtain a copy of the License at
427427

428-
http://www.apache.org/licenses/LICENSE-2.0
428+
<https://www.apache.org/licenses/LICENSE-2.0>
429429

430430
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the [License](LICENSE) for the specific language governing permissions and limitations under the License.

0 commit comments

Comments
 (0)