Server configuration file
Contents |
Preface
This document lists and explains parameters which can be set in the config file of PowerFolder Server. These entries do not work with the PowerFolder Client configuration file.
General
The configuration file is located under:
- Windows: C:\ProgramData\PowerFolder\PowerFolder.config
- Linux and Mac: ~/.PowerFolder/PowerFolder.config
Also all parameters of the configuration file can be setup within this file.
Format
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.
Parameters (Mandatory)
Name of server
nick=name of server
Hostname
hostname=hostname.example.com
IP/DNS name or DynDNS name where the server is reachable at
TCP port
port=1337
PowerFolder listen on this port for incoming connections (data).
Note: The following line has to be added too:
random-port=false
Webinterface port
plugin.webinterface.port=80
TCP port of webinterface. By default available after startup at http://localhost:8080
Admin account
plugin.webinterface.username=admin plugin.webinterface.password=password
Administration account. Will be removed after start. To reset the password add these lines before startup.
Data directory
foldersbase=PowerFolders
the directory which holds all folders/data. Can be overridden by command line.
Security parameters
Default permission
security.folder.default.permission=ADMIN
Controls which permission will be granted as default permission by the server when creating a new folder. Possible values are:
- NO_ACCESS
- READ
- READ_WRITE
- ADMIN
Extended Security Control
security.permissions.strict=false
Enables Extended Security Control for server and client. Administrators are able to restrict access to certain client functions on user level such as:
- Open preferences
- Setup / Remove new synced folders
- Change folder settings
Login without password and OS username
server.connect.nopassword.allowed=false
Allows clients to connect without password and just using the username of the operating system to login at powerfolder server.
Login allowed in web portal
web.login.allowed=true
If the login in the web portal is allowed for regular/non-admin users.
Login callback URL/script
login.script=http://myserver/process_login.php
PowerFolder Server will call this URL/script after a user is successfully authenticated (via client or in web portal). Read more.
Database settings
Database URL
database.url=
Specify the JDBC URL to the database. MySQL Example: jdbc:mysql://localhost:3306/powerfolder
or jdbc:h2:tcp:/192.126.0.69:33333/Accounts
to connect to an running PowerFolder Server on port 33333 H2 internal database. More info below (database.port).
Database username
database.username=
The user account of the database user.
Database password
database.password=
The password of the database user.
Database Port
database.port=
This opens internal H2 database on a TCP port (By default the embedded H2 database is not available on via TCP). This is useful for connecting with an external SQL client or when setting up a cluster of PowerFolder Servers.
Parameters (Optional)
Log level
log.file.level=FINE
The log level messages of the PowerFolder Server log file. Possible values: FINER, FINE, INFO, WARN, SEVERE, OFF
Default transfer mode
default.transfer.mode=true,true,true,true,1,false,12,1,m,Auto sync,true
This option controls which transfer mode is used by the server when a new folder is created (by a client or via web).
Default archive setting
default.archive.versions=5
This option controls how many version of deleted or updated files by default are kept in the File Archive on the server.
Data cleanup process
plugin.server.folders.auto_remove=true
This option lets PowerFolder Server cleanup the "PowerFolders" main data directory every hour. It moves all unused folders into a subdirectory "BACKUP_REMOVE". Unused folders = No user account has permissions on it anymore. For safety reasons PowerFolder Server does not delete the directory "BACKUP_REMOVE". The directory must be deleted manually.
Folder creation directory name handling
create.folder.allow.allchars=false
With this option set to true the server will try to use the exact name of the folder a client tries to create. It does not replace the characters "/\\:*?\"<>|" with underlines. This is useful if you like to store the files in subdirectory structure on the server.
Folder creation overwrite old folder
create.folder.overwrite.old=false
This option controls if the server should delete a existing folder if a client tries to create a new one with the same name. Otherwise the server searches for a new empty directory by appending (2), (3), ... the directory path. Attention: Does not backup the contents of the existing folder.
Folder path name pattern
create.folder.path.pattern=$username/$foldername
The sub-directory pattern relative to the primary data directory of the server. Has two placeholders: $username will be replaced by the username of the user, who creates a folder. $foldername will be replaced by the name of the folder.
Powered by / Imprint link
web.poweredby.enabled=false
Disables the link in web to powerfolder.com webpage.
web.imprint.url=http://www.homepage.com/imprint.html
Shows an imprint link instead of the "powered by PowerFolder" link.
