Skip to end of metadata
Go to start of metadata

Here you'll find all information about server configuration and parameters. A detailed description of the server installation under different operating systems and the directory structure of the picapport server can bet found in the PicApport Installation Guide

 

Quick start installation of PicApport

Start of picapport.exe (Windows)

The .exe file can be copied to a directory of your hard drive. (Java runtime environment version 8 is recommended )

Install and start of picapport.jar

The .jar file can be copied to a directory of your hard drive. (Java runtime environment version 8 is recommended )

Example CMD-file for Oracle Jre on Windows with memory configuration

Example Linux Script Debian Headless

  • -DTRACE=INFO is optional (Values: ERROR, INFO, WARNING, DEBUG)
  • -Duser.home is optional an may be used to set the database directory.

Since Version 5.0 this also works:

 

Server configuration

The configuration is done via an optional Java .properties file. The file is located as follows:

  • if program parameter -configfile is set, then this file will be loaded. (The file must exist.)
  • in the directory user.home/.picapport/picapport.properties
  • then in the directory user.dir//picapport.properties (current directory)
  • then PicApport will be started without .properties file with the defaults described below.
  • see https://en.wikipedia.org/wiki/.properties for more information about the java .properties file format. (escaping of backslash etc...)

All properties set in picapport.properties may be overwritten from the command line.

The uppercase and lowercase characters of the property names must be respected.

Java-System properties

Name

Default

Verison
supported

Imple
mented

Beschreibung

picapport.directory

.picapport

3.2

YES

Name of picapport directory

user.homejava system dependent1.0YESPath to user home directory. Dependent on operating system.
picapport.homenot set3.2.2YES

Overwrites user.home but only if there does not already exist
a .picapport directory.(This is used internally by the windows
installer)

General rules for the Java .properties file format

Parameter in picapport.properties

 

Name

Default value
in braces

Verison
supported

Imple
mented

Description

General server parameter

server.port

80

Since version 6.2 port 8080 is used as
default under Mac OS.

1.0

YES

IP-Port for server access:
Values 0-65535

server.bind.n

not set
(all available)

1.0

 

IP-Stack used to contact the
server (may be required if
multiple network adapters
are installed)
Example:
server.bind.0=192.168.0.1

server.theme

not set (a)

1.0

YES

Default JQuery Theme
if not set in the URL

server.photobuffer

not set (3)

1.0

YES

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.2YES

If "Newest with auto update" has been selected for sorting
this value defines how many photos will be available for the
slideshow. 
(Default: 100 newest photos of the query).
This default value can be overwritten with the limitresult:nnnnn
operator in the query.
 

server.external.address.for.shared.links

not set (default: current server address
of browser session creating the link)

6.2YES

Is the PicApport server reachable with different IP-Adresses (e.g. local WLAN and external DynDNS-address),
this parameter defines which server address should be used when photos are shared (shared links).

This paramter can also be set with the web-interface of the User-Management. User-group  "Shared photos"  just click on the button
"Set current URL for Links"

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

server.max.
concurrent.imageio
not set (3)1.3YESNumber of concurrent Image
IO's in the server
(Number of uncompressed
images in server memory)
server.max.concurrent.shares.per.sessionnot set (3)6.2YES

Number of shared links (shares) that can be displayed
concurrently in a browser session (Tabs).

server.cookie.
timeout.seconds
not set (default =
60*60*24*100 =
100 days)
5.0YESValidity of credentials stored
in cookies (User has saved
logon in browser)
A Value of 0 (zero) deactivates
the option to save the logon in
the browser

gui.enabled

not set (true) in
picapport-
headless.jar

default=false

1.0

YES

Boolean parameter to activate
/ deactivate the GUI on the server.
Values: (true/false)

gui.hideintray

not set (true)

1.0

YES

Boolean parameter to hide the
GUI in the system tray directly
after PicApport has been started

thumbs.height

not set (120)

1.0

YES

Integer. Height of thumbnails.
Values: 32 - 1024

thumbs.modenot set (0)5.1YES

0= Always from jpg-thumb if availabe(default)
1= use jpg-thumb if height > thumbs.height
2= always generate from jpg

thumbs.num.
thumbs.before.
pause

not set (250)

1.0

YES

Integer. Number of thumbnails
before the "More-Button" appears
in thumbnail view.
Values 10 - 10000

db.max.photos.
per.query

not set (2000)

1.0

YES

Integer. Max number of photos
per query. Values 100 - 1000000
Since 1.2 not required
(supported anymore)

robot.* Configuration of photo crawler (Photo-directories)

robot.root.
n.path

root.0=$sd
if $sd not
available
root.0=$cd

1.0

 

