diff --git a/README.md b/README.md index 4b80a9d..6660458 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,20 @@ -## ungleich frontend +# Ungleich Account Management Webapp -The frontend pages of ungleich micro services +This service runs on [account.ungleich.ch](https://account.ungleich.ch/) and +allows customers manage their ungleich account (register, edit mail & password, +...). -* login: dump-via-wget/datacenterlight.ch/en-us/hosting/login.html +Makes use of Django 2.2 LTS (not compatible with 3.0 at the moment) which is +supported until early 2022. + +## Development Setup + +* Clone this repository and enter top-level directory. +* (Optional) Setup a Python virtualenv and install dependencies via pip: + - `virtualenv .venv` + - `source .venv/bin/activate` + - `pip install -r requirements.txt` + - Note: you might have to install some OS dependencies (i.e. libldap2, libsasl). +* Configure the `dal` django app (uses the [decouple](https://pypi.org/project/python-decouple/) library underneath) + - Copy `dal/env.sample` to `dal/.env` + - Populate `dal/.env` diff --git a/dal/env.sample b/dal/env.sample index a27b883..a404f03 100644 --- a/dal/env.sample +++ b/dal/env.sample @@ -1,10 +1,37 @@ # Create .env to be loaded automatically +# XXX: Salvaged from production, don't ask me why some settings are duplicated. -LDAPSERVER="ldap://ldap1.ungleich.ch ldap://ldap2.ungleich.ch" -LDAPSEARCHUSER="user here" -LDAPSEARCHUSERPASSWORD="password here" +LDAPSERVER="" +LDAPSEARCHUSER="" +LDAPSEARCHUSERPASSWORD="" +LDAP_CUSTOMER_DN="" +LDAP_USERS_DN="" + +LDAP_SERVER="" +LDAP_ADMIN_DN="" +LDAP_ADMIN_PASSWORD="" # Space separated list of search bases for users -LDAPSEARCH="ou=users,dc=ungleich,dc=ch ou=customers,dc=ungleich,dc=ch" -LDAPCREATE="ou=customers,dc=ungleich,dc=ch" +LDAPSEARCH="" +LDAPCREATE="" +LDAP_CUSTOMER_DN="" +LDAP_DEFAULT_START_UID= +LDAP_CUSTOMER_GROUP_ID= +ENTIRE_SEARCH_BASE="" + +#LDAP_USE_TLS=True +SECRET_KEY="" +ALLOWED_HOSTS="localhost:8000,localhost" +DEBUG=True +ENABLE_DEBUG_LOG=True +MODULES_TO_LOG=django_auth_ldap,dal,django +EMAIL_FROM_ADDRESS="" + +#Otp +ALLOWED_REALMS='' +OTPSERVER='' +ADMIN_SEED='' +ADMIN_NAME='' +ADMIN_REALM='' +USER_REALM=''