draganczukp/simply-shorten

simply-shorten Docker镜像文档

!Docker Pulls

仓库已迁移至GitLab

镜像概述

simply-shorten是一个简单的自托管URL缩短器，专注于核心功能，无任何不必要的特性。项目被作者视为已完成状态而非停止维护，虽然不会添加新功能，但会修复报告的bug。如果认为缺少必要功能，可通过"功能请求"模板创建issue反馈。

开发背景

作者调研了多个流行URL缩短器后发现，它们要么包含多余功能，要么缺乏所需的关键特性，因此开发了此工具。

核心功能和特性

• 将任意长度URL缩短为固定长度的随机生成字符串
• （可选）支持自定义短链接（许多同类工具缺失此功能）
• 访问短链接时立即重定向至原始长URL
• 提供简单API用于添加新短链接
• 使用SQLite数据库存储链接数据
• 提供Docker容器化部署方案
• 技术栈：后端基于Java (Spark Java)，前端使用纯HTML、原生JS及Pure CSS样式

不会实现的功能（避免臃肿）

• 任何形式的日志、跟踪或监控功能（仅保留错误信息输出至stderr和默认SLF4J警告）
• 用户管理功能（如需多用户使用，建议为每个用户运行独立容器或选择其他工具）
• Cookie、新闻订阅、隐私弹窗等现代网页反用户体验特性
• 付费墙或请求（如需支持作者，可通过Github issues或邮件联系：）

使用场景和适用范围

适用于需要自托管URL缩短服务的个人用户或小型团队，尤其适合注重简洁性、隐私保护和轻量级部署的场景。不适合需要用户管理、详细统计分析或复杂权限控制的企业级应用。

使用方法和配置说明

从源码构建

需安装Gradle 6.x.x和JDK 11（其他版本未测试）

1. 构建JAR文件

bash
gradle build --no-daemon

--no-daemon选项确保构建完成后Gradle进程退出，避免后台运行。

2. 设置环境变量

bash
# 认证必填
export username=<API用户名>
export password=<API密码>
# 数据库位置（可选，本地或远程）
export db_url=<数据库URL>  # 默认值: './urls.sqlite'

3. 运行应用

bash
java -jar build/libs/url.jar

可通过添加--port=[端口号]参数指定服务监听端口

4. 访问应用

在浏览器中打开http://localhost:4567即可使用界面添加短链接

使用Docker运行

docker run方式

（可选）构建镜像

bash
docker build . -t simply-shorten:latest

基础运行

bash
docker run -p 4567:4567 \
    -e username="用户名" \
    -e password="密码" \
    -d simply-shorten:latest

持久化数据库（推荐）

bash
touch ./urls.sqlite
docker run -p 4567:4567 \
    -e username="用户名" \
    -e password="密码" \
    -v ./urls.sqlite:/urls.sqlite \
    -e db_url=/urls.sqlite \
    -d simply-shorten:latest

docker-compose方式

仓库中提供示例docker-compose.yml文件，包含基础安装所需的所有配置。可直接使用或根据需求修改：

bash
docker-compose up -d

环境变量配置

禁用认证（不推荐）

设置以下环境变量可完全禁用认证（允许任何人创建和删除链接，存在安全风险）：

bash
INSECURE_DISABLE_PASSWORD=I_KNOW_ITS_BAD

注意：仅当值为"I_KNOW_ITS_BAD"时才会禁用认证，其他值无效。