Full qualified path to a
root.directory.
The following variables
may be used (n=0-n):

  • $cd - Current directory
  • $sd - System directory
    used for photos.
    (On Windows
    CSIDL_MYPICTURES
    of the
    GetSpecialFolderLocation API)
    Example:
    robot.root.0.path=$cd
    robot.root.1.
    path=E:/AnimalPictures

robot.root.n.id

n

1.0

 

Optional ID for this entry
(If not set, ID will be IDn )

robot.root.n.
isuploadroot
not set5.0YESMarks the directory as the
Upload-Directory. Only one
directory can be the
Upload-Directory.
If no Upload-Directory is set the first
root-directory will be he
Upload-Directory by default.
Example:
robot.root.1.isuploadroot=true

robot.filter.
path.n

not set

1.3

YES

Regular expression to filter
photos in certain directories: (n=0-n)

robot.filter.
name.n

not set

 

 

Regular expression to filter
photos in certain files: (n=0-n)

robot.rescan.
minutes

5

1.0

YES

Time until next rescan in minutes
(Default is 5 minutes)
A rescan can also be started by
entering the console command:
startcrawler.

robot.filter.
keywords.n

not set

 

 

Regular expression to filter
photos with certain keywords: (n=0-n)
Example:
robot. filter.keywords.0=.*private.*
robot. filter.keywords.1=.*privat.*

robot.filter.
person.n

not set

 

 

Regular expression to filter
photos with certain persons: (n=0-n)

robot.filter.
title.n

not set

 

 

Regular expression to filter
photos with certain titles: (n=0-n)

robot.filter.
rating

not set

 

 

Regular expression to filter
photos with certain ratings:
Values: (1-5):
Example: 3 means only photos
with rating 3 or higher will be added

mail.* Mail-Client configuration

mail.rescan.
minutes

not set (9)

2.0

YES

Time until next fetchmail in
minutes (Default is 9 minutes)
A rescan can also be started by
entering the console command:
startfetchmail

mail.check.
fingerprint
not set (true)2.0YESIf true then PicApport checks
if the photo is already in the database.
If it is already in the
database it will not be copied.

foto.* Parameter to control JPG generation

foto.jpg.
quality

not set (0.75)5.0YESQuality of JPG compression.
Values 0.0 - 1.0.
foto.jpg.
scalemethod
not set
(AUTOMATIC)
5.0YES

Quality setting for scaling

Possible values:

AUTOMATIC,SPEED,
BALANCED,QUALITY,ULTRA

foto.jpg.
usecache
not set (0)5.0YES

Cache option for photos. Values:

  • 0=No Read-Cache. Photos will
    be scaled when required for
    slideshow.
  • 1=On demand. Photos will be
    scaled when required for
    slideshow the first time.
  • Result will be stored in cache.
  • 2=crawler & on demand.
  • All photos for the cache
  • will be created
    automatically by the crawler.
    This option needs most
  • hard disk space
    but is the fastest
    (recommended e.g.
  • for Raspberry PI)
foto.jpg.
cache.height
not set (1080)5.0YESHeight of photos saved
in the cache in pixels.

foto.jpg.
cache.width

not set (1920)5.0YESWidth of photos saved
in the cache in pixels.
foto.jpg.cache.
freeSpacePercentage
not set (20)5.0YES

Minimum free disk-space
on the drive

where cache path is located.
Values: 0-100

foto.jpg.
cache.path
not set
(<PicApport
-Home>
/cache)
5.0YESPath to photo-cache. Example:
C:\MyPhotoCache
foto.thumb.
quality
not set (0.75)5.0YESQuality of JPG compression
of thumbnails.
Values 0.0 - 1.0.

user.* Parameter to control user management

user.encryption.
iterations
not set (1701)5.0YESNumber of hash iterations
for the stored passwords
user.password.
min
not set (1)5.0YESMinimum password length
user.password.
max
not set (75)5.0YESMaximum password length
user.log.
access
not set (false)5.0YESIf  true all Logon-Activities
will be logged

plugin.* Parameter to control plugins

plugin.shadow.pathnot set6.2 

Path to ths shadow-files (*.$.jpg Files)

Optional parameter. If not set shadow files will be located in the same directory as the original files.
Example: 

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

client.* Web-Client configuration

client.timeout.
short.millis
not set (3000)3.0YESUsed by the landing page 
#home
for status queries
so it will not take 15 seconds
if the server cannot be connected
display the offline state.
client.timeout.
long.millis
not set (15000)3.0YESTimeout for general Server-requests
client.default.
viewtime.millis
not set (7000)3.0YES

Default value display time in
Slideshow-Mode

