关于 DASHLink
DASHLink 是一个简化的 API 服务器,可与你的 Minecraft 服务器并行运行。它的唯一功能是添加和移除玩家的白名单。最初,当我开发 DASHLauncher 时,它是为了在一台通过 RCON 连接到我的网络中另一台机器上本地运行的服务器使用。然而,野心逐渐增长,我希望将其打造为一个安全稳定的平台,供成员可靠地管理他们的请求。
功能
- 通过密钥库支持 HTTPS
- 可配置的端口选择(通过配置文件)
- 自定义 API 密钥(通过配置文件)
默认配置
对于自建服务器:DASHLink 配置的端口也需要在你的路由器上打开
对于托管服务器:DASHLink 配置的端口需要由你的主机提供商允许
配置文件位置:插件:./plugins/DASHLink/config.yml 或模组:./config/dashlink.json
# DASHLink 插件配置
# 此文件用于配置 DASHLink 服务,以便与 DASHLauncher 进行安全通信。
# 请仔细阅读本文档以了解每个设置及其影响。
# ------------------ #配置警告# ------------------
# 此配置文件包含敏感信息。
# 不要将其或其内容分享给任何人,也不要公开暴露它。
# 如果此文件泄露,请立即在此处以及 DASHLauncher 仪表板 https://dashboard.swfx.uk 中更改 "apiKey"。
# 使用 DASHLink 即表示,DASHLauncher 不对因未经授权访问此文件或 API 密钥而导致的任何损失或损坏负责。
# 建议使用难以猜测的强且唯一的密钥,例如:"server_name", "server_name_secret", "server_name_api_key" 等。
# 如果你未设置 API 密钥,DASHLink 将无法与 DASHLauncher 通信。
# 要设置 API 密钥,请取消注释以下行并将 "YOUR_SECRET_API_KEY_HERE" 替换为你的实际密钥。
# 如果你已经在 DASHLauncher 仪表板中创建了 API 密钥,你可以从那里复制并粘贴到这里。
api-key: "YOUR_SECRET_API_KEY_HERE"
# ------------------ #配置警告# ------------------
# DASHLink API 服务器将监听传入请求的端口。
# 确保此端口未被其他应用程序占用,并且在防火墙中已开放。
server-port: 25566
# --- HTTPS 配置(可选)---
# 启用或禁用 API 服务器的 HTTPS (SSL/TLS)。
# 将此设置为 'true' 需要一个有效的 Java 密钥库 (.jks) 文件。
# 如果你启用了 HTTPS,强烈建议使用与 HTTP 端口不同的端口。
use-https: false
# 包含你的 SSL 证书和私钥的 Java 密钥库 (.jks) 文件的路径。
# 此路径相对于服务器的根目录。
# 示例:plugins/DASHLink/keystore.jks
keystore-path: "plugins/DASHLink/keystore.jks"
# 密钥库文件的密码。
# !!! 重要 !!! 将其更改为强且唯一的密码。
keystore-password: "change-me"
# 密钥库内私钥的密码。
# 这通常与 keystore-password 相同,但也可能不同。
# !!! 重要 !!! 将其更改为强且唯一的密码。
key-password: "change-me"
配置完成后,在控制台或游戏中使用 /dl reload,或者重启你的服务器。
HTTPS 配置:
文档尚未添加
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
评论 0
登录后参与评分
还没有评论,来抢沙发吧