Skip to content

Commit

Permalink
Add to documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
mkalus committed Nov 5, 2015
1 parent 50455e6 commit e6109c4
Show file tree
Hide file tree
Showing 8 changed files with 46 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,4 @@ Beispiel:
* `orientDB.login` OrientDB-Datenbank Login (Voreinstellung: admin)
* `orientDB.password` OrientDB-Datenbank Passwort (Voreinstellung: admin)
* `lucene.analyzer` Verwendeter Lucene-Analyser (Voreinstellung: org.apache.lucene.analysis.standard.StandardAnalyzer)
* `requireLogin` Login nötig? (Voreinstellung: false = Autologin als Administrator)
1 change: 1 addition & 0 deletions src/main/resources/documentation/de/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ Segrada starten und ausführen:

* [Segrada starten](run.md)
* [Kommandozeilenoptionen](command_line_options.md)
* [Benutzer und Gruppen](users_and_groups.md)

20 changes: 20 additions & 0 deletions src/main/resources/documentation/de/users_and_groups.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Benutzer und Gruppen

Die Optionen sind im Moment noch im Aufbau. Geplant sind:

* Benutzer mit einer Benutzergruppe
* Gruppen mit bestimmten Rechten


## Mehrbenutzerbetrieb starten

Standardmäßig loggt sich der zugreifende Benutzer automatisch als Administrator ein. Um Logins und die
Benutzerverwaltung zu starten, muss man Segrada mit folgender Kommandozeilenoption starten:

java -jar -DrequireLogin="true" segrada-1.0-SNAPSHOT.jar

oder im Servermodus:

java -jar -DrequireLogin="true" segrada-1.0-SNAPSHOT.jar headless

Nach dem Start muss man sich anmelden. Es ist sinnvoll den Benutzer "Administrator" entsprechend zu ändern.
2 changes: 1 addition & 1 deletion src/main/resources/documentation/de/what_is_segrada.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Features an:
* Dateien können in die Datenbank hochgeladen und verknüpft werden.
* Der Volltext hochgeladener PDF, Word oder Open-/LibreOffice-Dateien kann in der Datenbank gespeichert werden.
* Suchmöglichkeiten: Volltextsuche (auch in Dateien) und verschiedene Filterfunktionen.
* Mehrbenutzerfähigkeit (noch im Aufbau)
* Mehrbenutzerfähigkeit mit Gruppenrechten
* Skalierbar: Desktop-Betrieb, einzelner oder verteilte Serverumgebung
* Internationalisiert: im Moment Englisch und Deutsch

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,4 @@ Example:
* `orientDB.login` OrientDB database login (default: admin)
* `orientDB.password` OrientDB database password (default: admin)
* `lucene.analyzer` Lucene analyser to use (default: org.apache.lucene.analysis.standard.StandardAnalyzer)
* `requireLogin` Require login? (default: false, meaning autologin as admin)
1 change: 1 addition & 0 deletions src/main/resources/documentation/en/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ Starting and running Segrada:

* [Running Segrada](run.md)
* [Command Line Options](command_line_options.md)
* [Users and Groups](users_and_groups.md)
20 changes: 20 additions & 0 deletions src/main/resources/documentation/en/users_and_groups.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Users and Groups

Currently in progress. Planned features:
* Users being members of one user group
* Groups with access rights


## Starting Segrada in Multi User Mode

Normally, Segrada will log in an access as administrator by default. To enable logins, you must start Segrada with
the following command line option:

java -jar -DrequireLogin="true" segrada-1.0-SNAPSHOT.jar

or in server mode:

java -jar -DrequireLogin="true" segrada-1.0-SNAPSHOT.jar headless

After starting the application, you have to log in. To enhance security, please change the default user "Administrator"
to something else.
2 changes: 1 addition & 1 deletion src/main/resources/documentation/en/what_is_segrada.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ more features:
* Files can be uploaded to the database and linked with other data.
* Uploaded PDF, Word or Open-/LibrerOffice files can be indexed in full text.
* Search: Full text (files and other data) and a number of filter functions to find your data again.
* Multiple users (work in progress)
* Multiple users and user groups
* Scalable: Use on desktop, run as single or distributed server.
* Internationalized: Currently English and German

Expand Down

0 comments on commit e6109c4

Please sign in to comment.