Skip to content

Commit 27a47b3

Browse files
authored
Merge pull request #108 from MSIH/master
Fix Typo in Readme
2 parents 19e9fbc + abb87aa commit 27a47b3

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,16 @@ Jenkins then uses DNS SRV records and LDAP service of Active Directory to authen
1515

1616
Jenkins recognizes all the groups in Active Directory that the user belongs to, so you can use those to make authorization decisions (for example you can choose the matrix-based security as the authorization strategy and perhaps allow "Domain Admins" to administer Jenkins).
1717

18+
#### Setup
19+
20+
Install Certs in Store
21+
22+
Update config.xml
23+
24+
Update jenkins.xml
25+
26+
27+
1828
#### Active Directory Health Status
1929

2030
Since the version 2.5 the AD plugin adds a ManagementLink to report a Health Status about the Domain and Domain controllers. In order to correctly use this feature, you should be logged-in into the instance and the cache should be disabled. Then, you will get:
@@ -107,7 +117,7 @@ For Windows:
107117

108118
5\. Follow section Securing access to Active Directory servers to enable LDAPS
109119

110-
Disaster recovery: In case that after all of this you cannot login anymore, you should enable the logging on the plugin to understand why it is failing. In case that after you enable the secured option you cannot login on the instance anymore, you might want to quickly fallback to the previous status specially on production environments. You can easily do this by going to $JENKINS\_HOME/config.xml and under the section \<securityRealm class="hudson.plugins.active\_directory ActiveDirectorySecurityRealm" revert the tlsConfiguration to the previous status. A restart is needed.
120+
Disaster recovery: In case that after all of this you cannot login anymore, you should enable the logging on the plugin to understand why it is failing. In case that after you enable the secured option you cannot login on the instance anymore, you might want to quickly fallback to the previous status specially on production environments. You can easily do this by going to $JENKINS\_HOME/config.xml and under the section \<securityRealm class="hudson.plugins.active_directory.ActiveDirectorySecurityRealm" revert the tlsConfiguration to the previous status. A restart is needed.
111121

112122
<tlsConfiguration>TRUST_ALL_CERTIFICATES</tlsConfiguration>
113123

@@ -157,12 +167,12 @@ To verify if the connection is upgraded or not, see [Logging](https://www.jenkin
157167

158168
On the other hand, if you wish on using LDAPS, you should set:
159169

160-
- System property `-Dhudson.plugins.active\_directory.ActiveDirectorySecurityRealm.forceLdaps=true` as a startup parameter to force Jenkins to start a connection with LDAPS. 
170+
- System property `-Dhudson.plugins.active_directory.ActiveDirectorySecurityRealm.forceLdaps=true` as a startup parameter to force Jenkins to start a connection with LDAPS. 
161171
- Use secured port is defined 636 or 3269
162172
(`your.hostname.com\[\|:636\|:3269\]`)
163173

164174
 Note that
165-
`-Dhudson.plugins.active\_directory.ActiveDirectorySecurityRealm.forceLdaps=true` skips the default LDAP + TLS upgrade.
175+
`-Dhudson.plugins.active_directory.ActiveDirectorySecurityRealm.forceLdaps=true` skips the default LDAP + TLS upgrade.
166176

167177
#### Override domain controllers
168178

@@ -188,7 +198,7 @@ If you are not sure what the notation for a group name is, try the following pro
188198

189199
#### Create/Update a dedicated Logs Recorder
190200

191-
If you think you've configured everything correctly but still not being able to login (or any other problems), please enable [Logging](https://www.jenkins.io/doc/book/system-administration/viewing-logs/) and configure logging level for "hudson.plugins.active\_directory" to ALL. Attempt a login and then file a ticket with the log output.
201+
If you think you've configured everything correctly but still not being able to login (or any other problems), please enable [Logging](https://www.jenkins.io/doc/book/system-administration/viewing-logs/) and configure logging level for "hudson.plugins.active_directory" to ALL. Attempt a login and then file a ticket with the log output.
192202

193203
Also, it might be useful to enable:
194204

@@ -247,4 +257,4 @@ See the [changelog](https://github.com/jenkinsci/active-directory-plugin/blob/ma
247257

248258
## Release Notes
249259

250-
See [Github Release](https://github.com/jenkinsci/active-directory-plugin/releases).
260+
See [Github Release](https://github.com/jenkinsci/active-directory-plugin/releases).

0 commit comments

Comments
 (0)