Update README.md

This commit is contained in:
Eric Meehan 2024-12-06 09:19:59 -05:00
parent 5a7f4a4d09
commit a01de1158d

View File

@ -1,25 +1,25 @@
# mediawiki-ldap
# mediawiki-extended
The goal of this container is to have an easily deploayble mediawiki with the extensions for LDAP already integrated.
I had to install mediawiki for multiple customers and got frustrated fiddling with the LDAP extensions everytime.
## Features
- Based on https://github.com/wikimedia/mediawiki-docker
- Based on https://github.com/sodema/mediawiki-ldap
- A docker-compose file to run directly
- integrated LDAPAuthentication2, LDAPAuthorization, LDAPGroups, LDAPProvider, LDAPSyncAll, LDAPUserInfo, PluggableAuth, Auth_remoteuser from official Mediawiki git
- All LDAP related settings are handled via .env file
- Custom LocalSettings.LDAP.php which includes all the tweaks for connecting to LDAP
- One-Klick installer / doensn't use the web based installation procedure
- persistent volumes, so you can edit LocalSettings.php & LocalSettings.LDAP.php
-
- Also includes ExternalData, Cite, Cargo, Math, and PageForms extensions
## Usage
```
git clone https://github.com/sodema/mediawiki-ldap.git
cd mediawiki-ldap
docker build build/. -t mediawiki-ldap:latest
git clone https://gitea.eom.dev/DevOps/mediawiki-extended.git
cd mediawiki-extended
docker build build/. -t mediawiki-extended:latest
mv example.env .env
(vi/nano/???) .env
(vi/nano/???) docker-compose.yml
@ -28,7 +28,7 @@ docker logs -f mediawiki-db
docker logs -f mediawiki-app
./run_install.sh
```
Instead of building yourself you can also just `docker pull sodema/mediawiki-ldap:latest`
Instead of building yourself you can also just `docker pull ericomeehan/mediawiki-extended:latest`
## Environment Variables
@ -44,6 +44,12 @@ LDAP_ENCTYPE=ssl # Encryption t
LDAP_USER_ATTR=uid # Attribute to identify user 'uid' or 'cn'
LDAP_BIND_USER="uid=readonly,cn=users,dc=yourdomain,dc=local" # User to bind to LDAP
LDAP_BIND_PASS="SecretBindPassword" # Bind Password
LDAP_SEARCH_FILTER="(&(objectClass=inetOrgPerson))" # Search filter
LDAP_MAIL_ATTR=mail # Email attribute
LDAP_REAL_NAME_ATTR=givenName # First name attribute
LDAP_BUREAUCRAT_GROUP="cn=bureaucrat,ou=groups,dc=example,dc=com" # Bureaucrat group mapping
LDAP_INTERFACE_ADMIN_GROUP="cn=admin,ou=groups,dc=example,dc=com" # Interface admin group mapping
LDAP_SYSOP_GROUP="cn=sysop,ou=groups,dc=example,dc=com" # Sysop group mapping
DB_HOST=mediawiki-db # Hostname of DB server
DB_PORT=3306 # DB server Port
DB_NAME=mediawiki # Name of your Wiki DB