shlinkio/shlink-dashboard

Shlink Dashboard

镜像概述和主要用途

Shlink Dashboard是Shlink的下一代Web应用，用于配置用户及其权限，并定义用户与各个Shlink服务器的交互方式。它在shlink-web-client的基础上增强了用户认证、权限管理和服务器信息安全存储能力，所有设置基于用户存储在服务器端，支持多设备访问一致的配置，且需自托管部署。

核心功能和特性

增强的用户认证与角色管理

• 管理员：可创建任意角色的用户，管理自己的Shlink服务器，并为托管用户配置服务器。
• 高级用户：可自行设置和管理Shlink服务器。
• 托管用户：可登录并与预配置的Shlink服务器交互。

安全与数据持久化

• 用户设置按用户存储在服务器端，多设备登录可访问一致配置。
• 服务器信息（含API密钥）存储在服务端，不泄露至浏览器，通过Dashboard后端代理与Shlink服务器交互，可隐藏服务器的/rest端点。
• 支持Shlink兼容的数据库引擎（PostgreSQL、MySQL、MariaDB、MSSQL，不支持SQLite），可复用现有数据库服务器。

初始用户配置

安装后自动创建初始用户，用户名为admin，密码为admin，首次登录需强制修改密码。

使用场景和适用范围

• 企业自托管：需多用户协作管理Shlink服务器，需要细粒度权限控制的场景。
• 安全敏感环境：需保护Shlink服务器API密钥和/rest端点不直接暴露的场景。
• 多设备管理：用户需在不同设备上保持一致配置的场景。

安装与使用方法

Docker镜像部署

基本运行命令

bash
docker run -d \
  -p 3000:3000 \
  -e SHLINK_DASHBOARD_DB_DRIVER=postgres \
  -e SHLINK_DASHBOARD_DB_HOST=db-host \
  -e SHLINK_DASHBOARD_DB_PORT=5432 \
  -e SHLINK_DASHBOARD_DB_USER=db-user \
  -e SHLINK_DASHBOARD_DB_PASSWORD=db-pass \
  -e SHLINK_DASHBOARD_DB_NAME=shlink_dashboard \
  -e SHLINK_DASHBOARD_SESSION_SECRETS=secret1,secret2 \
  --name shlink-dashboard \
  shlinkio/shlink-dashboard

Docker Compose配置示例

yaml
version: '3.8'

services:
  shlink-dashboard:
    image: shlinkio/shlink-dashboard
    ports:
      - "3000:3000"
    environment:
      - SHLINK_DASHBOARD_DB_DRIVER=mysql
      - SHLINK_DASHBOARD_DB_HOST=mysql
      - SHLINK_DASHBOARD_DB_PORT=3306
      - SHLINK_DASHBOARD_DB_USER=root
      - SHLINK_DASHBOARD_DB_PASSWORD=root-pass
      - SHLINK_DASHBOARD_DB_NAME=shlink_dashboard
      - SHLINK_DASHBOARD_SESSION_SECRETS=your-long-random-secret,another-secret
    depends_on:
      - mysql

  mysql:
    image: mysql:8.0
    environment:
      - MYSQL_ROOT_PASSWORD=root-pass
      - MYSQL_DATABASE=shlink_dashboard
    volumes:
      - mysql-data:/var/lib/mysql

volumes:
  mysql-data:

容器端口说明

默认运行在3000端口，可通过端口映射（如-p 8080:3000）修改访问端口。

配置说明

配置通过环境变量提供，支持以下参数：

数据库配置

其他配置