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

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

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.
 

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

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

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

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

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

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.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:
  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 )

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:

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

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

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.

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.

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

foto.jpg.
quality

Quality setting for scaling

Possible values:

AUTOMATIC,SPEED,
BALANCED,QUALITY,ULTRA

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.width

Minimum free disk-space
on the drive

where cache path is located.
Values: 0-100

Default value display time in
Slideshow-Mode

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

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

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:

[{‚ext‘:‘.mp4′,’mime‘:’video/mp4′},{‚ext‘:‘.ogv‘,’mime‘:’video/ogg‘},{‚ext‘:‘.webm‘,’mime‘:’video/webm‘}]

The parameter has to be defined in JSON notation.

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)

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)

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.

upload.tag.prefix

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

upload.max.filesize.mb

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

upload.max.requestsize

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

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

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

Path 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.

not set
default = check

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.

9.2
NOT YET RELEASED

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

9.2
NOT YET RELEASED

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.max.markers

not set (20000)

geo.cluster.size

geo.marker.margin

geo.max.zoom

Default 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

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.rotation.speed

not set (-4)

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

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

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.

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):