Page tree
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

java -Xms512m -Xmx2048m -jar picapport.jar

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.
java -Xms512m -Xmx2048m -DTRACE=INFO -Duser.home=/opt/picapport -cp picapport.jar de.contecon.picapport.PicApport -configfile=/opt/picapport/.picapport/picapport.properties -pgui.enabled=false

Since Version 5.0 this also works:

java -Xms512m -Xmx2048m -Duser.home=/opt/picapport -jar picapport-headless.jar


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.contextpathnot set
(empty)
7.0YES

Optional parameter  to set the context path for the URL's of  a PicApport server.
This is useful if e.g the PicApport server runs behind a proxy.

Typically, PicApport's URL schema is as follows:

  • http://myserver.com/picapport
  • http://myserver.com/js/* for internal java script files
  • http://myserver.com/css/* for internal css files
  • etc.....

If the server.contextpath is set this changes as follows:

server.contextpath=/myphotos

  • http://myserver.com/myphotos/picapport
  • http://myserver.com/myphotos/js/* for internal java script files
  • http://myserver.com/myphotos/css/* for internal css files
  • etc.....

The server.contextpath must start with a slash and must not end with a slash.

If yo use this feature, make sure that you use the PicApport - Designs provided for Version 7 or later.

server.bind.n

not set
(all available)

1.0

YES

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
server.session.timeout.secondsnot set (default = 30 * 60 seconds
                         = 30 minutes)
7.2YESTime until a session on the server will be terminated if no activity detected.
server.admin.remote.command.nnot set7.6YES

Allows you to configure the console commands available on the web interface.
If this parameter is not set, the following configuration is used:

  • startcrawler

  • status

  • trace error

  • trace info

  • trace debug

  • restartpicapportserver (Only if Java Runtime version 9 or higher is used)
  • restartpicapportserver dbinit (Only if Java Runtime version 9 or higher is used)

Example: (Only the crawler can be started or the server can be restarted)

  • server.admin.remote.command.0=startcrawler

  • server.admin.remote.command.1=restartpicapportserver

server.admin.restart.prefix.nnot set7.6YES

Optional extension for the restartpicapportserver console command. If PicApport is started e.g. under Windows without a server GUI via a CMD-console,
this console is no longer available after the restart (although the new PicApport process is running).

With the following configuration a console will be opened again for the new process:

  • server.admin.restart.prefix.0=cmd
  • server.admin.restart.prefix.1=/c
  • server.admin.restart.prefix.2=start
  • server.admin.restart.prefix.3=PicApport Server

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 (160)

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

YES

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: (Colon and backslash each written with leading backslash as required in .properties-files)
    robot.root.0.path=$cd
    robot.root.1.path=E\:\\AnimalPictures

robot.root.n.id

n

1.0

YES

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

robot.root.n.aliasnot set9.1YES

Optional parameter.

If set, the alias will be displayed instead
of robot.root.n.path in the directory browser and the timeline.
Additionally, the alias is supported for the dir: and dirall: operators
by prefixing them with @.

Example: (For better readability, colon and backslash are not coded with \: and \\ as required).

Configuration parameter robot.root.0.id=fotos
Configuration parameter robot.root.0.path=C:\Users\public\picapport\photos
Configuration parameter robot.root.0.alias=photos

Operator example without alias: dir:"C:\Users\public\picapport\photos\2021\vacation"
Operator example with alias: dir:"@photos\2021\vacation"

robot.root.n.webdavmountnot set10.4YES

Optional parameter: Path-ID of the WebDAV URL for this directory. A valid Path-ID consists of letters and digits only.

If set, then this directory (and all subdirectories) is available for WebDAV access.
For all configured WebDAV directories the PicApport server creates a user group WebDAV.[webdavmount] at startup.
To access the WebDAV directory, a user must be a member of the WebDAV.[webdavmount] group.

Example: (For better readability colon and backslash are not coded with \: and \\ as required)

Configuration parameter robot.root.0.id=photos
Configuration parameter robot.root.0.path=C:\Users\public\picapport\photos
Configuration parameter robot.root.0.webdavmount=myphotos

Name of the implicitly created PicApport user group: WebDAV.myphotos (Only members of this group have access to the WebDAV directory).

The WebDAV directory can now be accessed via the following URL:

  • protocol://serveraddress/dav/myphotos
    (Example: https://meinserver/dav/myphotos)
    The WebDAV URLs available for a user are displayed in the About-Dialog of the web interface.

If only certain subdirectories of the configured root directories should be shared instead of an entire root directory,
these can be set instead with the parameters webdav.n.webdavmount and webdav.n.path (see below).

For more info on WebDAV configuration in PicApport, see Configuration and use of the WebDAV server integrated in PicApport.

robot.root.n.isuploadrootnot 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

open

NO

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

robot.rescan.minutes

not set

  • default = 5 Minutes
    if robot.use.filesystem.monitor = false
  • default 1 x täglich um Mitteracht
    if robot.use.filesystem.monitor = true
    (or not set)

1.0

YES

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

robot.use.filesystem.monitornot set (true)9.0YES

If not set or true then PicApport monitors the configured
directories (robot.root.n.path) regarding changes and then updates the
PicApport database immediately.

This includes creating, changing or deleting of files in the file system.

robot.filter.keywords.n

not set

open

NO

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

open

NO

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

robot.filter.title.n

not set

open

NO

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

robot.filter.rating

not set

open

NO

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

robot.always.create.idnot set (false)7.0YES

To manage MyTags and Likes, a unique PicApport ID is generated in the metadata of the .jpg file the first time a MyTag is set.
If this parameter is set, the ID is generated directly when the .jpg is first loaded to the database.
This supports e.g. the data backup because the photo files do not change the first time you you assign Likes or MyTags.

robot.days.keep.deleted.photosnot set (30)7.6YES

Values 0-9999999

Defines how many days  photos will be preserved after deletion.
If > 0 the files will be renamed by appending the extension .$@$YYYYMMDD$pa$removed (YYYYMMDD will be replaced with current date)
The files are therefore no longer visible in PicApport and are deleted by the crawler after the specified period of time.

If a value of 0 is set, the files will be deleted immediately.

robot.check.root.before.db.removenot set (false)9.2YES

This parameter is useful, when PicApport Server is accessing photos stored on network drive or removable media. If these are not connected during a crawler-run, PicApport will remove all photos on this drive from the database.

If this parameter is set to true, it will be checked if the matching root directory exists. If it does not exist, PicApport assumes a disconnected network drive and the photos remain in the database. (The slideshow will show a placeholder image)

If the network drive is then reconnected, not all photos have to be loaded into the database again.

webdav.* WebDAV configuration (Extended WebDAV configuration)

webdav.n.webdavmount
webdav.n.path

not set10.4YES

Extended WebDAV configuration. Both parameters must always be set. (n=0-n)

Allows to create specific shares below root directories.
It is important that directories configured in webdav.n.path are below a configured root directory.
(Warnung) WebDAV shares outside the configured root directories are not possible. (Warnung)

Apart from that, these two parameters work like robot.root.n.path and robot.root.n.webdavmount.

Example: (For better readability, colon and backslash are not coded with \: and \\ as required).
Configuration parameter webdav.0.path=C:\Users\public\picapport\photos\mobileuploads
Configuration parameter webdav.0.webdavmount=mobile

Name of the implicitly created PicApport user group: WebDAV.mobile (Only members of this group have access to the WebDAV directory).

The WebDAV directory can now be accessed via the following URL:

  • protocol://serveraddress/dav/mobile
    (Example: https://meinserver/dav/mobile)
    The WebDAV URLs available for a user are displayed in the About-Dialog of the web interface.

For more info on WebDAV configuration in PicApport, see Configuration and use of the WebDAV server integrated in PicApport.

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.fingerprintnot 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 bescaled 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.heightnot 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.freeSpacePercentagenot 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.qualitynot set (0.75)5.0YESQuality of JPG compression
of thumbnails.
Values 0.0 - 1.0.

user.* Parameter to control user management

user.encryption.iterationsnot set (1701)5.0YESNumber of hash iterations for the stored passwords
user.password.minnot set (1)5.0YESMinimum password length
user.password.maxnot set (75)5.0YESMaximum password length
user.log.accessnot set (false)5.0YESIf  true all Logon-Activities will be logged
user.log.webdavnot set (false)10.4YES

If  true all WebDAV-Activities will be logged

plugin.* Parameter to control plugins

plugin.shadow.pathnot set6.2YES

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


We strongly recommend to place the shadow files in a directory that is not configured for PicApport photos (robot.root. *).

Doing so the shadow files are fully separated from the photos and can be easily deleted at any time and then rebuilt.
(Attention, if you have set metadata, this is stored in the shadow files)

client.* Web-Client configuration

client.timeout.short.millisnot 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.millisnot set (15000)3.0YESTimeout for general Server-requests
client.default.viewtime.millisnot set (7000)3.0YES

Default value display time in
Slideshow-Mode

client.css.thumb.heightnot set (110)3.0YESCSS-Height for thumbnails
(110 works best on most cell phone)
client.folder.sortnot 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.hideemptyfoldersnot set (false)10.4YES

Optional parameter. (true or false)

If true then empty folders are no longer displayed in the directory browser.
This parameter can be overridden for individual users with the user option dirbrowser.emptyfolders.

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.
client.quick.btn.max.autonot set (10)7.0YESOptional parameter.
Controls the maximum number of quick buttons that will be generated automatically for the last entered tags
Value range 1-50
client.video.types.jsonnot set7.0YES

Optional parameter.

Specifies which video formats can be played directly in the slideshow.
Prerequisite is, that the formats (codecs) are supported by the browser.

If the parameter is not set, the following defaults will be used
(since vbVersion 9.2):

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

The parameter has to be defined in JSON notation. Please note, that the : in the .properties file must be encoded with backslash (\:).

For older versions:

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

client.is.PWAnot set(true)7.3YES

The offline capability (WebApp) of PicApport prior to version 7.3 is based exclusively on AppCache technology.
This is supported by almost all browsers. However, it is recommended by all browser manufacturers to
switch to the newer ServiceWorker architecture in the medium term.

With version 7.3 offline capability is optionally established via ServiceWorkers (Progressive Web App).
(SSL with valid certificate required).

Important: With the release of version 9.1 from feb 12 2021 the default was changed to true and the status Experimental was removed (before the default was false)

client.thumb.titlenot set(hidden)9.0YES

Controls the display of a title on the thumbnails. The following values are possible:

  • hidden (not visible)
  • filename (Filename)

  • filenamenoext (Filename without extension)

  • fullpath (Server path to file)

  • phototitle (Title from metadata)

  • photoid (internal ID)

  • date

  • year

  • timestamp

  • fromaddon (From addon. See Addon Documentation)

client.sort.random.smart.grpsizenot set (3)9.1YES

Optional parameter.
Value range 2-100
Default = 3

Number of photos for grouping in Random-Smart-Sorting.
With Random-Smart-Sorting, depending on this parameter, N-photos that were taken consecutively (if possible on the same day) are grouped together.

client.theme.color

not set
default = #039be5

10.1YES

Optional parameter. Default color (RGB) of the web interface if not explicitly set for the user.

Format: #rrggbb

Independent of the global color scheme setting, the administrator can easily set the color scheme for each user individually via the user management of the PicApport web interface.
A user can also do this himself at any time if he is authorized to change his own password.
An overview with some screenshots of possible themes can be found here: https://www.picapport.de/theme-gallery/

client.theme.darkthemenot set (false)10.1YES

Optionaler Parameter. (true oder false)

Theme mode (light or dark) of the web interface if not explicitly set for user.

Can also be set individually for each user via the web interface. See above client.theme.color

upload.* Upload Configuration

upload.tag.prefix

not set
default = 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
default = $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.useridprefixnot set
default =@
5.0YESEvery uploaded photo will be tagged with this prefix+userID (after the prefix)
Example: UserID=Paul -> Tag=@Paul (PicApport/@Paul with prefix)

upload.max.filesize.mb

not set (100)
Before version 9.2 the default was 10MB
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.memorysizenot set (102.400)5.0YESMaximum memory (server) for upload
Values: 1024 - Integer.MAX_VALUE
upload.max.parallel.uploadsnot set (3)5.0YES

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

upload.path

not set 
default=uploads/$UID$/$YYYY$/$MM$-$TITLE$

(Before version 9.1 the default was uploads/$UID$/$YYYY$/$MM$-$TITLE$ without @)

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$ - Will be replaced by the current year (date the photo was taken)
  • $MM$ - Will be replaced by the current month (date the photo was taken)
  • $DD$ - Will be replaced by the current day (date the photo was taken)
  • $TITLE$ - Max. 127 characters of the title entered for the upload. (Invalid characters will be replaced with _(underscore)
  • $UYYY$ - Replaced by userID (who is doing the upload) (since Version 10)
  • $UM$ - Replaced by userID (who is doing the upload) (since Version 10)
  • $UD$ - replaced by current day (of the upload) (since Version 10)

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

upload.user.tag

not set
default = check

7.0YES

The value of this parameter is automatically set as a the user-tag for photos which come via the upload function.
Thus, each user can easily equip his new uploads with GPS tags and other info by entering #check into the search field.

Once you have finished editing the metadata, you can delete the tag.
If you enter false for upload.user.tag no user tags will be generated during upload.

upload.allow.video

not set
default=true (in addition the PicApportVideoThumbnailPlugin is required)

9.2YESUsed to disable video uploads with PicApportVideoThumbnailPlugin installed.

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
server.ssl.pem.privatekeyfilenot set

10.0

NO

As an alternative to a certificate in a keystore, you can also set the two parameters server.ssl.pem.privatekeyfile and server.ssl.pem.certificatefile.

The following URL explains how to generate certificates under Ubuntu: https://www.digitalocean.com/community/tutorials/how-to-create-a-self-signed-ssl-certificate-for-apache-in-ubuntu-16-04

Example:
server.ssl.pem.privatekeyfile=/etc/apache2/ssl/apache.key

server.ssl.pem.certificatefilenot set

10.0

NO

As an alternative to a certificate in a keystore, you can also set the two parameters server.ssl.pem.privatekeyfile and server.ssl.pem.certificatefile.

The following URL explains how to generate certificates under Ubuntu: https://www.digitalocean.com/community/tutorials/how-to-create-a-self-signed-ssl-certificate-for-apache-in-ubuntu-16-04

Example:
server.ssl.pem.certificatefile=/etc/apache2/ssl/apache.crt

geo.* map module configuration

geo.max.markers

not set (20000)

6.0YESMaximum 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.0YESCluster size see: http://sintef-9012.github.io/PruneCluster/examples/random.10000-size.html

geo.marker.margin

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

geo.max.zoom

not set (18)6.0YESMaximum zoom level for maps
geo.distance.km.default not set (50)6.0YESDefault distance (in kilometers) for near: Operator
geo.map.defaultnot set (0)6.3.05YESDefault map
  • 0 = Open Street Map (Default ist nothing has been set)
  • 1 = Esri Satellite
  • 2 = Open Street Map B&W
  • 3 = Thunderforest landscape
  • 4 = Thunderforest outdoors
geo.map.key.thunderforestnot set6.3.05YES

Since February 2017 an apikey is required for Thunderforest-Maps.

You can get the key here: https://www.thunderforest.com/docs/apikeys/

Example: geo.map.key.thunderforest=abcd1234abcd1234abcd1234abcd1234

pan360.* Panorama viewer configuration





pan360.rotation.speed

not set (-4)

7.3YES

The value specifies the automatic rotation speed in degrees per second.

Positive is counter-clockwise, and negative is clockwise.

Range -180 to +180

pan360.slideshow.viewtime.seconds

not set (90)7.3YES

Display time in seconds of the rotating panoramas in the slideshow.  (play-mode)

  • The default value of 90 seconds means that at the default rotation of -4 (pan360.rotation.speed)
    the panorama is displayed for about as long as one turn has been executed.
  • If the parameter is set to 0, the panorama viewer will not start automatically in the slideshow. (play-mode)
  • Range 0-99999

pan360.tags

not set (360)7.3YES

Tags that PicApport generates automatically to search for 360 ° panoramas. 

By default, PicApport uses the tag pan360. 

If this parameter is changed or set then the database should be rebuilt afterwards.

fuzzysearch.* Thesaurus configuration (synonym dictionary) and phonetic search

fuzzysearch.modenot set (THESAURUS_ONLY)7.5YES

Specifies the default search mode for the full text search.

This controls how the full text search behaves when entering the tilde (~) characters (fuzzy search):

ValueBehavior

THESAURUS_ONLY
(Default)

If at least one thesaurus (synonym dictionary) is installed in .picapport/thesaurus, the full text search runs over all found synonyms of the entered search word.
If the word is not entered in the thesaurus, the search is "normal" (without thesaurus).
This also applies:

  • ~search word
    searches for the search term without first searching for synonyms (restriction of the result set)

Example:

The thesaurus contains the following entry: Shrovetide carnival party

If you search for Shrovetide , all photos found will automatically contain the following words: Shrovetide carnival party

If you search for ~Shrovetide you will only find photos that contain Shrovetide in the full text search.

NOT_FUZZY

By default, only the entered search word is searched for. (Without thesaurus and phonetics)
The same applies:

  • ~search word
    searches for the search term in the thesaurus and, if found, all matching synonyms. If no thesaurus entry is found, the search is automatically phonetic.
FUZZY

By default, the search term is searched in the thesaurus and, if found, all matching synonyms are searched. If no thesaurus entry is found, the search is automatically phonetic.
This also applies:

  • ~search word
    Standard search. Only the entered search word is searched for. (Without thesaurus and phonetics)

Independent of search mode:

  • ~~search word
    Phonetic search only: searches for phonetically identical words (e.g. input ~~Salvador finds Salvador, Salvadore, Salvadori, Salvati, Salvatore) see also: below fuzzysearch.phonetic.encoder
  • ~~~search word
    Search via synonyms only: Searches for all synonyms only if a thesaurus entry was found. If the word is not found in the thesaurus, the search is "normal" (without thesaurus).
fuzzysearch.phonetic.encoder

not set (Default is language-dependent)
defaults:

de: ColognePhonetic

en: DoubleMetaphone

es: none

fr: none

7.5YES

The following algorithms are supported: (Important: be sure to use upper and lower case)











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

Logging Configuration

The logging configuration is passed to the VM as a Java system property at startup (-DnameProperty=value)

ParameterDescription
-DTRACE=loglevel

The following values for loglevel are possible:

  • ERROR (default) 
  • WARNING
  • INFO (Crawler activities etc. are logged)
  • DEBUG (Produces a lot of information that helps us with the error analysis)
  • OFF
-DccNumLogFiles=nMaximum number of logfiles (n>2)
-DccLogFileSize

Maximum logfile size  in bytes

default = 1000000 (1MB) Minimum=10000

-DccLogDirectory

default = .picapport/logfiles (is created automatically)

-DccLogFileBaseName

Overwrites the default file names

Default=picapport (picapport.nnn)

-DccLogRefresh

Time interval for checking if logfile is full in milliseconds

default = 600000 = 10minutes = 600.000millis; minimum = 60.000 millis = 1 minute