Add doc for installation
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/push Build is passing
Details
This commit is contained in:
philipp lang
parent
b120e5a039
commit
50dc714f18
|
|
@ -27,6 +27,7 @@ baseurl: '' # the subpath of your site, e.g. /blog
|
|||
url: '' # the base hostname & protocol for your site, e.g. http://example.com
|
||||
twitter_username:
|
||||
github_username: zoomyboy
|
||||
source: page
|
||||
|
||||
# Aux links for the upper right navigation
|
||||
aux_links:
|
||||
|
|
@ -41,9 +42,19 @@ color_scheme: dark
|
|||
plugins:
|
||||
- jekyll-feed
|
||||
callouts:
|
||||
para:
|
||||
title: Info
|
||||
block:
|
||||
color: grey-lt
|
||||
warning:
|
||||
color: yellow
|
||||
title: Warnung
|
||||
info:
|
||||
color: blue
|
||||
title: Info
|
||||
defaults:
|
||||
- scope:
|
||||
path: 'assets/img'
|
||||
values:
|
||||
image: true
|
||||
# Exclude from processing.
|
||||
# The following items will not be processed, by default.
|
||||
# Any item listed under the `exclude:` key here will be automatically added to
|
||||
|
|
|
|||
17
doc/about.md
17
doc/about.md
|
|
@ -1,17 +0,0 @@
|
|||
---
|
||||
layout: page
|
||||
title: About
|
||||
---
|
||||
|
||||
This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at [jekyllrb.com](https://jekyllrb.com/)
|
||||
|
||||
You can find the source code for Minima at GitHub:
|
||||
[jekyll][jekyll-organization] /
|
||||
[minima](https://github.com/jekyll/minima)
|
||||
|
||||
You can find the source code for Jekyll at GitHub:
|
||||
[jekyll][jekyll-organization] /
|
||||
[jekyll](https://github.com/jekyll/jekyll)
|
||||
|
||||
|
||||
[jekyll-organization]: https://github.com/jekyll
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
---
|
||||
layout: page
|
||||
title: Erste Schritte
|
||||
has_children: true
|
||||
---
|
||||
|
||||
# Erste Schritte
|
||||
|
||||
Dieses Dokument beschreibt die ersten Grundeinstellungen nach der Installation von Adrema.
|
||||
|
||||
Als erstes solltest du deine Zugangsdaten und deine Gruppierungsnummer, sowie die "Über-Gruppierung" herausfinden.
|
||||
|
||||
Melde dich dann mit deinen Benutzerdaten an.
|
||||
|
||||
## 1. NaMi-Zugangsdaten eingeben
|
||||
|
||||
Gebe deine NaMi-Zugangsdaten ein. Diese werden danach geprüft. Wenn diese korrekt sind, wirst du zum nächsten Schritt weitergeleitet.
|
||||
|
||||
## 2. Suchparameter definieren
|
||||
|
||||
Nun solltest du Parameter für die NaMi-Suche definieren, die beim täglichen Abruf angewendet werden.
|
||||
|
||||
Gebe deine Gruppierungsnummer und deren Ober-Gruppierungen ein. Du bekommst dann eine Vorschau eingeblendet.
|
||||
|
||||
> Dies ist nur eine Vorschau der Suchergebnisse. Es findet hier noch kein realer Abgleich statt.
|
||||
|
||||
## 3. Standard-Gruppierungsnummer
|
||||
|
||||
Für einige Prozesse benötigt Adrema die Standard-Gruppierungsnummer. Dies ist i.d.R. die Gruppierungsnummer deiner lokalen Gruppierung die du verwalten willst (z.B. dein Stamm).
|
||||
|
||||
## 4. Initialisierung starten
|
||||
|
||||
Danach führt Adrema im Hintergrund selbstständig einen ersten Abgleich durch. Dies kann je nach Datenmenge einige Minuten bis Stunden dauern.
|
||||
|
|
@ -1,34 +0,0 @@
|
|||
---
|
||||
layout: page
|
||||
title: Installation
|
||||
parent: Erste Schritte
|
||||
---
|
||||
|
||||
# Versionierung
|
||||
|
||||
## Ein Beispiel
|
||||
|
||||
> Eine Stammesvorsitzende - nennen wir sie Petra - öffnet ein Mitglied in NaMi, um eine Änderung der Adresse vorzunehmen
|
||||
>
|
||||
> Währenddessen ändert jemand anderes - nennen wir ihn Bob - die Telefonnummer des gleichen Mitglieds
|
||||
>
|
||||
> Petra speichert nun das Mitglied mit der __neuen Adresse__ ab, obwohl bei ihr im "bearbeiten-Formular" noch die __alte Telefonnummer__ steht.
|
||||
>
|
||||
> Resultat: Die Änderung der Adresse (Petras Änderung) wurde übernommen. Die Änderung von Bob (die Änderung der Telefonnummer) wurde aber überschrieben.
|
||||
> Das Mitglied hat also nun die neue Adresse, aber noch die alte Telefonnummer.
|
||||
|
||||
Da auch übergeordnete Ebenen auf die Mitglieder der DPSG Zugriff haben und diese häufig auch bearbeiten können, ist dieses Szenario durchaus denkbar.
|
||||
|
||||
Die NaMi löst dieses Problem intern mit einer Versionsnummer, die jedes Mal um 1 erhöht wird, wenn jemand Änderungen an den Basisdaten vornimmt. So lässt sich feststellen, dass zwischenzeitlich eine Änderung durch eine\*n dritte\*n erfolgt ist.
|
||||
|
||||
## Versionen in Adrema
|
||||
|
||||
Die Adrema macht sich dieses System zunutze. Vor einem Update wird geprüft, ob zwischenzeitlich ein Update in NaMi vorgenommen wurde. Ist das der Fall, wird ein Hinweis angezeigt:
|
||||
|
||||
Du hast hier nun zwei Optionen:
|
||||
|
||||
> 1. Du aktualisierst das Mitglied in Adrema. Dadurch werden deine Änderungen rückgängig gemacht und das Mitglied erneut aus NaMi abgerufen. Danach kannst du deine Änderung erneut vornehmen.
|
||||
>
|
||||
> 2. Du aktualisierst das Mitglied. Dabei spielt der aktuelle NaMi-Stand keine Rolle. __Dabei kann es allerdings zu Datenverlust kommen__ (wie oben beschrieben).
|
||||
|
||||
Auf diese Art und Weise ist sichergestellt, dass Änderungen sich nicht gegenseitig überschreiben.
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
<figure style="display: flex; flex-direction: column; justify-content: center;">
|
||||
<img src="/assets/img/{{ include.img }}.jpg" style="max-width: 90%; margin: 0 auto;"/>
|
||||
<figcaption style="text-align: center; font-size: 0.8rem; margin-top: 0.4rem;">{{ include.caption }}</figcaption>
|
||||
</figure>
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 29 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 87 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 184 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
|
|
@ -0,0 +1,47 @@
|
|||
---
|
||||
layout: page
|
||||
title: Grundeinstellungen
|
||||
parent: Erste Schritte
|
||||
nav_order: 2
|
||||
---
|
||||
|
||||
Dieses Dokument beschreibt die ersten Grundeinstellungen nach der Installation von Adrema.
|
||||
|
||||
## Anmeldung in NaMi
|
||||
|
||||
Als erstes solltest du deine Zugangsdaten zu NaMi (deine Mitgliedsnummer und dein Passwort) eingeben, um dich einmalig anzumelden. Deine Zugangsdaten werden in Adrema gespeichert und müssen nur bei der Ersteinrichtung einmalig angegeben werden.
|
||||
|
||||
{: .info }
|
||||
Der NaMi Benutzer sollte Schreibrechte auf der gewünschten Gruppierung haben. Grundsätzlich lässt sich Adrema auch mit NaMi-Accounts nutzen, die nur Leserechte haben. Dann kann man aber keine NaMi-Daten aktualisieren, bzw nur Adrema-interne Änderungen vornehmen (was langweilig ist :D )
|
||||
|
||||
{% include imgcap.html img='init-login' caption="Login in NaMi" %}
|
||||
|
||||
## Suchparameter definieren
|
||||
|
||||
Nun solltest du Parameter für die NaMi-Suche definieren, die beim täglichen Abruf angewendet werden.
|
||||
|
||||
Dabei ist es notwendig, zuerst die Diözesan-Gruppierungsnummer anzugeben. Wenn du diese nicht weißt, gehe in NaMi auf den Reiter "Suche" und wähle bei "1. Ebene (Diözese)" deine Gruppierung aus. Dort erscheint dann die Gruppierungsnummer (eine 6-Stellige Zahl). Diese ist hier einzugeben.
|
||||
|
||||
Danach kannst du mit der Bezirks-Ebene weiter verfahren (analog "2. Ebene (Bezirk)" in NaMi).
|
||||
|
||||
Du kannst beim Mitglieds-Status auswählen, ob du nur aktive Mitglieder, nur inaktive Mitglieder oder beides ("kein") abrufen willst.
|
||||
|
||||
Du bekommst im unteren Bereich eine Vorschau eingeblendet, welche Mitglieder abgerufen werden würden. Dies ist lediglich eine Vorschau eines Live-Abrufs aus NaMi - es handelt sich also nicht um einen vollständigen Adrema-Datensatz, da wichtige Infos wie z.B. Geburtsdaten in diesem Prozess noch nicht abgerufen werden.
|
||||
|
||||
{% include imgcap.html img='init-members' caption="Suchparameter" %}
|
||||
|
||||
Wenn du mit der Vorschau zufrieden bist, klicke auf "weiter".
|
||||
|
||||
## Standard-Gruppierungsnummer
|
||||
|
||||
Für einige Prozesse benötigt Adrema die Standard-Gruppierungsnummer. Dies ist i.d.R. die Gruppierungsnummer deiner lokalen Gruppierung die du verwalten willst (z.B. dein Stamm).
|
||||
|
||||
{% include imgcap.html img='init-default-groupid' caption="Standard-Gruppierungsnummer" %}
|
||||
|
||||
## 4. Initialisierung starten
|
||||
|
||||
Danach führt Adrema im Hintergrund selbstständig einen ersten Abgleich durch. Dies kann je nach Datenmenge einige Minuten bis Stunden dauern.
|
||||
|
||||
{% include imgcap.html img='init-confirm' caption="Einrichtung abschließen" %}
|
||||
|
||||
Du wirst danach ins Dashboard weitergeleitet. Nach und nach wird sich die Mitgliederliste dann mit den Mitgliedern füllen, solange bis alles abgerufen ist.
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
---
|
||||
layout: page
|
||||
title: Erste Schritte
|
||||
has_children: true
|
||||
nav_order: 1
|
||||
---
|
||||
|
||||
# Erste Schritte
|
||||
|
||||
Hier findest du Hinweise zur Grundeinrichtung von Adrema.
|
||||
|
||||
|
|
@ -0,0 +1,65 @@
|
|||
---
|
||||
layout: page
|
||||
title: Installation
|
||||
parent: Erste Schritte
|
||||
nav_order: 1
|
||||
---
|
||||
|
||||
|
||||
# Installation
|
||||
|
||||
Adrema ist eine Web-Applikation, die auf einem Webserver installiert werden kann. Die Installation mit Docker wird empfohlen, da hier bereits alle notwendigen Dienste mit installiert werden.
|
||||
|
||||
{: .warning }
|
||||
Für die Installation sind Grundkenntnisse im Umgang mit Docker und / oder Server-Umgebungen erforderlich. Wenn du hier Hilfe benötigst, [kontaktiere uns]({% link kontakt.md %}).
|
||||
|
||||
## Mindestanforderungen
|
||||
|
||||
Die Mindestanforderungen sind größtenteils die Anforderungen vom [Laravel Framework](https://laravel.com/docs/10.x/deployment#server-requirements). Diese (plus einige Extra-Anforderungen) sind hier kurz ausgeführt:
|
||||
|
||||
|
||||
{: .block-title }
|
||||
> Anforderungen
|
||||
>
|
||||
> PHP >= 8.1
|
||||
> Ctype PHP Extension
|
||||
> cURL PHP Extension
|
||||
> DOM PHP Extension
|
||||
> Fileinfo PHP Extension
|
||||
> Filter PHP Extension
|
||||
> Hash PHP Extension
|
||||
> Mbstring PHP Extension
|
||||
> OpenSSL PHP Extension
|
||||
> PCRE PHP Extension
|
||||
> PDO PHP Extension
|
||||
> Session PHP Extension
|
||||
> Tokenizer PHP Extension
|
||||
> XML PHP Extensionnother paragraph
|
||||
> Texlive mit fonts-extra (pdflatex & xelatex)
|
||||
> rsync
|
||||
|
||||
## Installation mit Docker
|
||||
|
||||
```bash
|
||||
git submodule update --init # Submodules updaten
|
||||
cp .app.env.example .app.env # Example env erstellen:
|
||||
docker-compose build # Container bauen
|
||||
docker-compose run php php artisan key:generate --show # Key generieren
|
||||
|
||||
# Ersetze nun "YOUR_APP_KEY" in .app.env mit dem generierten Key (base64:qzX....).
|
||||
# Führe nun den DB Container aus, um eine erste Version der Datenbank zu erstellen.
|
||||
docker-compose up db -d
|
||||
docker-compose run php php artisan migrate --seed # Migrations ausführen
|
||||
docker-compose stop # Alles stoppen, dann alles neu starten
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
Nun kannst du auf localhost:8000 die App öffnen, einen LoadBalancer wie nginx verwenden, den Port mit CLI Optionen ändern, etc.
|
||||
|
||||
## Standard Login
|
||||
|
||||
Wenn du die Seeder ausführst (``--seed``, siehe oben), wird ein Benutzer mit folgenden Zugangsdaten erstellt:
|
||||
|
||||
* E-Mail-Adresse: admin@example.com
|
||||
* Passwort: admin
|
||||
|
||||
|
|
@ -1,11 +1,14 @@
|
|||
---
|
||||
layout: home
|
||||
nav_order: 0
|
||||
---
|
||||
|
||||
# Willkommen bei Adrema
|
||||
|
||||
Adrema ist eine Applikation, die die Verwaltung von Mitgliedern in der DPSG vereinfachen soll.
|
||||
|
||||
{% include imgcap.html img='member' caption="Mitglieder-Übersicht" %}
|
||||
|
||||
Insbesondere soll dabei möglichst auf eine direkte Interaktion mit NaMi verzichtet werden.
|
||||
|
||||
Sämtliche Änderungen die du in Adrema an deinen Mitgliedern vornimmst werden automatisch in NaMi übernommen und dort aktualisiert.
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
---
|
||||
layout: page
|
||||
title: Kontakt
|
||||
nav_order: 5
|
||||
---
|
||||
|
||||
# Kontakt
|
||||
|
||||
Wenn du Hilfe bei der Einrichtung brauchst, Rückfragen, Verbesserungsvorschläge oder etwas ähnliches hast, dann kontaktiere mich einfach.
|
||||
|
||||
## E-Mail
|
||||
|
||||
[philipp@zoomyboy.de](mailto:philipp@zoomyboy.de)
|
||||
|
||||
## Matrix
|
||||
|
||||
@philipp:zoomyboy.de
|
||||
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
layout: page
|
||||
title: Versionierung
|
||||
nav_order: 4
|
||||
---
|
||||
|
||||
# Versionierung
|
||||
Loading…
Reference in New Issue