Dashboard

Pex Dashboard

Dashboard is a web interface for Pex permission management.

Settings

The Dashboard is disabled by default. You can enable the dashboard with the setting permissions.dashboard.enabled in the config.yml.

Change the following settings so that the webserver works:

Set permissions.dashboard.serveraddress to an address that points to your server. For example play.example.com:PORT. Do not change PORT unless you've set up a CNAME entry that points to the Dashboard server in your DNS.

Setting	Description
enabled	Enables the dashboard
port	Sets the port used for the Dashboard WebServer
serveraddress	Sets the address that is given by /pex dashboard command
certificate	HTTPS Certificate settings
internalip	Useful on Docker machines where internal IP management is necessary. Do not change unless you know what you're doing
logaccess	Enables access logging to console about which users log in.

HTTPS Set-up

Setting	Description
certificate.path	Java keystore filename in /plugins/PermissionsEx/ folder or the absolute path to the file if the certificate is placed elsewhere.
certificate.keypass	The password of the certificate
certificate.storepass	The password of the keystore
certificate.alias	The alias of the keystore

How to get a certificate issued by Let’s Encrypt:

See here: https://letsencrypt.org/getting-started/

How to convert the certificate files into a Java KeyStore:

Create new Keystore file:

keytool -genkey -v -alias dummy -keystore Cert.jks
Enter keystore password: STOREPASS

Remove the dummy entry to have an empty keystore:

keytool -delete -alias dummy -keystore Cert.jks
Enter keystore password: STOREPASS

Turn Certificate files (.pem) into PKCS12 format (.p12):

openssl pkcs12 -export 
-in /etc/letsencrypt/live/<domain>/fullchain.pem 
-inkey /etc/letsencrypt/live/<domain>/privkey.pem 
-out /etc/letsenscrypt/live/<domain>/pkcs.p12 
-name <tlskeyalias> 
-passout pass:<keypassword>

Import the certificate (.p12 format) to the keystore:

keytool -importkeystore 
-deststorepass <storepassword> 
-destkeypass <keypassword> 
-destkeystore /etc/letsencrypt/live/<domain>/Cert.jks 
-srckeystore /etc/letsencrypt/live/<domain>/pkcs.p12 
-srcstoretype PKCS12 
-srcstorepass <keypassword> 
-alias <tlskeyalias>

You're all set, now just set the config settings to the values you used.