Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Section


Column
width65%

In this article you will find all available settings which can be set in the server configuration file. Most of those settings can also be set in the web interface.


Info
titleLocation and Format

The PowerFolder.config server configuration file location depends on the operating system:

  • Windows 7/8/10/2008 R2/2012 R2/2016: C:\ProgramData\PowerFolder\PowerFolder.config
  • Linux and Mac: ~/.PowerFolder/PowerFolder.config

The format is a simple text base formats with key=value formatted lines. Comments can be inserted with by adding a # (dash) in front of each line.


General Settings

Admin Account Settings

Web SettingConfig File ParameterConfig File Default ValueConfig File Possible ValuesDescription
Admin usernameplugin.webinterface.usernameadmin

The username of the account which has full control over the server and all its settings.

(Info) When inserting the parameter into the config file, the server will rename the current admin to the specified name and remove the parameter afterwards.

Current password


The password of the account specified above.
New passwordplugin.webinterface.passwordpassword

The new password for the account specified above (required when the password should be changed).

(Info) When inserting the parameter into the config file, the server will set the specified password for the the current admin and remove the parameter afterwards.

Confirm new password


The confirmation for the new password for the account specified above (required when the password should be changed).

Licensing

Web SettingConfig File ParameterConfig File Default ValueConfig File Possible ValuesDescription
PowerFolder.com E-Mail


PowerFolder.com account of the licensee for PowerFolder Server. This account also holds the microcredit purchased with the product. Usually this field is already filled due to the initial activation of PowerFolder Server.
PowerFolder.com Password


PowerFolder.com password of the account specified above.

Limit users per Server
license.limit.user

Any numeric valueTo limit the maximum number of users.



Column


Panel
titleOverview:
Table of Contents



...

SettingConfig File ParameterConfig File Default ValueConfig File Possible ValuesDescription

Maintenance Folder Path

*Cannot *be changed with reload (requires restart)




Shows the current location of the Server Maintenance Folder.

Maintenance Folder ID

*Cannot *be changed with reload (requires restart)

plugin.server.maintenancefolderid

Defines the ID of the Server Maintenance Folder. Please only modify the value if preparing the servers to run in a high availability setup.

Cluster Config Synchronisation

(Fehler) Setting not yet available via web

*Cannot *be changed with reload (requires restart)

config.clustertrue
  • true
  • false
Enables synchronisation of cluster settings via Server Maintenance Folder (Cluster.config).

...

SettingConfig File ParameterConfig File Default ValueConfig File Possible ValuesDescription
Database user account defaults


A link to the profile for database users.
LDAP user account defaults


A link to the profile for LDAP users.
RADIUS user account defaults


A link to the profile for RADIUS users.
Account validity (days)server.register.os.days-1
  • Setting server.register.os.days to 0 or -1 will result in no valid till date being set -> Accounts are valid from now on forever
  • Setting server.register.os.days to a number > 0 will set a valid till date of number of days in the future
  • Setting server.register.os.days to a number < -1 will set a valid till date of number of days in the past, resulting in a disabled account
Defines the default number of days a new account should be valid.

Register language

(Fehler) Setting not yet available via web

server.register.languageNot set, uses system languageSee descriptionCan be set to a two letter language code to set language for new accounts e.g.
server.register.language=de
Login script to uselogin.script
  • A full path to an executable script

Will be executed after each user login / authentication via client or web portal. Example:

login.script=http://myserver/process_login.php

(Glühbirne) The server will add an entry to the log if the script was executed successfully or not. On Linux it's possible to pass messages to stdout and stderr, so they will be added to the logs. Example:

Code Block
languagebash
echo This is a stdout test >&1
echo This is a stderr test >&2


Wait for login scriptlogin.script.waitfalse
  • true
  • false
Controls if other server processes will wait for the login script to finish.
Login type to useserver.username.isemailboth
  • true: Field label will be "Email", login field only accepts logins containing an 'at' (@) and a "dot" (.) sign after that. The first email from LDAP will be set as username.
  • false: Field label will be "Username", login field doesn't check the format.
  • both: Field label will be "Username/Email", login field doesn't check the format.
  • <custom>: Field label will be the value specied (replace <custom> with a label of your choice), login field doesn't check the format.

Controls:

  • if usernames are allowed, which don't include an 'at' (@) and a "dot" (.) sign after that.
  • what kind of label the login field in the web and client interface has

(Info) The setting also applies to LDAP, so users are forced to use either the mail or userPrincipalName attribute (or any other attribute including an email-like value) if true is specified.

Invites per email

server.invite.validate_email.enabled

  • false
  • true
  • false
Controls that the invitations should only be send to email addresses not usernames only
Message if user account has expiredserver.register.account_expiredYour account is invalid
  • Any text message
A message to the user, if his/her account has expired.
Message if user account is not yet validserver.register.account_not_yet_validYour account is not valid yet
  • Any text message
A message to the user, if his/her account is not yet valid.

...

Web SettingConfig File ParameterConfig File Default ValueConfig File Possible ValuesDescription
Enable RADIUS authentication


Controls if RADIUS support will be enabled in the server.

RADIUS hostnameradius.server

Example:

  • radius.example.com:1812
Specifies the hostname and (optional) port for the RADIUS server.
RADIUS shared secretradius.sharedsecret

Specifies the shared secret for communication with the RADIUS server.
RADIUS protocolradius.authPEAP
  • EAPMD5
  • EAPMSCHAPV2
  • EAPTLS
  • EAPTTLS
  • PEAP
  • MSCHAPV1
  • MSCHAPV2
  • CHAP
  • PAP
Specifies the proctol to use for communication with the RADIUS server.
RADIUS timeoutradius.timeout.seconds30
Specifies when RADIUS server communication should time out.

...

Web SettingConfig File ParameterConfig File Default ValueConfig File Possible ValuesDescription
Enable Shibboleth authenticationshibboleth.enabledfalse
  • true
  • false

Controls if Shibboleth support will be enabled in the server.

Federation Metadata URLshibboleth.metadata.url
Defines the URL to receive the Metadata from.
Discovery Feed URLshibboleth.serviceprovider.url
  • A valid URL (optional)
Defines the URL to the Discovery Feed.

Enable organization mapping

shibboleth.create.organizationstrue
  • true
  • false
Controls if Shibboleth organizations should be mapped to PowerFolder organizations.

Organization attribute

shibboleth.organizations.attributeo
  • A valid organization attribute
Defines the organization attribute.
Auto-create organizations on loginshibboleth.create.organizationstrue
  • true
  • false
Controls if organizations created automatically on login.
Session-Identifier (ID) attribute shibboleth.attribute.sessionidShib-Session-ID
  • A valid Session-Identifier (ID) attribute
Defines the Session-Identifier attribute.
Persistent-Identifier (ID) attributeshibboleth.attribute.persistentidpersistent-id,uniqueID
  • A valid Persistent-Identifier (ID) attribute
Defines the Persistent-Identifier (ID) attribute.
Username attributeshibboleth.attribute.usernameeppn,EPPN,eduPersonPrincipalName
  • A valid Username attribute
Defines the Username attribute.
Mail attributeshibboleth.attribute.mailmail,email
  • A valid Mail attribute
Defines the Mail attribute.
Match accounts by mail attributeshibboleth.accounts.match_emailtrue
  • true
  • false
Controls if accounts are matched by mail attribute.
Given name attributeshibboleth.attribute.givennamegivenName
  • A valid Given name attribute
Defines the Given name attribute.
Surname attributeshibboleth.attribute.surnamesurname,sn
  • A valid Surname attribute
Defines the Surname attribute.
Expiration attributeshibboleth.attribute.expiration
  • A valid Expiration attribute
Defines the Expiration attribute.
Custom attribute 1shibboleth.attribute.custom1affiliation,eduPersonScopedAffiliation
  • A valid Custom attribute 1
Defines the Custom attribute 1.
Custom attribute 2shibboleth.attribute.custom2
  • A valid Custom attribute 2
Defines the Custom attribute 2.
Custom attribute 3shibboleth.attribute.custom3
  • A valid Custom attribute 3
Defines the Custom attribute 3.
Discovery feed URL
server.idp.disco_feed.url

A valid URL.Loads the identity provider list from this URL. Identity providers are selectable by end-users for login.
Names of external organizationsserver.idp.external_names
  • Default is empty
  • Comma separated list of names to be displayed in IdP dropdown list as "other external" users
    Example:
    server.idp.external_names=Gastkennungen/Guests,!Org Beispiel 1,!Org Beispiel 2,!Org Beispiel 3,!Firma aus M\u00FCnchen,!KEIN_RECOVERY,MIT_RECOVERY

Defines the names of external organizations added to the identity provider list loaded from the discovery feed. Selecting any organization of this list during login will authenticate the user vs. non-SAML sources, such as LDAP, Database or RADIUS if setup.

If an exclamation mark is added in front of the organization name, password recovery won't be available for that organization (e.g. LDAP).

...

Web SettingConfig File ParameterConfig File Default ValueConfig File Possible ValuesDescription
Default storage pathfoldersbase
  • Windows: C:\ProgramData\PowerFolder\PowerFolders
  • Linux: ~/PowerFolders

Example:

  • foldersbase=D:\PowerFolders
  • foldersbase=\\exampleserver\PowerFolders\
  • foldersbase=/home/user/PowerFolders

The directory on your disk, which is used by PowerFolder Server to store new folders.

Add new folders in the default storage path automatically

look.for.folder.candidatesfalse
  • true
  • false
Controls if a new folder in the default storage path should be automatically managed by the server.
Create user-based directory schemecreate.folder.path.pattern$username/$foldername

Example:

  • $username/$foldername
  • $username
  • $foldername
  • $username/PowerFolders/$foldername
Sub-directory pattern relative to the folderbase directory of the server. Two placeholders are possible: $username will be replaced by the username of the user who creates a folder. $foldername will be replaced by the name of the folder the user creates.
Delete non-managed folders from default storage pathplugin.server.folders.auto_removefalse
  • true
  • false
Controls if the server should move unused folders (not assigned to any existing user) from its folderbase to a sub-directory in the folderbase, which is called BACKUP_REMOVE. The check runs every hour. The contents of the BACKUP_REMOVE directory have to be deleted manually.
Move folders to backup directory when users delete themserver.folders.delete_datatrue
  • true
  • false

Controls how to handle removals of folders by a user (owner or admin of a folder) in the client or the web interface. By default the server moves the contents/files to a directory called BACKUP_REMOVE. Set this option to false to prevent any file system changes when a user deletes a folder.

Mount folders dynamically in high-availability setups

*Cannot *be changed with reload (requires restart)

folders.mount.dynamicfalse
  • true
  • false

Controls if folders will only be actively managed if the folder is really served by the same node. 

(error) Not compatible with create.folder.use.existing=FALSE Data loss occurs!

Use existing folders with the same name

create.folder.use.existingtrue
  • true
  • false
Controls if the server should delete an existing folder if a client tries to create a new one with the same name. Otherwise the server creates new empty directories appending numbers, like (2),(3),...
(Warnung) Does not backup the contents of the existing folder if enabled.
Preserve NTFS filesystem permissionsfolder.copy_after_transfer.enabledfalse
  • true
  • false 
Controls if a transfered file is moved from the temporary transfer directory. If enabled the transfered file will be copied and deleted from the temporary transfer directory.

Use filesystem API to watch for changes

*Cannot *be changed with reload (requires restart)

folder.watcher.enabledtrue
  • true
  • false 
Controls if folder changes will be recognized using filesystem APIs. If disabled, changes will be detected only if the folder is accessed by a client.

Recovery of 0 byte files and deleted files by server

recover.zero_byte.files

false

(Warnung) Default in PowerFolder version 10.6/11 is true

  • true
  • false
Enables users the option to recover 0 byte files and deleted files by PowerFolder server.

(Fehler) Setting not yet available via web

storage.stickyness.accountsfalse
  • true
  • false
Keeps one user account sticked to the same storage path, if multiple storage paths are configured.
Storage Path Check

folder.storage.path.check

folder.storage.path.report

false
  • true
  • false

Checks periodically if the folder path on server storage still is correctly for this user.

E.G. If the ownership rights of a folder are transferred to another user, this function moves the folder into the correct directory on the server to keep the data structure clear for administrative purposes.

folder.storage.path.report is only demo mode. Only writes the log entrys but doesn't move files or folders.

(warning) Available with version 11.4 or higher

...

Web SettingConfig File ParameterConfig File Default ValueConfig File Possible ValuesDescription
Set minumun client version to connect
net.version.minimum=
empty
17.4.100
Controls that a minum version is comaptible with server and allowed to connect.
Enable Client Downloadweb.download_app.enabledtrue
  • true
  • false

Controls if it's possible to download the clients on the web interface.

Enable Music Playerweb.musicplayer.enabledtrue
  • true
  • false
Controls if the music player will be available when browsing folders.
Enable Newsweb.news.enabledtrue
  • true
  • false
Controls if the web interface should offer a News tab to show recently changed folder content.
Enable Picture Galleryweb.gallery.enabledtrue
  • true
  • false

Controls if the gallery view will be available when browsing folders.

Enable Telephone Fieldsweb.telephone.enabled true
  • true
  • false
Controls if users are allowed to enter their telephone number. 
Enable WebDAVweb.dav.enabled true
  • true
  • false
Controls if it's possible for users to access their folders via WebDAV. 
Enable ZIP compressionweb.zip.compression true
  • true
  • false 
Controls if HTTP ZIP compression is activated. It might be useful to disable if a proxy is used which already compresses HTTP elements. 

(Fehler) Setting not yet available via web

*Cannot *be changed with reload (requires restart)

file_link.upload_landing_pagefalse
  • true
  • false

Activates the Upload Forms Feature. It enables the possibility for the user to create a landing page for a folder where user can upload files.

(warning) Available with version 11.4 or higher

Location display in user account devices tab

(Fehler) Setting not yet available via web

web.location.enabledtrue
  • true
  • false
Displays device location on devices tab in user accounts

...