Commit Graph

56 Commits

Author SHA1 Message Date
Neil Lathwood
778c83797d Updated WebUI config options in docs to support direct linking to installs (#15009)
* Updated WebUI config options in docs to support direct linking to installs

* Reverted distributed polling config for hostname
2023-05-10 19:05:12 -05:00
James Andrewartha
239e648acb Update Authentication.md (#14788) 2023-01-17 09:17:43 +01:00
Kim Håkonsen
524e0c097b Update Radius auth to accept permissions attributes (#14531)
* Update Radius-Auth to accept permission attribute

* Update Radius-Auth to accept permission attribute

* Fixed list of strings

* Swapped " with ' in switch statement

* Added whitespace to satisfy  styleCI bot

* Yet another whitespace...

* Removed two blank lines....

* Fixed missing "s"

* Try to satisfy linter - fixed a stupid mistake

Had put the code for mapping attributes inside the if statement that states that user exists in librenms. It has to be done before testing of user exists, and after radius auth is true.

* Comments was skewed

* Stylefix

* Update LibreNMS/Authentication/RadiusAuthorizer.php

Murrant's edit

Co-authored-by: Tony Murray <murraytony@gmail.com>

* Added 0 on line 54 to satisfy test.

* StyleFix

* Stylefix2

* Style test complained about whitespaces, i guess..

* Update Authentication.md

* Update Authentication.md

Co-authored-by: Tony Murray <murraytony@gmail.com>
2022-11-09 10:10:33 -06:00
Martin22
3f5588b2c4 Revert "Update radius auth to accept permissions attribute (#14382)" (#14433)
This reverts commit 840c3210e6.
2022-10-10 12:26:44 +02:00
Kim Håkonsen
840c3210e6 Update radius auth to accept permissions attribute (#14382)
* Update radius auth to accept permissions attribute

* Apply fixes from StyleCI

* Stylefix

* Update Authentication.md

* Update RadiusAuthorizer.php

Co-authored-by: StyleCI Bot <bot@styleci.io>
2022-10-07 21:54:21 +02:00
Félix Bouynot
a174268a3f Fix documentation for php8.1 and bad package name (#14393) 2022-09-27 09:07:50 +02:00
Félix Bouynot
d3b43d608a Add SELinux configuration for LDAP/AD authentication on Centos8 in the documentation (#14094) 2022-07-15 22:14:26 -05:00
Philipp Fromme
4a98dc69e3 Add LDAP bind and userlist filter support to ldap-authorization (#13788)
* Add userlist filter to ldap-authorization

* Add LDAP bind user to ldap-authorization

* Type hint getFullDn parameter of ldap-authorization

* docs: add missing options of ldap

* docs: add available options of ldap-authorization
2022-04-22 01:28:29 -05:00
Jellyfrog
8f474dd4d4 Rework documentation (#13709)
* Rework documentation

* Slightly adjust theme

* wip

* fixes

* Remove unneeded header

* Re-added Acknowledgement.md file

* Added Acknowledgement.md to mkdocs.yml

Co-authored-by: Neil Lathwood <gh+n@laf.io>
2022-02-08 23:02:28 +00:00
Nash Kaminski
cb56ae5f46 Improvements to SSO Authorization and logout handling (#13311)
* Improvements to SSO Authorization and logout handling

Changes:
* Adds support for a default access level in the SSO authorization
  plugin when group mapping is enabled.
* Restore functionality of the auth_logout_handler configuration option,
  allowing the user to be redirected to a configured URL to complete
  logout from an external IdP.
* Documentation and test coverage updates

* Set sso.static_level to 0 in AuthSSOTest:testGroupParsing()

* Simplify implementation to use default values in Config::get()
2021-10-02 08:02:42 -05:00
rhinoau
02c2cd47b3 Documentation cleanup of Basic Setup, Advanced Setup, 3rd Party Integration sections (#13018)
* TOC cleanup of Basic Setup, Advanced Setup, 3rd Party Integration sections
2021-07-09 21:34:01 +02:00
Sean
bcedc0ed77 Improve Markdown syntax in Document (#12949)
* Use GitLab instead of Gitlab

Only change text part, the Alert.Transport.Gitlab class left as is.

* Fix href in document

* Move section in document

The agent list in this document is sorted by alphabetical order,
"SDFS info" is the only exception.

* Remove trailing spaces in document

* Align code in document

* Fix Markdown in document

- Escape underline
- Add syntax highlight
- Add two space in the end of line to make it a newline
- Add newline before list or code section

* Update LibreNMS/Alert/Transport/Gitlab.php

Co-authored-by: Jellyfrog <Jellyfrog@users.noreply.github.com>
2021-06-16 21:16:21 +02:00
dlehman83
9f591c0aa2 Update Documentation (#12411)
* Update Documentation

Most work in Graylog and SNMP
Fixed many code tags, spelling and wording.
Added SNMP PowerShell example.

* Update SNMP-Configuration-Examples.md

Fix TOC brackets
2020-12-30 15:38:14 +01:00
CrazyMax
a0062aa633 Remove hardcoded URLs to doc (#12364)
Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com>
2020-11-27 23:34:58 +01:00
Tony Murray
5f0388f0e3 Remove DB credentials from config.php
Better validation when config.php does not exist

Update docs and quote password

only populate legacy vars in config_to_json
drop .travis.yml config copy
remove credentials from config.php.default

Check for existance of .env instead of config.php in python scripts

legacy credential cleanup

tiny cleanups

consistent env for artisan server and artisan dusk
2020-06-27 07:47:08 -05:00
louis-oui
ef562f607e LDAP Add option to authenticate user independtly of OU (#10873)
* Add option to authenticate user independtly of OU
* Set config option in webui
* Compatibility with bind username option
* ran ./lnms translation:generate
* update doc
2019-11-22 19:29:47 +01:00
Jellyfrog
c76e95d343 Markdown linting of docs (#10595)
* Remove trailing spaces

* Markdown linting of docs
2019-10-21 00:47:40 +00:00
Zane C. Bowers-Hadley
e4c9153d16 more documentation clean up (#10577)
* fix a few bare URLs

* make mdl happy

* make Weathermap.md as mdl happy as possible

* make Varnish.md as mdl happy as possible

* make Two-Factor-Auth.md mdl happy

* touch one header for Syslog.md, but little can be done about the rest

* make Sub-Directory.md as mdl happy as possible

* make SNMP-Trap-Handler.md lint happy

* make SNMP-Proxy.md mdl happy

* make Smokeping.md as mdl happy as possible

* make Services.md mdl happy

* make RRDTune.md mdl happy

* cleanup RRDCached.md as much as possible

* make RRDCached-Security.md mdl happy

* make Rancid.md as mdl happy as possible

* make Proxmox.md mdl happy

* make Plugin-System.md as mdl happy as possible

* make PeeringDB.md mdl happy

* make Oxidized.md more lint happy

* make Network-Map.md mdl happy

* make MIB-based-polling.md as mdl happy as possible

* make Metric-Storage.md mdl happy

* make IRC-Bot.md as mdl happy as possible

* make IRC-Bot-Extensions.md as mdl happy as possible

* make

* make Graylog.md mdl happy

* make Gateone.md mdl happy

* make Fast-Ping-Check.md mdl happy

* make Distributed-Poller.md as mdl happy as possible

* make Dispatcher-Service.md as mdl happy as possible

* make Device-Groups.md mdl happy

* make Dell-OpenManage.md mdl happy

* make Dashboard.md mdl happy

* make Customizing-the-Web-UI.md as mdl happy as possible

* make Component.md mdl happy

* make Billing-Module.md mdl happy

* make Auto-Discovery.md mostly mdl happy

* make Authentication.md as mdl happy as possible

* tidy up a few lines in Applications.md

* make Agent-Setup.md as mdl happy as possible

* make metrics/OpenTSDB.md mdl happy

* spelling fix
2019-09-09 12:48:35 +02:00
ifred16
77d94a458b Allow filtering of getUserlist LDAP function (#10399)
* Modification of the getUserlist fonction to use ldap filter

* Modification of the getUserlist fonction to use ldap filter V2

* documentation of auth_ldap_Userlist_filter option

* documentation of auth_ldap_Userlist_filter option V2

* Allow filtering of getUserlist LDAP function
2019-07-23 22:57:16 -05:00
Austin
a6ecff380b Fixed typo: Administartor (#10437)
Corrected spelling of "Administartor" to "Administrator".
2019-07-11 22:47:52 +02:00
dsmfool
4504b20468 Updated JumpCloud authentication example (#9722)
* Updated JumpCloud authentication example

Updated JumpCloud authentication example.  Relevant Community Support Thread: https://community.librenms.org/t/ldap-with-jumpcloud/6883

* Updated JumpCloud authentication example.

Updated JumpCloud authentication example in accordance with @murrant review.
2019-02-15 09:02:17 -06:00
FTBZ
687a390ee9 doc: add information about auth modules (#9760) 2019-01-30 21:02:18 -06:00
Neil Lathwood
1ee2e8e0e0 Updated to use new theme for docs site (#9320)
* Updated to use new theme for docs site

* Updated theme location

* Removed librenms.css

* Updated index page + re-added librenms.css

* Use built in theme modification

* flexbox grid, dump bootstrap

* tidy up things

* Added path and updated deploy script + mkdocs config

* Removed db schmea changes

* Updated to install python/pip 3

* Removed pip3 install

* Pip3 install

* Updated deploy-docs

* Updated deploy-docs
2018-10-27 23:04:34 +01:00
lug-gh
4cba0a5244 Syntax error in documentation (#9145)
just found a little syntax error in the docs, nothing special :)

DO NOT DELETE THIS TEXT

#### Please note

> Please read this information carefully. You can run `./scripts/pre-commit.php` to check your code before submitting.

- [x] Have you followed our [code guidelines?](http://docs.librenms.org/Developing/Code-Guidelines/)

#### Testers

If you would like to test this pull request then please run: `./scripts/github-apply <pr_id>`, i.e `./scripts/github-apply 9145`
2018-09-04 14:04:42 +01:00
TheGreatDoc
979f811ea9 Allow to use full DN as value for member attribute instead of member: username (#8969)
Allow to use full DN as value for member attribute instead of member: username

I dont use LDAP so this should be tested with both methods.

For using fulldn as user `$config['ldap_auth_userdn'] = true;` must be set in config.php

This comes from https://community.librenms.org/t/feature-request-full-dn-as-group-member-attibute-in-ldap-auth/4805

DO NOT DELETE THIS TEXT

#### Please note

> Please read this information carefully. You can run `./scripts/pre-commit.php` to check your code before submitting.

- [ x] Have you followed our [code guidelines?](http://docs.librenms.org/Developing/Code-Guidelines/)

#### Testers

If you would like to test this pull request then please run: `./scripts/github-apply <pr_id>`, i.e `./scripts/github-apply 5926`
2018-08-05 13:52:54 +01:00
Tony Murray
5c83aa1e28 refactor: LDAP debug output (#8434)
* LDAP debug
Updated LDAP and AD docs
ldap protocol default to v3 (so we don't have to set it all the time).  If this fails it should revert to v2.
ad was using auth_ad_timeout incorrectly (1 I think)

* Add option to list all users.
2018-03-29 11:40:27 +01:00
Adam Bishop
1c6b7a967f Single Sign-On Authentication Mechanism (#7601)
* Allow the URL a user is sent to after logging out to be customised
This is required for any authentication system that has a magic URL for logging out (e.g. /Shibboleth.sso/Logout).

* Allow auth plugins to return a username

This is a bit cleaner than the current auth flow, which special cases e.g. http authentication

* Add some tests, defaults and documentation

* Add single sign-on authentication mechanism

* Make HTTPAuth use the authExternal/getExternalUsername methods

* Add to acknowledgements

* Add reset method to Auth
2017-11-28 20:40:17 -06:00
Kevin Krumm
d0a5be128b docs: updated the user account types doc (#7794)
* docs: updated the user account types doc

added a bit more info on user account levels.

* added oxidized info

* Update Authentication.md
2017-11-25 15:21:45 -06:00
Kevin Krumm
288b7e5a6e docs: minor changes to Device Troubleshooting/Auth (#7686)
* docs: minor changes to Device Troubleshooting

* docs: minor change to Authentication

* docs: fix link for Alerting take 3

* Update Testing.md
2017-11-08 16:27:23 -06:00
Kevin Krumm
2f703d1788 docs: added allow graphs without login (#7675) 2017-11-08 09:41:38 -06:00
Tony Murray
9d73cd401a feature: LDAP auth update: alerts, api, remember me (#7335)
* feature: LDAP auth update: alerts, api, remember me
Defer ldap connection until it is needed (saves connections from pollers)
Add ability to use a bind account if the server does not allow anonymous bind.
If the server does allow anonymous bind, no config change is needed.
Use Config class

FYI, I have no way to test this.

TODO: update/validate docs

* prevent duplicate users in get_userlist()

* fix bug in Config get for auth_ldap_uid_attribute, `.` should have been `,`
Change case of uidNumber to match common configs (should be case insensitive anyway)

* revert uidnumber case changes and fix up user supplied ones as it is unintuitive that they need to be lowercase.
Add auth_ldap_binddn setting to allow more a more specific way to enter the bind user.
2017-10-30 19:28:40 +00:00
Tony Murray
5e5684f2cd docs: Reorganize authentication documentation (#7329)
Audit headers
Fix a few mistakes
Try to clarify some items
2017-09-13 19:51:39 +01:00
Neil Lathwood
f97b0b87a3 refactor: Updated ldap auth to allow configurable uidnumber field (#7302) 2017-09-08 12:04:59 -05:00
Tony Murray
50b3ffb3cf feature: add timeout to AD auth, default is 5s (#6967)
* feature: add timeout to AD auth, default is 5s
Can be configured by $config['auth_ad_timeout']

* only set timeout during bind operation
2017-07-07 23:05:40 -05:00
Tony Murray
c51fd769c3 docs Move ad bind user to the right section (#6368) 2017-04-05 13:15:51 -05:00
Tony Murray
1ea7af424b feature: bind user for active_directory auth (#6255)
* feature: bind user for active_directory auth
Optional, allows the use of "remember me", API, and alerting.

* missing global (but still may not be working)

* always return a value from reauthenticate()

* Make sure the ldapbind credentials are correct on reauth.
Do not send output if they are incorrect (use d_echo) this breaks ajax calls, etc.
Add scripts/auth_test.php, to make it easier to debug authentication.

* Refine auth_test.php a bit more
A few small cleanups in other places of the auth

* Add auth_test.php to docs
Some more improvements in the auth_test.php output.

* Update Authentication.md
2017-03-29 08:22:02 -05:00
jonathon-k
65f74215d3 feature: Add an option for ad authentication to have a default level (#4801)
* Add an option for ad authentication to have a default level

* rework as a flag indicating unspecified access is global read

* Fix indentation
2016-10-21 11:22:13 -05:00
Eldon Koyle
5749179cf5 feature: Add the ability to include an LDAP filter for users/groups in AD (#4494)
* Add auth_ad_(group|user)_filter options

* use global

* Fix some AD annoyances

Use the power of the LDAP filter to minimize the number of queries and
hopefully help performance in get_userlist, change semantics of
auth_ad_(user|group)_filter in $config to be anded with
samaccountname=USERNAME.

* remove unused variable

* update documentation

* Update Authentication.md
2016-09-21 14:42:59 -05:00
FTBZ
5ef5d65458 docs: Update Authentication.md (#4387)
* Update Authentication.md

Added note for SELinux users with LDAP/AD and Active Directory redundancy

* Update Authentication.md

Remove extra whitespace
2016-09-09 15:18:07 +01:00
Tony Murray
956e18ffcd feature: Better error messages for ad_auth (#4385) 2016-09-09 08:04:03 -05:00
Neil Lathwood
383c50b4f4 Updated docs to have source to use for edit github (#4185)
* Added source link for edit on github

* Updated formatting issues

* Updated formatting issues

* Updated formatting issues
2016-08-24 08:12:20 +01:00
Adam Winberg
1a297b8ac5 Added documentation 2016-05-20 09:47:53 +02:00
awlx
53be46ed7d Changed the text to make it more clear what to change. 2016-02-02 11:37:23 +01:00
awlx
a53f7c3df1 Added description of AD configuration options 2016-02-02 11:14:09 +01:00
Jameson Finney
8ec50f11cd Fixed some typos and formatting issues in docs 2016-01-30 22:37:28 -05:00
Jameson Finney
437d1fc40c Removed extra spaces from ends of lines. 2016-01-30 21:06:58 -05:00
Maximilian Wilhelm
64ce4f335f Add HTTP Authentication / LDAP Authorization module.
This Authentitation / Authorization module provides the ability to let
  the webserver (e.g. Apache) do the user Authentication (using Kerberos
  f.e.) and let libreNMS do the Authorization of the already known user.
  Authorization and setting of libreNMS user level is done by LDAP group
  names specified in the configuration file. The group configuration is
  basicly copied from the existing ldap Authentication module.

  To save lots of redundant queries to the LDAP server and speed up the
  libreNMS WebUI, all information is cached within the PHP $_SESSION as
  long as specified in $config['auth_ldap_cache_ttl'] (Default: 300s).

Signed-off-by: Maximilian Wilhelm <max@rfc2324.org>
2016-01-21 21:49:08 +01:00
laf
57c802cd4e Updated active directory auth to support dashboards 2016-01-17 15:26:35 +00:00
laf
3a299584b0 Added ability to specify default userlevel 2015-12-14 21:52:15 +00:00
laf
dcf4d0f378 Added docs and set default users to level 1 2015-12-13 15:51:15 +00:00