linkedin / linkedin/oncall

Documentation: How to configure and enable basic LDAP/AD User Authentication for Oncall

Open
#209 11 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.3k
Forks
245
PR merge metrics
No merged PRs in 30d

Description

I was having trouble getting basic LDAP/Active Directory authentication enabled in my instance of Oncall due to the config options provided. In the end I figured out that all that is needed is to enable the following:

- Enable `module: 'oncall.auth.modules.ldap_example'`
- Enable and configure `ldap_url`
- Enable and configure `ldap_user_suffix`
- Enable and configure `ldap_cert_path`

Here is a proper example:
```
# Example configuration for LDAP-based auth
module: 'oncall.auth.modules.ldap_example'
ldap_url: 'ldaps://my.domain.com'
ldap_user_suffix: '@my.domain.com'
ldap_cert_path: '/home/oncall/configs/corp_cert.pem'
```
Everything else in the module config block should be commented out.

All of the other configs including `ldap_bind_user`, `ldap_bind_password`, `ldap_base_dn`, and `ldap_search_filter` wasn't needed as I assume they are used by the `ldap_import` module.

Is it recommended to submit a PR to add notes on separating out the different module options in the config.yaml? If not, what is the best way to submit contributions to the official documentation at https://oncall.tools/docs/ (documentation is hosted on read the docs)?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the LDAP module options in config.yaml and the documentation at https://oncall.tools/docs/. Compare the ldap_example settings with the ldap_import options, then document which settings are required for basic LDAP/AD authentication and how documentation contributions are submitted. Done means the two module configurations are clearly separated and the contribution path is explained.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
authentication, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.