client.css.
thumb.height
not set (110)3.0YESCSS-Height for thumbnails
(110 works best on most cell phone)
client.folder.
sort
not set4.0.1YES

Optional parameter.
If set directorys
in the browser will be sorted.
This is required because some
Linux-systems do not
sort directories.
Possible Values:
name, name_insensitive,
name_reverse,
name_reverse_insensitive

Example:
client.folder.sort=name
_reverse_insensitive

client.viewer.maxzoomnot set (1000)6.2YES

Optional parameter.
Controls zoom range for original photos in the slideshow.
Value range 100-2000

client.viewer.snapviewnot set (true)6.2YESOptional parameter. (true or false)
Controls visibility of snapview (small window on top left) while zooming.
client.loadoriginal.with.gesturenot set (true)6.2YESOptional parameter. (true or false)
If false, then original photo cannot be loaded with "pinch zoom" gestures or mouse-wheel.

upload.* Upload Configuration

upload.tag.
prefix

nicht gesetzt
(PicApport/)
5.0YES

Some photo-programs use a
tree-structure to display tags.
  With this prefix it is ensured

that all tags produced by PicApport
are
below the root-tag PicApport.

upload.tag

not set ($upload)5.0YESEvery uploaded photo will be
tagged with this tag (after the prefix)
To view all uploaded photos just
enter $upload in the search-field
upload.tag.
useridprefix
not set (@)5.0YESEvery uploaded photo will be
tagged with this tag+userIDJ
(after the prefix)
Example: UserID=Paul ->
Tag=@Paul (PicApport/@Paul
with prefix)

upload.max.
filesize.mb

not set (10)5.0YES

Maximum size for an upload in MB
(1000x1000).
Values: 1 - Integer.MAX_VALUE

upload.max.
requestsize

not set (-1)
no limit
5.0YESMaximum request size (Server) for upload
Values: (-1) - Integer.MAX_VALUE
upload.max.
memorysize
not set (102.400)5.0YESMaximum memory (server) for upload
Values: 1024 - Integer.MAX_VALUE
upload.max.
parallel.uploads
not set (3)5.0YES

Number of concurrent transfers (client)
Values: 1 - 100

upload.pathnot set (uploads/
$UID$/
$YYYY$/
$MM$-$TITLE$)
5.0YESPath to upload directory. This path
will be generated automatically
under the
root-directory marked for uploads.
(see: robot.root.n.isuploadroot).
The following placeholders my
be used (always capital letters):
  • $UID$ - Replaced by userID
    (who is doing the upload)
  • $YYYY$ - replaced by
    current year (of the upload)
  • $MM$ - replaced by
    current month (of the upload)
  • $DD$ - replaced by
    current day (of the upload)
  • $TITLE$ - Max. 127 characters
    of the title entered for the upload.
    (Invalid characters will be replaced
    with _(underscore)

Important: No Path-Seperators
(Slash or Backslash) at the
beginning or end of this property.

server.ssl.* SSL configuration

server.sslnot set (false)2.0YESIf true SSL protocoll will be activated (Keys will be generated)
server.ssl.keystorenot set2.0YESFilename keystore (Default = .picapport/picapport.ks)
server.ssl.passwordnot set2.0YESPassword Keystore
server.ssl.keypasswordnot set2.0YESPassword certificate
server.ssl.truststorenot set2.0YESFilename truststore (Default = .picapport/picapport.ks)
server.ssl.trustpasswordnot set2.0YESPasssword truststore

geo.* map module configuration

geo.max.markers

not set (20000)

6.0JAMaximum number of markers on the map.
If the number is exceeded, the user receives an indication.
Higher values are no problem if enough memory is available on the client.

geo.cluster.size

not set (120)6.0JACluster size see: http://sintef-9012.github.io/PruneCluster/examples/random.10000-size.html

geo.marker.margin

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

geo.max.zoom

not set (18)6.0JAMaximum zoom level for maps
geo.distance.km.default not set (50)6.0JADefault distance (in kilometers) for near: Operator
     

Program parameter (arguments) for piccapport.exe / picapport.jar

The configuration of PicApport with a configuration file is optional. All parameters may be set as program arguments to PicApport.exe or picapport.jar.

All properties set in picapport.properties will be overwritten from the command line.

The uppercase and lowercase characters of the property names must be respected.

Name

Number of
parameter

Default

Description

-configfile

1

not set

Absolute filename (with path) for picapport.properties

-p[Name]

1

not set

With -p any parameter of picapport.properties can be overwritten.
Example:
picapport.exe -configfile=c:\myconig.properties -pserver.port=8080 -probot.root.0=C:\myphotos

java -jar picapport.jar -configfile=c:\myconig.properties -pserver.port=8080 -probot.root.0=C:\myphotos