Skip to content
Snippets Groups Projects
Commit bfd2bb19 authored by Jonathan Weth's avatar Jonathan Weth :keyboard:
Browse files

Refactor installation manual | Delete some useless files | Merge requirements... 

Refactor installation manual | Delete some useless files | Merge requirements of pip in requirements.txt | Remove .idea
parent 69d2a338
No related branches found
No related tags found
1 merge request!86Merge school-apps
Expand all Hide whitespace changes
Inline Side-by-side
Showing
with 63 additions and 12559 deletions
.gitignore
+ 3
− 3
View file @ bfd2bb19
......@@ -7,6 +7,6 @@ secure*
*.log
class.pdf
class.tex
.idea
media
node_modules
\ No newline at end of file
.idea/
media/
node_modules/
\ No newline at end of file
.idea/dataSources/ae145b31-953d-4d55-ad07-b49b3287f618.xml deleted 100644 → 0
+ 0
− 8703
View file @ 69d2a338
This diff is collapsed.
.idea/dataSources/ea4cff78-5949-410f-aa64-d6daa5fb293d.xml deleted 100644 → 0
+ 0
− 1777
View file @ 69d2a338
This diff is collapsed.
.idea/dataSources/ef6730d6-e849-4772-acac-62469acab4d2.xml deleted 100644 → 0
+ 0
− 1711
View file @ 69d2a338
This diff is collapsed.
.idea/jsLibraryMappings.xml deleted 100755 → 0
+ 0
− 6
View file @ 69d2a338
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="JavaScriptLibraryMappings">
<file url="file://$PROJECT_DIR$" libraries="{jquery}" />
</component>
</project>
\ No newline at end of file
.idea/misc.xml deleted 100755 → 0
+ 0
− 7
View file @ 69d2a338
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectRootManager" version="2" project-jdk-name="Python 3.7 (SchoolApps)" project-jdk-type="Python SDK" />
<component name="PyCharmProfessionalAdvertiser">
<option name="shown" value="true" />
</component>
</project>
\ No newline at end of file
.idea/modules.xml deleted 100755 → 0
+ 0
− 8
View file @ 69d2a338
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectModuleManager">
<modules>
<module fileurl="file://$PROJECT_DIR$/.idea/school-apps.iml" filepath="$PROJECT_DIR$/.idea/school-apps.iml" />
</modules>
</component>
</project>
\ No newline at end of file
.idea/school-apps.iml deleted 100755 → 0
+ 0
− 42
View file @ 69d2a338
<?xml version="1.0" encoding="UTF-8"?>
<module type="PYTHON_MODULE" version="4">
<component name="FacetManager">
<facet type="django" name="Django">
<configuration>
<option name="rootFolder" value="$MODULE_DIR$/schoolapps" />
<option name="settingsModule" value="schoolapps/settings.py" />
<option name="manageScript" value="manage.py" />
<option name="environment" value="&lt;map/&gt;" />
<option name="doNotUseTestRunner" value="false" />
<option name="trackFilePattern" value="migrations" />
</configuration>
</facet>
</component>
<component name="NewModuleRootManager">
<content url="file://$MODULE_DIR$">
<sourceFolder url="file://$MODULE_DIR$/schoolapps" isTestSource="false" />
<excludeFolder url="file://$MODULE_DIR$/venv" />
</content>
<orderEntry type="jdk" jdkName="Python 3.7 (SchoolApps)" jdkType="Python SDK" />
<orderEntry type="sourceFolder" forTests="false" />
<orderEntry type="library" name="jquery-3.2.1" level="application" />
<orderEntry type="library" name="react.production" level="application" />
<orderEntry type="library" name="react-dom.production" level="application" />
<orderEntry type="library" name="jquery" level="application" />
</component>
<component name="TemplatesService">
<option name="TEMPLATE_CONFIGURATION" value="Django" />
<option name="TEMPLATE_FOLDERS">
<list>
<option value="$MODULE_DIR$/schoolapps/templates" />
<option value="$MODULE_DIR$/schoolapps/timetable/templates" />
<option value="$MODULE_DIR$/schoolapps/untisconnect/templates" />
<option value="$MODULE_DIR$/schoolapps/aub/templates" />
<option value="$MODULE_DIR$/schoolapps/dashboard/templates" />
</list>
</option>
</component>
<component name="TestRunnerService">
<option name="PROJECT_TEST_RUNNER" value="Unittests" />
</component>
</module>
\ No newline at end of file
.idea/vcs.xml deleted 100755 → 0
+ 0
− 7
View file @ 69d2a338
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="VcsDirectoryMappings">
<mapping directory="$PROJECT_DIR$" vcs="Git" />
<mapping directory="$PROJECT_DIR$/schoolapps/static/materialize" vcs="Git" />
</component>
</project>
\ No newline at end of file
.idea/webResources.xml deleted 100755 → 0
+ 0
− 14
View file @ 69d2a338
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="WebResourcesPaths">
<contentEntries>
<entry url="file://$PROJECT_DIR$">
<entryData>
<resourceRoots>
<path value="file://$PROJECT_DIR$/schoolapps/static" />
</resourceRoots>
</entryData>
</entry>
</contentEntries>
</component>
</project>
\ No newline at end of file
README.md
+ 49
− 48
View file @ bfd2bb19
......@@ -3,11 +3,11 @@
## Apps
siehe Wiki
## Installation
**Hinweis:** Es werden nur Linux-basierte Systeme unterstützt (in dieser Anleitung wird sich auf Debian-basierte Systeme wie Ubuntu oder Linux Mint bezogen, Arch-Derivate u. Ä. funktionieren aber auch (die Paketnamen sind nur anders, einfach im AUR nachschauen - es werden eine lauffähige Python-3-Umgebung sowie Apache2 und MySQL benötigt)). Außerdem werden Root-Rechte benötigt.
**Hinweis:** Es werden nur Linux-basierte Systeme unterstützt (in dieser Anleitung wird sich auf Debian-basierte Systeme wie Ubuntu oder Linux Mint bezogen). Außerdem werden Root-Rechte benötigt.
### Grundsystem
```
sudo apt install python3 python3-dev python3-pip git mariadb-server python3-venv libldap2-dev libsasl2-dev libmysqlclient-dev
sudo apt install python3 python3-dev python3-pip git mariadb-server python3-venv libldap2-dev libsasl2-dev libmysqlclient-dev pandoc texlive texlive-fonts-extra texlive-lang-german texlive-latex-extra
```
### MySQL-Datenbank
......@@ -16,53 +16,46 @@ sudo apt install python3 python3-dev python3-pip git mariadb-server python3-venv
3. Benutzer `www-data` alle Rechte auf `schoolapps` geben
4. Benutzer `untis-read` anlegen
5. Benutzer `untis-read` Leserechte auf UNTIS-DB geben
```
mysql -u root -p
CREATE USER 'www-data'@'localhost' IDENTIFIED BY 'grummelPASS1531';
GRANT ALL PRIVILEGES ON *.* TO 'www-data'@'localhost';
CREATE USER 'untis-read'@'localhost' IDENTIFIED BY 'grummelPASS1531';
GRANT ALL PRIVILEGES ON *.* TO 'untis-read'@'localhost';
CREATE DATABASE schoolapps;
CREATE DATABASE Untis;
CREATE USER 'www-data'@'localhost' IDENTIFIED BY 'grummelPASS1531';
GRANT ALL PRIVILEGES ON schoolapps.* TO 'www-data'@'localhost';
CREATE USER 'untis-read'@'localhost' IDENTIFIED BY 'grummelPASS1531';
GRANT SELECT ON Untis.* TO 'untis-read'@'localhost';
```
Hinweis: In Testumgebungen kann untis-read auch entfallen und
stattdessen www-data auch für den Zugriff auf die Datenbank `Untis` verwendet werden:
```
GRANT SELECT ON Untis.* TO 'www-data'@'localhost';
```
### UNTIS-Beispieldaten laden
1. PhpMyAdmin öffnen und die Datei untiskath.sql vom Forum importieren.
### UNTIS-Beispieldaten importieren
Zum Testen kann die Datei `untiskath.sql` vom Forum in die Datenbank `Untis` importiert werden.
### SchoolApps clonen
```
git clone git@github.com:Katharineum/school-apps.git
```
- Anmelden
### Django
- Zum Installationsordner wechseln
### Django installieren
- Zum Installationsordner wechseln, dann:
```
python3 -m venv env
source env/bin/activate
pip install mysqlclient
pip install django
pip install django-auth-ldap
pip install django-dbsettings
pip install django_pdb
pip install django-material
pip install django-filter
pip install django_react_templatetags
pip install kanboard
pip install PyPDF2
pip install django-widget-tweaks
pip install requests
pip install -r requirements.txt
```
- `example_secure_settings.py` zu `secure_settings.py` kopieren und anpassen
### Submodules updaten
```
git submodule init
git submodule update
```
- `example_secure_settings.py` zu `secure_settings.py` kopieren und anpassen (hier müssen auch die passenden DB-Zugangsdaten eingetragen werden)
### Migrations auflösen
Leider kommt es bei einer Erstinstallation von SchoolApps immer zu Problemen mit den Migrations. Sollte es Schwierigkeiten geben, @hansegucker kontaktieren.
### Migrations durchführen/auflösen
Leider kommt es bei einer Erstinstallation von SchoolApps immer noch zu Problemen mit den Migrations. Sollte es Schwierigkeiten geben, @hansegucker kontaktieren.
Für die Migration folgende Befehle im aktivierten VirtualEnv ausführen:
```
......@@ -70,38 +63,46 @@ python3 schoolapps/manage.py makemigrations
python3 schoolapps/manage.py migrate
```
### Testlauf
- Administratornutzer erstellen
```
python3 schoolapps/manage.py createsuperuser
```
- Django-Devserver starten
```
python3 schoolapps/manage.py runserver
```
- Einstellungen anpassen (http://127.0.0.1:8080/settings, siehe auch "Kanboard-Verbindung einrichten")
- SchoolApps benutzen 😃
### Kanboard-Verbindung einrichten
1. Zu den [Einstellungen](http://localhost:8000/settings) navigieren (/settings)
1. Zu den [Einstellungen](localhost:8000/settings) navigieren (/settings)
2. Den Kanboard-API-Key von [Kanboard](https://kanboard.katharineum.de/?controller=ConfigController&action) eintragen
3. Die Project-IDs von ``Rebus`` (#4) und ``Feedback`` (#18) eintragen.
4. Die richtigen E-Mailadressen eintragen.
3. Die Project-IDs von `REBUS` (#4) und `Feedback` (#18) eintragen
4. Die richtigen E-Mailadressen eintragen
### Testlauf
## LDAP (info.katharineum.de)
**WICHTIG: LDAP funktioniert nur bei Root-Zugriff auf dem Infoserver!**
**WICHTIG:** LDAP funktioniert nur mit Nutzern, die folgende Gruppe haben: `info-admins`
#### Adresse vom Info aus:
localhost:389
#### Adresse lokal von info.katharineum.de
`localhost:389`
#### BIND-Nutzer
DN: uid=readldap,ou=people,dc=skole,dc=skolelinux,dc=no
PW: grummelPASS1531
DN: `uid=readldap,ou=people,dc=skole,dc=skolelinux,dc=no`
PW: `grummelPASS1531`
#### BASIS DN
dc=skole,dc=skolelinux,dc=no
#### Basis-DN
`dc=skole,dc=skolelinux,dc=no`
#### SSH-Tunnel herstellen
```sudo ssh -L 389:localhost:389 <user>@info.katharineum.de -N ```
(<user> durch Nutzer ersetzen)
(`<user>` durch Nutzer mit Gruppe `info-admins` ersetzen)
#### Verbindung testen
1. Tunnel erstellen (siehe Befehl)
2. Apache Active Directory (AD) zum Testen öffnen (Download unter http://directory.apache.org/studio/)
3. Verbindung in AD mit oben genannten Daten herstellen
schoolapps/LDAP-groups-et-al.patch deleted 100644 → 0
+ 0
− 104
View file @ 69d2a338
diff --git a/schoolapps/manage.py b/schoolapps/manage.py
index d450e49..bee7dd5 100755
--- a/schoolapps/manage.py
+++ b/schoolapps/manage.py
@@ -1,7 +1,9 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
import os
import sys
+sys.path = ["/srv/sites/school-apps/env/lib/python3.5/site-packages/"] + sys.path
+
if __name__ == "__main__":
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "schoolapps.settings")
try:
@@ -11,5 +13,5 @@ if __name__ == "__main__":
"Couldn't import Django. Are you sure it's installed and "
"available on your PYTHONPATH environment variable? Did you "
"forget to activate a virtual environment?"
- ) from exc
+ )
execute_from_command_line(sys.argv)
diff --git a/schoolapps/schoolapps/settings.py b/schoolapps/schoolapps/settings.py
index c05dba5..c1ba2d3 100755
--- a/schoolapps/schoolapps/settings.py
+++ b/schoolapps/schoolapps/settings.py
@@ -12,8 +12,8 @@ https://docs.djangoproject.com/en/2.0/ref/settings/
import os
import ldap
-from django_auth_ldap.config import LDAPSearch, GroupOfNamesType, LDAPGroupType
-from posixgrouptype import PosixGroupType
+from django_auth_ldap.config import LDAPSearch, PosixGroupType, GroupOfNamesType, LDAPGroupType
+#from posixgrouptype import PosixGroupType
import logging
from .secure_settings import *
@@ -27,6 +27,9 @@ BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True
+# PDB debugger option
+POST_MORTEM = True
+
ALLOWED_HOSTS = [
'info.katharineum.de',
'178.63.239.184',
@@ -37,6 +40,7 @@ ALLOWED_HOSTS = [
# Application definition
INSTALLED_APPS = [
+ 'django_pdb',
'dashboard.apps.DashboardConfig',
'aub.apps.AubConfig',
'untisconnect.apps.UntisconnectConfig',
@@ -58,6 +62,7 @@ MIDDLEWARE = [
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.middleware.clickjacking.XFrameOptionsMiddleware',
+ 'django_pdb.middleware.PdbMiddleware',
]
ROOT_URLCONF = 'schoolapps.urls'
@@ -163,17 +168,17 @@ TIMETABLE_HEIGHT = 10
# Baseline configuration.
AUTH_LDAP_SERVER_URI = "ldap://127.0.0.1"
AUTH_LDAP_USER_SEARCH = LDAPSearch("dc=skole,dc=skolelinux,dc=no",
- ldap.SCOPE_SUBTREE, "(uid=%(user)s)")
+ ldap.SCOPE_SUBTREE, "(&(objectClass=posixAccount)(uid=%(user)s))")
# or perhaps:
# AUTH_LDAP_USER_DN_TEMPLATE = "uid=%(user)s,ou=users,dc=example,dc=com"
# Set up the basic group parameters.
-AUTH_LDAP_GROUP_SEARCH = LDAPSearch("dc=skole,dc=skolelinux,dc=no,ou=SchoolManager,ou=group", ldap.SCOPE_SUBTREE,
- "(objectClass=posixGroup)")
-# '(&(objectClass=*)(memberUid=%(user))')
-print(ldap.SCOPE_SUBTREE)
+AUTH_LDAP_GROUP_SEARCH = LDAPSearch("dc=skole,dc=skolelinux,dc=no", ldap.SCOPE_SUBTREE,
+ "(&(objectClass=posixGroup)(memberUid=%(user)s))")
+# '(&(objectClass=*)(memberUid=%(user)s)')
+#print(ldap.SCOPE_SUBTREE)
# "(objectClass=organizationalUnit)")
-AUTH_LDAP_GROUP_TYPE = PosixGroupType(name_attr="cn")
+AUTH_LDAP_GROUP_TYPE = PosixGroupType()
# Simple group restrictions
# AUTH_LDAP_REQUIRE_GROUP = "dc=skole,dc=skolelinux,dc=no"
@@ -186,11 +191,11 @@ AUTH_LDAP_USER_ATTR_MAP = {
"email": "mail"
}
-# AUTH_LDAP_USER_FLAGS_BY_GROUP = {
-# "is_active": "cn=active,ou=django,ou=groups,dc=example,dc=com",
-# "is_staff": "cn=staff,ou=django,ou=groups,dc=example,dc=com",
-# "is_superuser": "cn=superuser,ou=django,ou=groups,dc=example,dc=com"
-# }
+AUTH_LDAP_USER_FLAGS_BY_GROUP = {
+# "is_active": "cn=teachers,ou=group,ou=Teachers,dc=skole,dc=skolelinux,dc=no",
+ "is_staff": "cn=schoolapps-admins,ou=group,dc=skole,dc=skolelinux,dc=no",
+ "is_superuser": "cn=schoolapps-admins,ou=group,dc=skole,dc=skolelinux,dc=no",
+}
# This is the default, but I like to be explicit.
AUTH_LDAP_ALWAYS_UPDATE_USER = True
schoolapps/posixgrouptype.py deleted 100644 → 0
+ 0
− 68
View file @ 69d2a338
from django.utils.encoding import force_text
from django_auth_ldap.config import LDAPGroupType
class PosixGroupType(LDAPGroupType):
"""
An LDAPGroupType subclass that handles groups of class posixGroup.
"""
def user_groups(self, ldap_user, group_search):
"""
Searches for any group that is either the user's primary or contains the
user as a member.
"""
groups = []
try:
user_uid = ldap_user.attrs['uid'][0]
# if 'gidNumber' in ldap_user.attrs:
# user_gid = ldap_user.attrs['gidNumber'][0]
# filterstr = '(|(gidNumber={})(memberUid={}))'.format(
# self.ldap.filter.escape_filter_chars(user_gid),
# self.ldap.filter.escape_filter_chars(user_uid)
# )
# else:
filterstr = '(memberUid={})'.format(
self.ldap.filter.escape_filter_chars(user_uid),
)
search = group_search.search_with_additional_term_string(filterstr)
groups = search.execute(ldap_user.connection)
except (KeyError, IndexError):
pass
return groups
def is_member(self, ldap_user, group_dn):
"""
Returns True if the group is the user's primary group or if the user is
listed in the group's memberUid attribute.
"""
try:
user_uid = ldap_user.attrs['uid'][0]
try:
is_member = ldap_user.connection.compare_s(
force_text(group_dn),
'memberUid',
user_uid.encode('utf-8'),
)
except (ldap.UNDEFINED_TYPE, ldap.NO_SUCH_ATTRIBUTE):
is_member = False
if not is_member:
try:
user_gid = ldap_user.attrs['gidNumber'][0]
is_member = ldap_user.connection.compare_s(
force_text(group_dn),
'gidNumber',
user_gid.encode('utf-8'),
)
except (ldap.UNDEFINED_TYPE, ldap.NO_SUCH_ATTRIBUTE):
is_member = False
except (KeyError, IndexError):
is_member = False
return is_member
timetable-old/__init__.py deleted 100755 → 0
+ 0
− 0
View file @ 69d2a338
timetable-old/admin.py deleted 100755 → 0
+ 0
− 3
View file @ 69d2a338
from django.contrib import admin
# Register your models here.
timetable-old/apps.py deleted 100755 → 0
+ 0
− 5
View file @ 69d2a338
from django.apps import AppConfig
class TimetableConfig(AppConfig):
name = 'timetable'
timetable-old/migrations/__init__.py deleted 100755 → 0
+ 0
− 0
View file @ 69d2a338
timetable-old/models.py deleted 100755 → 0
+ 0
− 3
View file @ 69d2a338
from django.db import models
# Create your models here.
timetable-old/templates/timetable/admin/all.html deleted 100755 → 0
+ 0
− 50
View file @ 69d2a338
{% include 'partials/header.html' %}
<main>
<h3>Übersicht</h3>
<div class="row">
<div class="col s12 m4">
<h4>Alle Lehrkräfte</h4>
<ul class="collection">
{% for teacher in teachers %}
<li class="collection-item avatar">
<i class="circle">{{ teacher.shortcode }}</i><!-- Shortcode -->
<a href="{% url 'timetable_plan' 'teacher' teacher.id %}">{{ teacher.first_name }}
<strong>{{ teacher.name }}</strong></a>
</li>
{% endfor %}
</ul>
</div>
<div class="col s12 m4">
<h4>Alle Klassen</h4>
<ul class="collection">
{% for class in classes %}
<li class="collection-item avatar">
<i class="circle">{{ class.name }}</i>
<a href="{% url 'timetable_plan' 'class' class.id %}"><strong>{{ class.name }}</strong></a>
<p>
{{ class.text1|default:"" }} – {{ class.text2|default:"" }} <br>
Raum: {{ class.room.name|default:"---" }}
</p>
</li>
{% endfor %}
</ul>
</div>
<div class="col s12 m4">
<h4>Alle Räume</h4>
<ul class="collection">
{% for room in rooms %}
<li class="collection-item avatar">
<i class="circle">{{ room.shortcode }}</i>
<a href="{% url 'timetable_plan' 'room' room.id %}"><strong>{{ room.name }}</strong></a>
</li>
{% endfor %}
</ul>
</div>
</div>
</main>
{% include 'partials/footer.html' %}
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