An dieser Stelle entsteht die öffentliche Dokumentation für Epigraf 5. Diese Seite ist noch in Bearbeitung.
Einige Bereiche von Epigraf erfordern ein Benutzerkonto mit entsprechenden Berechtigungen. In EpiWeb werden folgende Rollen unterschieden:
| Rolle | Rechte | Schreibzugriff |
|---|---|---|
| Gäste (guest) | Können ohne Anmeldung auf veröffentlichte Daten zugreifen. Dazu gehören Artikel in der Referenzdatenbank, wobei die Inhalte teilweise beschränkt sind (/epi/epi_public/articles). | Nein |
| Leser:innen (reader) | Können auf alle Daten in freigegebenen Projektdatenbanken zugreifen, diese aber nicht verändern. Diese Konten werden verwendet, um projektexternen Personen Zugriff auf Daten zu geben. | Nein |
| EpiDesktop-Nutzer:innen (desktop) | Benutzen EpiDesktop. Können die Daten in freigegebenen Projektdatenbanken lesen und verändern und das Wiki bearbeiten. | Teilweise |
| Bearbeiter:innen (author) | Können die Daten in freigegebenen Projektdatenbanken lesen und verändern und das Wiki bearbeiten. | Teilweise |
| Herausgeber:innen (editor) | Können auf alle Projektdatenbanken, insbesondere aber auch auf die Konfiguration von Pipelines für den Export zugreifen, sie haben außerdem alle Rechte von Bearbeiter:innen. Sie können die Hilfe und das Wiki bearbeiten. | Teilweise |
| Administrator:innen (admin) | Können auf alle Funktionen und Daten der Anwendung zugreifen, insbesondere auch Benutzerkonten einrichten. Sie können öffentliche Seiten bearbeiten. | Ja |
| Entwickler:innen (devel) | Haben alle Rechte von Administrator:innen, sie können zusätzlich auf experimentelle Funktionen zugreifen. | Ja |
In der Benutzerverwaltung kann eine Übersicht über die vordefinierten Rechte abgerufen werden.
In jedem Benutzerkonto ist zudem eine primäre Datenbank festgelegt, auf die Nutzer:innen nach dem Login weitergeleitet werden. Administrator:innen sehen stattdessen nach dem Login die Übersicht über alle Datenbanken.
Anlegen von Benutzerkonten
Die Benutzerkonten werden von Administrator:innen in der Benutzerverwaltung gepflegt. Bei der Einrichtung der Konten sind folgende Punkte zu beachten:
- Nutzername: Benutzerkonten werden personenspezifisch vergeben, die Konten dürfen also nicht von verschiedenen Personen gleichzeitig genutzt werden. Benutzernamen sollen deshalb die Initialen und den Nachnamen der Person enthalten.
- Datenbank: Bei der Einrichtung der Konten muss eine Datenbank vorgegeben werden, in der ein:e Benutzer:in hauptsächlich arbeitet. Nach dem Einrichten des Kontos muss zusätzlich der Zugang mittels der Schaltfläche "Grant access to database" freigegeben werden. Dort kann der Zugriff auch widerrufen oder für andere Datenbanken vergeben werden.
- Aktivierung: Das Passwort kann beim Anlegen von neuen Nutzerkonten zunächst frei bleiben. Mit der Schaltfläche "Generate Invitation" wird ein Aktivierungslink erzeugt, der an die Person per E-Mail verschickt werden kann. Dieser Link ist 18 Stunden gültig. Im Zuge der Aktivierung legen die Nutzer:innen selbst ein Passwort fest. Der Einladungsmechanismus kann auch später von Administrierenden genutzt werden, um ein neues Passwort festlegen zu lassen.
Für den Zugriff auf spezifische Funktionen - beispielsweise den Datenimport über die API - werden weitere Rechte benötigt, die in der Benutzerverwaltung über die Schaltfläche "Permissions" vergeben werden.
Die Datenbank kann mit dem Klick auf die Schaltfläche im Menü links oben gewechselt werden.
EpiDesktop
Um mit EpiDesktop zu arbeiten, sind zusätzlich folgende Einstellungen nötig:
- Es müssen im Benutzerkonto eine Artikel- und eine Bandpipeline festgelegt werden, diese dienen als Voreinstellung beim Exportieren von Artikeln.
- Über die Schaltfläche "Grant permission" muss der EpiDesktop-Zugang freigegeben werden. Das Passwort ist identisch zum Passwort des Nutzeraccounts und wird automatisch bei der Aktivierung gesetzt.
- Nutzende finden die Einstellungen für EpiDesktop nach der Aktivierung in ihrem Nutzeraccount unter https://epigraf.inschriften.net/users/view/me
Berechtigungen
Berechtigungen sind fest mit der Rolle eines Nutzeraccounts verbunden. Darüber hinausgehend können weitere Endpunkte freigegeben werden. Ein Berechtigungsdatensatz umfasst folgende Felder:
| Feld | Erläuterung |
|---|---|
| User | Nutzername (es reicht die Angabe eines Nutzernamens oder einer Rolle) |
| Role | Rolle (es reicht die Angabe eines Nutzernamens oder einer Rolle) |
| Requested By | Zugang über die API (mit access token) oder über das Web (Anmeldung mit Passwort). |
| Permission Type | Freigaben erfolgen über "access" und Sperrungen über "lock". Beim Bearbeiten von Datensätzen werden automatisch temporäre Sperren erzeugt, damit sich veschiedene Nutzende nicht behindern. Im Regelfall werden manuell nur access-Berechtigungen vergeben, die Einschränkungen ergeben sich aus der Rolle. |
| Entity Type | Einige Berechtigungen beziehen sich auf eine komplette Datenbank, andere auf spezifische Datensätze. Werden Services (zum Beispiel ein Reconciliation-Service) freigegeben, kann der Typ frei bleiben. |
| Entity Name | Name der Datenbank oder Resource. Das Sternchen wird als Platzhalter für den Zugriff auf beliebige Resourcen über den jeweiligen Endpunkt verwendet. Freigaben für Services enthalten hier den Namen des Services (http, llm, reconcile, geo). |
| Entity ID | Wenn sich die Freigabe auf bestimmte Datensätze bezieht, die ID des Datensatzes. |
| Permission Name | Der Name des Endpunktes, zum Beispiel "epi/articles/index". Das Sternchen als Platzhalter gibt Zugriff auf alle Endpunkte. Das Präfix "app" steht für anwendungsbezogene und das Präfix "epi" für projektdatenbankbezogene Endpunkte. |
Name und ID der Datenbank sind in der Liste der Datenbanken einsehbar. Alternativ steht der Platzhalter * für beliebige Datenbanken. Eine Übersicht über die Endpunkte und rollenspezifische Zugangsregeln ist in der Nutzerverwaltung zu finden. Hinweis: Während in den URLs für index-Endpunkte auf das Suffix "/index" verzichtet werden kann, ist es in der Berechtigung notwendig.