jellyfin-plugin-ldapauth/README.md

<h1 align="center">Jellyfin LDAP-Auth Plugin</h1>
<h3 align="center">Part of the <a href="https://jellyfin.org">Jellyfin Project</a></h3>

<p align="center">
<img alt="Plugin Banner" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/plugins/SVG/jellyfin-plugin-ldapauth.svg?sanitize=true"/>
<br/>
<br/>
<a href="https://github.com/jellyfin/jellyfin-plugin-ldapauth/actions/workflows/test.yaml">
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/jellyfin/jellyfin-plugin-ldapauth/.github/workflows/test.yaml?branch=master">
</a>
<a href="https://github.com/jellyfin/jellyfin-plugin-ldapauth">
<img alt="MIT License" src="https://img.shields.io/github/license/jellyfin/jellyfin-plugin-ldapauth.svg"/>
</a>
<a href="https://github.com/jellyfin/jellyfin-plugin-ldapauth/releases">
<img alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin-plugin-ldapauth.svg"/>
</a>
</p>

## About

LDAP authentication for Jellyfin Media Server. JelLDAP, if you will.

Authenticate your Jellyfin users against an LDAP database, and optionally create users who do not yet exist automatically.

Allows the administrator to customize most aspects of the LDAP authentication process, including customizable search attributes, username attribute, and a search filter for administrative users (set on user creation). The user, via the "Manual Login" process, can enter any valid attribute value, which will be mapped back to the specified username attribute automatically as well.

## Installation

[See the official documentation for install instructions](https://jellyfin.org/docs/general/server/plugins/index.html#installing).

## Build

1. To build this plugin you will need [.Net 6.x](https://dotnet.microsoft.com/download/dotnet/6.0).

2. Build plugin with following command
  ```
  dotnet publish --configuration Release --output bin
  ```

3. Place the dll-file in the `plugins/ldapauth` folder (you might need to create the folders) of your JF install

## Releasing

To release the plugin we recommend [JPRM](https://github.com/oddstr13/jellyfin-plugin-repository-manager) that will build and package the plugin.
For additional context and for how to add the packaged plugin zip to a plugin manifest see the [JPRM documentation](https://github.com/oddstr13/jellyfin-plugin-repository-manager) for more info.

## Contributing

We welcome all contributions and pull requests! If you have a larger feature in mind please open an issue so we can discuss the implementation before you start.
In general refer to our [contributing guidelines](https://github.com/jellyfin/.github/blob/master/CONTRIBUTING.md) for further information.

## Licence

This plugins code and packages are distributed under the MIT License. See [LICENSE](./LICENSE) for more information.
update readme 2020-07-30 23:14:29 +00:00			`<h1 align="center">Jellyfin LDAP-Auth Plugin</h1>`
Update README.md Fix the link to the Jellyfin Project 2023-10-31 08:35:09 +00:00			`<h3 align="center">Part of the <a href="https://jellyfin.org">Jellyfin Project</a></h3>`
update readme 2020-07-30 23:14:29 +00:00
			`<p align="center">`
update readme 2021-03-18 21:47:36 +00:00			`<img alt="Plugin Banner" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/plugins/SVG/jellyfin-plugin-ldapauth.svg?sanitize=true"/>`
update readme 2020-07-30 23:14:29 +00:00			`<br/>`
			`<br/>`
Fix "build" shields badge (#152) 2023-11-22 01:51:53 +00:00			`<a href="https://github.com/jellyfin/jellyfin-plugin-ldapauth/actions/workflows/test.yaml">`
			`<img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/jellyfin/jellyfin-plugin-ldapauth/.github/workflows/test.yaml?branch=master">`
update readme 2020-11-29 00:05:00 +00:00			`</a>`
update readme 2020-07-30 23:14:29 +00:00			`<a href="https://github.com/jellyfin/jellyfin-plugin-ldapauth">`
update readme 2020-11-29 00:05:00 +00:00			`<img alt="MIT License" src="https://img.shields.io/github/license/jellyfin/jellyfin-plugin-ldapauth.svg"/>`
update readme 2020-07-30 23:14:29 +00:00			`</a>`
			`<a href="https://github.com/jellyfin/jellyfin-plugin-ldapauth/releases">`
			`<img alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin-plugin-ldapauth.svg"/>`
			`</a>`
			`</p>`
Add sufficient puns 2019-04-09 02:57:07 +00:00
update readme 2021-03-18 21:47:36 +00:00			`## About`
update readme 2020-11-29 00:05:00 +00:00
Add sufficient puns 2019-04-09 02:57:07 +00:00			`LDAP authentication for Jellyfin Media Server. JelLDAP, if you will.`
update readme 2020-07-30 23:14:29 +00:00
update readme 2020-11-29 00:05:00 +00:00			`Authenticate your Jellyfin users against an LDAP database, and optionally create users who do not yet exist automatically.`

			`Allows the administrator to customize most aspects of the LDAP authentication process, including customizable search attributes, username attribute, and a search filter for administrative users (set on user creation). The user, via the "Manual Login" process, can enter any valid attribute value, which will be mapped back to the specified username attribute automatically as well.`

add basic install instructions to readme 2020-11-29 19:09:52 +00:00			`## Installation`

change to link official doc instead of duplication 2020-12-03 19:08:43 +00:00			`[See the official documentation for install instructions](https://jellyfin.org/docs/general/server/plugins/index.html#installing).`
add basic install instructions to readme 2020-11-29 19:09:52 +00:00
update readme 2021-03-18 21:47:36 +00:00			`## Build`
update readme 2020-07-30 23:14:29 +00:00
Update README build steps to require .Net 6.x 2021-11-12 21:17:55 +00:00			`1. To build this plugin you will need [.Net 6.x](https://dotnet.microsoft.com/download/dotnet/6.0).`
update readme 2020-07-30 23:14:29 +00:00
update readme 2021-03-18 21:47:36 +00:00			`2. Build plugin with following command`
			```
			`dotnet publish --configuration Release --output bin`
			```
update readme 2020-07-30 23:14:29 +00:00
update readme 2021-03-18 21:47:36 +00:00			3. Place the dll-file in the `plugins/ldapauth` folder (you might need to create the folders) of your JF install
update readme 2020-07-30 23:14:29 +00:00
update readme 2021-03-18 21:47:36 +00:00			`## Releasing`
update readme 2020-07-30 23:14:29 +00:00
update readme 2021-03-18 21:47:36 +00:00			`To release the plugin we recommend [JPRM](https://github.com/oddstr13/jellyfin-plugin-repository-manager) that will build and package the plugin.`
			`For additional context and for how to add the packaged plugin zip to a plugin manifest see the [JPRM documentation](https://github.com/oddstr13/jellyfin-plugin-repository-manager) for more info.`
update readme 2020-07-30 23:14:29 +00:00
update readme 2021-03-18 21:47:36 +00:00			`## Contributing`
update readme 2020-07-30 23:14:29 +00:00
update readme 2021-03-18 21:47:36 +00:00			`We welcome all contributions and pull requests! If you have a larger feature in mind please open an issue so we can discuss the implementation before you start.`
			`In general refer to our [contributing guidelines](https://github.com/jellyfin/.github/blob/master/CONTRIBUTING.md) for further information.`
update readme 2020-07-30 23:14:29 +00:00
update readme 2021-03-18 21:47:36 +00:00			`## Licence`
update readme 2020-07-30 23:14:29 +00:00
update readme 2021-03-18 21:47:36 +00:00			`This plugins code and packages are distributed under the MIT License. See [LICENSE](./LICENSE) for more information.`