About DASHLink
DASHLink is a simplified API server that runs alongside your Minecraft server. Its only function is to whitelist and un whitelist players. Originally when I developed DASHLauncher it was for one server running locally on another machine on my network using RCON. However ambitions have grown and I want this to be a secure and stable platform for members to reliably manage their requests with.
Features
- HTTPS Support via keystore
- Configurable port selection (via Config)
- Custom API Key (via Config)
Default Configuration
for self hosted servers: DASHLink configured port also needs to be opened on your router
for hosted servers: DASHLink configured port needs to be allowed by your host
Config located: Plugin:./plugins/DASHLink/config.yml or Mod:./config/dashlink.json
# DASHLink Plugin Configuration
# This file is used to configure the DASHLink service for secure communication with DASHLauncher.
# Please carefully read this documentation to understand each setting and its implications.
# ------------------ #CONFIGURATION WARNING# ------------------
# This configuration file contains sensitive information.
# Do not share it or it's contents with anyone or expose it publicly.
# If this file is compromised, change the "apiKey" IMMEDIATELY here and in the DASHLauncher Dashboard https://dashboard.swfx.uk.
# By use of DASHLink, DASHLauncher will not be held responsible for any loss or damage caused by unauthorized access to this file or API Key.
# It's recommended to use a strong, unique key that is not easily guessable eg: "server_name", "server_name_secret", "server_name_api_key", etc.
# If you do not set an API key, DASHLink will not be able to communicate with DASHLauncher.
# to set an API key, uncomment the line below and replace "YOUR_SECRET_API_KEY_HERE" with your actual key.
# If you already created an API key in the DASHLauncher Dashboard, you can copy it from there and paste it here.
api-key: "YOUR_SECRET_API_KEY_HERE"
# ------------------ #CONFIGURATION WARNING# ------------------
# The port on which the DASHLink API server will listen for incoming requests.
# Ensure this port is not in use by another application and is open in your firewall.
server-port: 25566
# --- HTTPS Configuration (Optional) ---
# Enable or disable HTTPS (SSL/TLS) for the API server.
# Setting this to 'true' requires a valid Java KeyStore (.jks) file.
# If you enable HTTPS, it's highly recommended to use a different port than the HTTP port.
use-https: false
# Path to the Java KeyStore (.jks) file containing your SSL certificate and private key.
# This path is relative to the server's root directory.
# Example: plugins/DASHLink/keystore.jks
keystore-path: "plugins/DASHLink/keystore.jks"
# The password for the KeyStore file.
# !!! IMPORTANT !!! Change this to a strong, unique password.
keystore-password: "change-me"
# The password for the private key within the KeyStore.
# This is often the same as the keystore-password, but can be different.
# !!! IMPORTANT !!! Change this to a strong, unique password.
key-password: "change-me"
Once Configuration is set either use /dl reload in your console or game or reboot your server.
HTTPS Configuration:
Documentation yet to be added
