Commit c3a7d44f authored by Jens Langhammer's avatar Jens Langhammer

add LDAP docs, update package install docs

parent a50322a3
Pipeline #3386 passed with stages
in 6 minutes and 42 seconds
......@@ -31,14 +31,14 @@ external_auth_only: false
auto_claim_enabled: true
# LDAP Authentication
ldap:
enabled: false
server:
uri: 'ldap://dc1.example.com'
tls: false
bind:
dn: ''
password: ''
search_base: ''
filter: '(sAMAccountName=%(user)s)'
require_group: ''
# ldap:
# enabled: false
# server:
# uri: 'ldap://dc1.example.com'
# tls: false
# bind:
# dn: ''
# password: ''
# search_base: ''
# filter: '(sAMAccountName=%(user)s)'
# require_group: ''
# LDAP Authentication
pyazo supports Authentication against LDAP or Active Directory.
To configure LDAP, uncomment the following section in the `config.yml` file:
```yml
# LDAP Authentication
ldap:
enabled: true
server:
uri: 'ldap://dc1.example.com'
tls: false
bind:
dn: ''
password: ''
search_base: ''
filter: '(sAMAccountName=%(user)s)'
require_group: false
```
The `filter_group` setting is optional and can be used to specify the DN of a group the user has to be member of.
Pyazo is a python-based application. There are 2 different packages, one for Python 3.5.x and one for Python 3.6.x. To find out what version you have, run this:
# Installation
```
python3 -c 'import sys;print(sys.version)'
```
pyazo is a python-based application which requires Python 3.5 or newer.
The following services are also a requirement:
- MySQL/MariaDB
- Redis
By default, APT will install these services on the same server as pyazo is on. This can be omitted by running apt with `--no-install-recommends`.
## Add the repository
......@@ -17,7 +22,7 @@ apt update
After the commands finish, you can install the package for the python version shown above:
```
apt install pyazo-python3.5 # or pyazo-python3.6
apt install pyazo
```
## Create a superuser
......
......@@ -62,17 +62,17 @@ data:
auto_claim_enabled: true
# LDAP Authentication
ldap:
enabled: false
server:
uri: 'ldap://dc1.example.com'
tls: false
bind:
dn: ''
password: ''
search_base: ''
filter: '(sAMAccountName=%(user)s)'
require_group: ''
# ldap:
# enabled: false
# server:
# uri: 'ldap://dc1.example.com'
# tls: false
# bind:
# dn: ''
# password: ''
# search_base: ''
# filter: '(sAMAccountName=%(user)s)'
# require_group: ''
{{- if .Values.config.secret_key }}
secret_key: {{ .Values.config.secret_key }}
......
......@@ -2,7 +2,7 @@ site_name: Pyazo Documentation
theme:
name: 'readthedocs'
repo_url: "https://git.beryju.org/BeryJu.org/pyazo"
pages:
nav:
- Home: index.md
- Installation:
- Package: install/package.md
......@@ -12,5 +12,6 @@ pages:
- Reverse Proxy: configuration/nginx_reverse_proxy.md
- Migration between systems: configuration/migration_between_systems.md
- MSSQL: configuration/mssql.md
- LDAP: configuration/ldap.md
- API:
- Endpoints: api/api_endpoints.md
......@@ -48,7 +48,7 @@ auto_claim_enabled: true
ldap:
enabled: false
server:
uri: "ldap://dc1.example.com"
uri: ""
tls: false
bind:
dn: ""
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment