Zum Ende der Metadaten springen
Zum Anfang der Metadaten

Hier werden die zur Konfiguration des Servers benötigten Parameter beschrieben.

Eine detaillierte Beschreibung der Installation unter verschiedenen Betriebssystemen und der Verzeichnisstruktur auf dem PicApport Server befindet sich im PicApport Installationshandbuch.

 

Schnelleinstieg Installation von PicApport

Starten von picapport.exe (Windows)

Die .exe Datei kann in ein beliebiges Verzeichnis der Festplatte kopiert werden. (Eine Java Laufzeitumgebung ab Version 8 wird empfohlen)

Installieren und Starten picapport.jar

Die .jar Datei kann in ein beliebiges Verzeichnis der Festplatte kopiert werden. (Eine Java Laufzeitumgebung ab Version 8 wird empfohlen)

Beispiel CMD-Datei für Oracle Jre auf Windows mit Speicherkonfiguration

Beispiel Linux Script Debian Headless

  • -DTRACE=INFO ist optional (Werte: ERROR, INFO, WARNING, DEBUG)
  • -Duser.home ist optional und kann verwendet werden um das Datenbankverzeichnis umzusetzen.

Seit Version 5.0 geht auch:

 

Server Konfiguration

Die Konfiguration erfolgt optional über eine Java .properties Datei die wie folgt versucht wird zu öffnen:

  • wenn Programmparameter -configfile gesetzt ist dann wird versucht diese Datei zu laden. (Diese Datei muss dann aber existieren.)
  • im Verzeichnis user.home/.picapport/picapport.properties
  • danach im im Verzeichnis user.dir//picapport.properties (aktuelles Verzeichnis)
  • danach wird ohne .properties Datei mit den unten beschriebenen Defaults gestartet.
  • weitere Informationen zum Java .properties-Dateiformat (Escaping von Backslash etc.) gibt es hier: https://de.wikipedia.org/wiki/Java-Properties-Datei

Alle in picapport.properties gesetzten Parameter können mittels der Kommandozeile überschrieben werden.

Die Groß / Kleinschreibung der Namen ist zu beachten

Java-System properties

Name

Default

Verison
supported

Imple
mented

Beschreibung

picapport
.directory

.picapport

3.2

JA

Name picapport directory

user.home

java system
dependent

1.0JAPfad zum Userverzeichnis
abhängig vom Betriebssystem
picapport
.home
not set3.2.2JAÜberschreibt user.home aber
nur wenn dort nicht bereits
ein .picapport Verzeichnis existiert.
(Wird vom Windows
Installer verwendet)

Allgemeine Regeln zum Java .properties Dateiformat

Parameter in picapport.properties

 

Name

Default

Verison
supported

Imple-
mented

Beschreibung

Allgemeine Serverparameter

server.port

80
Seit Version 6.2 wird unter Mac OS
Port 8080 als Default gesetzt.

1.0

JA

IP-Port für Zugriff auf Server:
Werte 0-65535

server.contextpathnot set
(empty)
7.0JA

Ermöglicht das optionale Setzen eines Context-Pfades für die URL's des PicApport Servers.
Die ist z.B. dann sinnvoll wenn der PicApport Server hinter einem Proxy läuft.

Normalerweise ist das URL-Schema von PicApport wie folgt:

  • http://meinserver.de/picapport
  • http://meinserver.de/js/* für interne javascript Dateien
  • http://meinserver.de/css/* für interne css Dateien
  • usw.....

Wird nun der server.contextpath gesetzt ändert sich dies wie folgt:

server.contextpath=/meinefotos

  • http://meinserver.de/meinefotos/picapport
  • http://meinserver.de/meinefotos/js/* für interne javascript Dateien
  • http://meinserver.de/meinefotos/css/* für interne css Dateien
  • usw.....

Der server.contextpath muss mit einem Schrägstrich anfangen und darf nicht mit einem Schrägstrich beendet werden.

Wird dieses Feature genutzt, ist darauf zu achten die aktuellen Designs (PicApport - Designs) für Version 7 oder später zu verwenden.

server.bind.n

not set
(all available)

1.0

 

IP-Stack auf dem der Server
erreichbar ist (wird normalerweise
nur bei mehreren Netzwerkkarten
benötigt)
Beispiel:
server.bind.0=192.168.0.1

server.theme

not set (a)

1.0

JA

default JQuery Theme
wenn nichts in Url gesetzt ist

server.photobuffer

not set (3)

1.0

JA

Number of photos loaded into
the browser during the slideshow
The total number of photos in
the browser is server.
(photobuffer*2)+1

server.autoupdate.photobuffernot set (100)5.2JA

Ist als Sortierung "Neuste automatisch aktualisieren" gewählt,
gibt dieser Wert an, wie viele Fotos in der Slideshow verfügbar
sind. (Vorgabe sind die 100 neusten der Fotos der Abfrage).
Dieser Vorgabewert kann jederzeit mit  dem limitresult:nnnnn
Operator in der Abfrage überschrieben werden.

server.external.address.for.shared.links

not set (default: aktuelle
Serveradresse der Browsersession
welche den Link erzeugt)

6.2JA

Ist der PicApport-Server über verschiedene Adressen (z.B lokales WLAN und externe DynDNS-Adresse) erreichbar,
wird mit diesem Parameter eingestellt, welche Serveradresse beim generieren von Links verwendet werden
soll.
Dieser Parameter kann auch über die Weboberfläche in der Benutzerverwaltung bei der Gruppe "Geteilte Fotos" mit
dem Button "Aktuelle URL für Links setzten" gesetzt werden.

Beispiel: server.external.address.for.shared.links=http://onlinedemo.picapport.de:80

server.max
.concurrent.imageio
not set (3)1.3JAAnzahl gleichzeitiger ImageIO
Operationen (Bilder in voller
größe im Speicher)

server.max.concurrent.shares.per.session

not set (3)6.2JAAnzahl geteilter Links (Shares) die gleichzeitig (Tabs)
in einer Browser Session angezeigt werden können.
server.cookie
.timeout.seconds
not set (default =
60*60*24*100
= 100 days)
5.0JAGültigkeit der in Cookies
gespeicherten Anmeldedaten
(Benutzer hat Anmeldung
gespeichert)
Wird der Wert 0 eingetragen
so kann man keine
Anmeldedaten speichern.

gui.enabled

not set (true)
in
picapport-
headless.jar

default=false

1.0

JA

Boolean Parameter um GUI zu
aktivieren/deaktivieren. mögl.
Werte (true/false)

gui.hideintray

not set (true)

1.0

JA

Boolean Parameter um GUI
direkt nach Start im System
Tray  zu verstecken

thumbs.height

not set (120)

1.0

JA

Integer Höhe der Thumbnails.
mögl. Werte 32 - 1024

thumbs.modenot set (0)5.1JA

0= Thumbs immer aus jpg-thumb generieren wenn möglich(default)
1= jpg-thumb benutzen wenn dessen höhe > thumbs.height
2= Thumbs immer aus jpg generieren (beste Qualität aber am langsamsten)

thumbs.num
.thumbs.before.pause

not set (250)

1.0

JA

Integer Anzahl  Thumbnails bevor
der "moreButton" erscheint. mögl.
Werte 10 - 10000

db.max.photos
.per.query

not set (2000)

1.0

JA

Integer Anzahl der Photos die
der Server maximal pro Anfrage
verwaltet
mögl. Werte 100 - 1000000
Nicht mehr notwendig(unterstützt)
ab Version 1.2

robot.* Konfiguration des Robots (Fotoverzeichnisse)

robot.root.n.path

root.0=$sd
wenn $sd nicht
verfügbar
root.0=$cd

1.0

JA

Voll qualifizierter Pfad(e) zu einem
Rootverzeichnis. Folgende Variablen
können hierbei verwendet werden
(n=0-n):

  • $cd - Aktuelles Verzeichnis
  • $sd - Systemverzeichnis
    welches
    für Bilder Vorgesehen ist.
    (Bei Windows
    CSIDL_MYPICTURES der
    GetSpecialFolderLocation API)
    Beispiel:
    robot.root.0.path=$cd
    robot.root.1.path=
    E:/AnimalPictures

robot.root.n.id

n

1.0

JA

Optionale ID für diesen Eintrag
(Wenn nicht gesetzt ist wird die
ID auf IDn gesetzt)

robot.root.n
.isuploadroot
nicht gesetzt5.0JAKennzeichnet das Verzeichnis als
Upload-Verzeichnis.
Es kann immer nur ein
Verzeichnis das
Uploadverzeichnis sein. Ist kein
Upload-Verzeichnis explizit gesetzt,
ist immer das erste Verzeichnis das
Upload-Verzeichnis.
Beispiel:
robot.root.1.isuploadroot=true

robot.filter.path.n

nicht gesetzt

1.3

JA

Regulärer Ausdruck um Bilder in
bestimmten Pfade zu heraus zu
filtern: (n=0-n)

robot.filter.name.n

nicht gesetzt

offen

 

Regulärer Ausdruck um Bilder mit
bestimmten Dateinamen (ohne Pfad)
heraus zu filtern: (n=0-n)

robot.rescan.minutes

5

1.0

JA

Zeit bis zum nächsten Rescan  in
Minuten (Default ist 5 Minuten)
Ein Rescan kann manuell mit dem
Konsolenbefehl startcrawler
erzwungen werden.

robot.filter.keywords.n

nicht gesetzt

offen

 

Regulärer Ausdruck um Bilder
mit bestimmten Keywords
heraus zu filtern: (n=0-n)
Beispiel:
robot. filter.keywords.0=.*private.*
robot. filter.keywords.1=.*privat.*

robot.filter.person.n

nicht gesetzt

offen

 

Regulärer Ausdruck um Bilder
mit bestimmten Personen heraus
zu filtern: (n=0-n)

robot.filter.title.n

nicht gesetzt

offen

 

Regulärer Ausdruck um Bilder mit
bestimmten Titeln heraus zu filtern:
(n=0-n)

robot.filter.rating

nicht gesetzt

offen

 

Gültige Werte (1-5): Beispiel 3
bedeutet nur Bilder mit Rating 3
und höher

robot.always.create.idnicht gesetzt (false)7.0JAZur Verwaltung von MyTags und Likes wird bei der ersten Vergabe eines Tags eine eindeutige PicApport ID in
den Metadaten der .jpg Datei erzeugt. Ist dieser Parameter gesetzt wird die ID direkt beim ersten Laden in die Datenbank
generiert. Dies erleichtert z.B. die Datensicherung weil sich die Fotodateien nicht mehr ändern wenn man Likes oder MyTags vergibt.

mail.* Mail-Client Konfiguration

mail.rescan.minutes

not set (9)

2.0

JA

Zeit bis zum nächsten fetchmail
in Minuten (Default ist 9 Minuten)
Ein Fetchmail kann manuell mit
dem Konsolenbefehl startfetchmail
erzwungen werden.

mail.check.fingerprintnot set (true)2.0JAWenn true dann wird nach dem
laden von Fotos über Email
geprüft  ob das Foto schon
in der Datenbank ist.
Wenn ja wird das Foto nicht
in das Verzeichnis kopiert.

foto.* Parameter zur Steuerung der JPG-Generierung

foto.jpg.quality

not set (0.75)5.0JAQualitätseinstellung der
JPG Komprimierung
foto.jpg.scalemethodnot set
(AUTOMATIC)
5.0JA

Qualitätseinstellung der
Scalierung

Mögliche Werte: AUTOMATIC,
SPEED,BALANCED,
QUALITY,ULTRA

foto.jpg.usecachenot set (0)5.0JA

Soll ein Cache, für die generierten
Photos verwendet werden

  • 0=Kein Read-Cache, Fotos
    werden skaliert wenn für
    Slideshow benötigt
  • 1=On demand, Fotos werden
    skaliert wenn zum ersten
    mal für Slideshow benötigt;
  • 2=crawler&ondemand,
    Alle Fotos werden
    automatisch zur schnellen
    Verfügbarkeit vom Crawler in
    den Cache eingetragen
    Die Option benötigt  meisten
    Festplattenplatz (ist aber bei
    Abrufen am schnellsten)
foto.jpg.cache.heightnot set (1080)5.0JAHöhe der vorgenerierten
und gecachten Bilder

foto.jpg.cache.width

not set (1920)5.0JABreite der vorgenerierten
und gecachten Bilder
foto.jpg.cache
.freeSpacePercentage
not set (20)5.0JAMindestgröße des Freien
Speicherplatzes auf dem
Cache-Pfad
foto.jpg.cache.pathnot set
(<PicApport-Home>
/cache)
5.0JAPfad zum Cache Beispiel:
/MyPhotoCache
foto.thumb.qualitynot set (0.75)5.0JAQualitätseinstellung
der Thumbnails

user.* Parameter zur Steuerung der CcUser2 Optionen

user.encryption
.iterations
not set (1701)5.0JAAnzahl an Hashdurchläufen
für die Passwortspeicherung
user.password.minnot set (1)5.0JAMinimale Passwortlänge
user.password.maxnot set (75)5.0JAMaximale Passwortlänge
user.log.accessnot set (false)5.0JAWenn true dann werden alle
Logon-Vorgänge protokolliert

plugin.* Parameter zur Steuerung der Plugins

plugin.shadow.pathnot set6.2 

Pfad zu den Schattendateien(Shadow-Files) (*.$.jpg Dateien)

Optionaler Parameter. Wenn nicht gesetzt werden die Schatten-Dateien im gleichen Ordner wie die Originaldatei abgelegt.
Beispiel: 

  • plugin.shadow.path=/PicApportShadowFiles
  • plugin.shadow.path=C\:\\PicApportShadowFiles

client.* Web-Client Konfiguration

client.timeout
.short.millis
not set (3000)3.0JAWird aktuell von der #home Seite
für Statusabfrage benutzt sobald
diese angezeigt wird, damit
es im Offline-Fall nicht 15 Sekunden
dauert bis man wieder was machen
kann.
client.timeout
.long.millis
not set (15000)3.0JATimeout für allgemeine
Serveranfragen
client.default
.viewtime.millis
not set (7000)3.0JAVorgabewert für Anzeigedauer im
Slideshow-Modus
client.css
.thumb.height
not set (110)3.0JACSS-Höhe für Thumbnails
(mit 110 passen bei den
meisten
Phones zwei Thumbs
nebeneinander)
client.folder.sortnicht gesetzt4.0.1JA

Optionaler Parameter.
Wenn gesetzt wird Verzeichnisliste
im Browser sortiert.*
Ist nötig da mache Linux System
überhaupt nicht sortieren.
Mögliche Werte: name,
name_insensitive, name_reverse,
name_reverse_insensitive

Beispiel:
client.folder.sort
=name_reverse_insensitive

client.viewer.maxzoomnot set (1000)6.2JA

Optionaler Parameter.
Steuert den Zoombereich von Originalfotos in der Slideshow.
Wertebereich 100-2000

client.viewer.snapviewnot set (true)6.2JAOptionaler Parameter. (true oder false)
Steuert Sichtbarkeit der Snapview (kleines Fenster oben links) beim Zoomen.
client.loadoriginal.with.gesturenot set (true)6.2JAOptionaler Parameter. (true oder false)
Wenn false, dann kann das Originalfoto nicht mit "pinch zoom" Gesten oder Mousewheel geladen werden.
client.quick.btn.max.autonot set (10)7.0JAOptionaler Parameter.
Steuert die maximale Anzahl der letzten Tags die als Quickbutton automatisch gespeichert werden
Wertebereich 1-50
client.video.types.jsonnot set7.0JA

Optionaler Parameter.
Gibt an welche Videoformate direkt in der Slideshow abgespielt werden können.
Vorraussetzung ist das der Browser diese Formate auch unterstützt.

Wenn der Parameter nicht gesetzt ist gilt folgender Vorgabewert:

[{'ext':'.mp4','mime':'video/mp4'},{'ext':'.ogv','mime':'video/ogg'},{'ext':'.webm','mime':'video/webm'}]

Der Parameter ist in JSON-Notation zu definieren.

upload.* Upload Konfiguration

upload.tag.prefixnicht gesetzt
(PicApport/)
5.0JA

Viele Fotobetrachter verwenden
eine Baumstruktur zur anzeige von
Tags.
Mit dem Prefix wird dafür gesorgt,
dass alle von Picapport erzeugten
Tags unterhalb von PicApport
stehen.

upload.tag

not set ($upload)5.0JAJedes hochgeladene Foto wird
mit diesem Tag versehen
(gemeinsam mit dem Prefix)
Um alle hochgeladenen
Fotos abzufragen einfach
$upload eingeben
upload.tag
.useridprefix
nicht gesetzt (@)5.0JAJedes hochgeladene Foto wird
mit diesem Tag+UserId versehen
(gemeinsam mit dem Prefix)
Beispiel: UserId=Hans ->
Tag=@Hans
(PicApport/@Hans mit Prefix)

upload.max
.filesize.mb

nicht gesetzt (10)5.0JAMaximale Dateigröße für
Upload in MB (1000x1000).
Gültige Werte: 1 bis
Integer.MAX_VALUE

upload.max
.requestsize

nicht gesetzt
(-1) keine
Begrenzung
5.0JAMaximale Requestgröße
(Server) für Upload
Gültige Werte: (-1) bis
Integer.MAX_VALUE
upload.max
.memorysize
nicht gesetzt
(102.400)
5.0JAMaximaler Speicher
(Server) für Upload
Gültige Werte: 1024 bis
Integer.MAX_VALUE
upload.max
.parallel.uploads
nicht gesetzt (3)5.0JA

Maximale Anzahl gleichzeitiger
Dateiübertragungen (Client)
Gültige Werte: 1 bis 100

upload.path

nicht gesetzt
(uploads/$UID$/
$YYYY$/
$MM$-
$TITLE$)

5.0JAPfad zum für Uploads von Fotos.
Dieser Pfad wird automatisch
unterhalb des für Uploads
konfigurierten Rootverzeichnisses
(siehe: robot.root.n.isuploadroot)
angelegt.
Folgende Variable können
verwendet werden
(immer Großbuchstaben
verwenden):
  • $UID$ - Wird durch die UserID
    (welche den Upload durchführt)
    ersetzt
  • $YYYY$ - Wird durch das
    aktuelle Jahr (des Uploads)
    ersetzt
  • $MM$ - Wird durch den
    aktuellen Monat
    (des Uploads) ersetzt
  • $DD$ - Wird durch den
    aktuellen Tag (des Uploads)
    ersetzt
  • $TITLE$ - Maximal 127 Zeichen
    vom Bildtitel (Ungültige Zeichen
    werden durch _(underscore)
    ersetzt)

Wichtig: Keine Verzeichnistrenner
(Slash oder Backslash) am Anfang
oder Ende des Eintrags eingeben.

upload.user.tagnicht gesetzt (check)7.0JA

Der Wert dieses Parameters wird automatisch als Usertag für Fotos gesetzt die über die Upload-Funktion kommen.
Somit kann jeder Benutzer seine neuen Uploads bequem mit GPS Tags und anderen Infos ausstatten wenn
man #check in das Suchfeld eingibt.    

Ist man mit der Nachbearbeitung der Metadaten fertig, kann man den Tag löschen.
Gibt man false für upload.user.tag ein werden keine Usertags beim Upload erzeugt.

server.ssl.* SSL Konfiguration

server.sslnot set (false)2.0JAWenn true dann wird SSL Protokoll aktiviert (Schlüssel werden generiert)
server.ssl.keystorenot set2.0JADateiname Keystore (Default = .picapport/picapport.ks)
server.ssl.passwordnot set2.0JAKennwort für Keystore
server.ssl.keypasswordnot set2.0JAPasswort für Zertifikat
server.ssl.truststorenot set2.0JADateiname der Truststore Datei (Default = .picapport/picapport.ks)
server.ssl.trustpasswordnot set2.0JAKennwort für Truststore

geo.* Kartenmodul Konfiguration

geo.max.markers

not set (20000)

6.0JAMaximale Anzahl von Markern auf der Karte
Wird die Anzahl überschritten bekommt der Anwender einen Hinweis.
Größere Werte sind bei ausreichendem Speicher kein Problem

geo.cluster.size

not set (120)6.0JAGöße der Cluster siehe: http://sintef-9012.github.io/PruneCluster/examples/random.10000-size.html

geo.marker.margin

not set (20)6.0JAMarker Margin siehe: http://sintef-9012.github.io/PruneCluster/examples/random.10000-size.html

geo.max.zoom

not set (18)6.0JAMaximales Zoomlevel des Kartenmoduls
geo.distance.km.defaultnot set (50)6.0JAVorgabewert KM für near: Operator
geo.map.defaultnot set (0)6.3.05JADefault Karte
  • 0 = Open Street Map (Vorgabe wenn nichts gesetzt ist)
  • 1 = Esri Satellite
  • 2 = Open Street Map B&W
  • 3 = Thunderforest landscape
  • 4 = Thunderforest outdoors
geo.map.key.thunderforestnot set6.3.05JA

Seit Februar 2017 wird für Thunderforest maps ein apikey benötigt.

Den Key kann man sich hier beschaffen: https://www.thunderforest.com/docs/apikeys/

Beispiel: geo.map.key.thunderforest=abcd1234abcd1234abcd1234abcd1234

Programmparameter (Argumente) für piccapport.exe bzw. picapport.jar

Die Konfiguration von PicApport über eine Konfigurationsdatei ist optional. Alle Parameter können auch direkt beim Starten an Piccaport.exe übergeben werden.

Parameter die in picapport.properties definiert wurden, werden durch die Angabe beim Starten von piccaport.exe überschrieben.

Die Groß / Kleinschreibung der Namen ist zu beachten

Name

Anzahl
Parameter

Default

Beschreibung

-configfile

1

nicht gesetzt

Absoluter Dateiname (mit Pfad) für picapport.properties

-p[Name]

1

nicht gesetzt

Hiermit können beliebige Parameter der Datei picapport.properties gesetzt werden.
Beispiel:
picapport.exe -configfile=c:\myconig.properties -pserver.port=8080 -probot.root.0=C:\myphotos