-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
116 additions
and
98 deletions.
There are no files selected for viewing
15 changes: 8 additions & 7 deletions
15
docs/admin/two-factor-auth.md → docs/admin/authentication.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,24 @@ | ||
| # Two-Factor Authentication | ||
| # Authentication | ||
|
|
||
| ## Activate | ||
| ## Two-Factor Authentication | ||
| ### Activate | ||
|
|
||
| The two-factor authentication can be enabled with an enztry in the `.env` file: | ||
| The two-factor authentication can be enabled with an entry in the `.env` file: | ||
|
|
||
| ``` | ||
| 2FA=1 | ||
| ``` | ||
|
|
||
| In the settings (`two-factor-auth-role`) you can set a role for which the 2FA is obligatory. If for example editor is specified, a 2FA is mandatory for editor and admin. | ||
|
|
||
| ### Deactivate 2FA for a User | ||
|
|
||
| If a user has lost the two-factor secrets and has also no recovery code, it is possible to remove this from the user so that it is possible to start over with a fresh 2FA. | ||
|
|
||
| ## Registration | ||
|
|
||
| It is also possible via the `.env` file to allow user registration: | ||
|
|
||
| ``` | ||
| REGISTRATION=1 | ||
| ``` | ||
|
|
||
| ## Deactivate 2FA for a User | ||
|
|
||
| If a user has lost the two-factor secrets and has also no recovery code, it is possible to remove this from the user so that it is possible to start over with a fresh 2FA. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| # Inge und Dimag | ||
|
|
||
| With Inge it is possible to integrate DIMAG as a data repository. The original files are then not stored on the Anton file system, but in DIMAG. Only files that have been optimized for use on the Internet are then stored in Anton. If required, internal users can download the original files. So there is no difference for the users. | ||
|
|
||
| ## Requirements | ||
| - Setting `fulltext-from-webpdf`: true | ||
| - Setting `cloud`: "inge" | ||
| - .env INGE_API_TOKEN | ||
| - User "Inge" with Email address and api_token for Inge | ||
|
|
||
| ### Ablauf des SIP-Ingest | ||
|
|
||
| #### Anton | ||
| - User: SIP Upload (zip) (`/sip/uploadsip`) | ||
| - User: SIP Validation (`/sip/validation`) | ||
| - Anton kann das SIP auspacken (unzip) und die Metadaten-Datei ist lesbar. | ||
| - Die Dateien aus dem SIP sind vorhanden und die Prüfsummen sind korrekt. | ||
| - Anton kann für jedes Dossier im SIP einen parent in Anton finden. | ||
| - User: Anton-Ingest (`/sip/ingest`) | ||
| - Backup der Datenbank | ||
| - Import SIP (`<dossier>` and `<dokument>`/`<datei>`) | ||
| - SIP Eintrag im Akzessionsarchiv («Entwurf») | ||
| - Import Dossiers and Dokumente/Dateien | ||
| - Anton erstellt Web-Versionen und Thumbs | ||
| - falls der SIP-Ingest mit Inge und DIMAG erfolgt löscht die Masterdateien | ||
| - Signaturen und Dateinamen basieren zunächst auf UUIDs | ||
| - Post Import | ||
| - Update der Archiv-Hierarchie (`path`) | ||
| - Anton ersetzt UUID-Signaturen mit korrekten Signaturen und benennt die Medien entsprechend um | ||
| - Update der Datierungen und des Volltextindexes | ||
|
|
||
| #### Ingest mit Inge in DIMAG | ||
| - Anton schickt einen Request an Inge mit dem SIP and einer Liste der Anton-Medien-Ids | ||
| - Inge: Ingest der Dateien in DIMAG | ||
| - Inge erstellt eine loadXML-Datei | ||
| - Inge erstellt ein Ingest-Paket und sichert es auf DIMAGs SFTP-Storage | ||
| - Inge sendet einen Request an DIMAG: Ingest des SIP | ||
| - DIMAG: Importiert das Paket and sendet das Resultat an Inge | ||
| - Inge: Inge sendet das Resultat an Anton | ||
| - Anton: Finalisiere den SIP-Ingest | ||
| - Bestätige den SIP-Ingest (SIP Eintrag ist «Final») oder stelle den Zustand vor dem Ingest aus dem Backup wieder her | ||
| - Schicke eine Email an User Inge mit dem Resultat | ||
|
|
||
| ### Abfrage eines Master Files | ||
|
|
||
|  | ||
|
|
||
|
|
||
| ## CLI | ||
| ```bash | ||
| php artisan anton:import --env {slug} --from-sip --no-validation | ||
| --create-actors -vv {path/to/sip} --import | ||
| ``` | ||
|
|
||
| ### Revert a SIP Import or Confirm Import with Inge | ||
|
|
||
| Before a SIP Import Anton backups the database, so if anything goes wrong you can come back to the status before the Import. | ||
|
|
||
| The backup name is stored in the SIP-Entry and the `Status of description` is set to draft. | ||
|
|
||
| This will restore the database from the last/actual backup and sync the media with the database (namely delete media wich are not registered in the database): | ||
|
|
||
| ```bash | ||
| php artisan anton:sip-import --env {slug} --id {sip_id} -vv --revert | ||
| ``` | ||
|
|
||
| The `sip_id` is the ID of an AntonObject which is a SIP. | ||
|
|
||
| This will set the `Status of description` in the SIP-Entry to "final": | ||
|
|
||
| ```bash | ||
| php artisan anton:sip-import --env {slug} --id {sip_id} -vv --confirm | ||
| ``` | ||
|
|
||
|
|
||
| ### Debugging | ||
|
|
||
| #### Check the SIP Import Data | ||
|
|
||
| ```bash | ||
| php artisan sip:check --env {slug} --path {path_to_sip} --show-sip_entry | ||
| ``` | ||
|
|
||
| ```bash | ||
| php artisan sip:check --env {slug} --path {path_to_sip} --show-import-array | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters