Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

PackageDrone/Configuration/SystemProperties

Package Drone makes use of standard Java system properties for some configuration. The following list is a non-complete list of supported system properties.

Admin Mode

Property Type Default Description
package.drone.admin.announce.file.notPosix boolean false Package Drone will write out the admin token file with special Posix permissions which only allow the processes user to be able to read this file. If this is not supported (because you may be running on Windows) the file will not be written at all. Setting this property to true will override this behavior and always write out the file.

Warning: This may expose the admin token to other users on the local machine as well.

package.drone.admin.user String admin The name of the "admin" user
package.drone.admin.disableAnnounce.console boolean false Disable printing out the admin token on the console as well
package.drone.admin.disabled boolean false Disable the admin mode
package.drone.admin.token String see description Use a pre-generated admin token instead of a random one. The value of the OS environment variable PACKAGE_DRONE_ADMIN_TOKEN will be used as a default. If neither is set, a random token will be generated on each startup.
package.drone.admin.roles String list ADMIN, USER A comma delimited list of roles which the admin user will have. By default the MANAGER role is missing, so the admin account cannot create and configure channels.
package.drone.admin.announce.file Path none The path of the file where the admin token should be written to. By default the token will be written to a file name .drone-admin-token in the user home dir (system property user.dir).

Web Server

Note.png
Pax Web
Package Drone does make use of Pax Web based on Jetty. So you might want to check out additional system properties supported by Pax Web as well


package.drone.site.prefix

Property Type Default Description
package.drone.site.prefix String see description A some points Package Drone does need to generate absolute URLs (e.g. in e-mails). For this it does need to figure out the URL prefix. The default way to set it is to configure this information using the Web UI. But it is possible to also set this prefix using this system property. If it is not set then the OS environment variable PACKAGE_DRONE_SITE_PREFIX is checked. If this is not found then it is tried to build a URL by discovering the local hostname and the OSGi HttpService port. As a last resort, if that does not work either simply "localhost" will be used.

So the full order is: Web UI configuration → system property → OS env var → build using internal state → "localhost".


Copyright © Eclipse Foundation, Inc. All Rights Reserved.