daledavies/jump

Jump

Jump是一个自托管的服务器起始页和实时状态页面，设计理念是简单、时尚、快速且安全。

https://github.com/daledavies/jump

核心功能与特性

• 快速部署、安全可靠
• 轻松添加站点并使用自定义图标，或让Jump自动获取站点原图标
• 通过标签对站点进行分类，支持多页面展示
• 实时监控每个站点的状态
• 使用自定义背景图片或从Unsplash获取随机背景图片
• 支持按名称、标签、URL快速搜索，带有键盘快捷键
• 自定义搜索引擎列表，可通过搜索框访问
• 集成Open Weather Map，显示当地时间和天气
• 多种布局选项，包括响应式移动设备界面
• 可轻松启用/禁用所有配置选项，根据需求定制Jump

演示 - jumpdemo.daledavies.co.uk

注意：演示实例托管在render.com的免费 tier，可能需要几秒钟唤醒时间。

安装

Docker Compose

从Docker Hub获取容器镜像（https://hub.docker.com/r/daledavies/jump%EF%BC%89%E3%80%82

以下配置将启动Jump并在http://localhost:8123%E6%8F%90%E4%BE%9B%E6%9C%8D%E5%8A%A1%EF%BC%8C%E5%8C%85%E5%90%AB%E8%87%AA%E5%AE%9A%E4%B9%89%E7%AB%99%E7%82%B9%E5%90%8D%E7%A7%B0%E3%80%81Open Weather Map支持，以及将Jump的"backgrounds"、"favicon"、"search"和"sites"目录映射到本地目录（下方的OWMAPIKEY和LATLONG值仅为示例）：

yaml
version: '3'
services:
    web:
        image: docker.xuanyuan.run/daledavies/jump
        ports:
            - 8123:8080
        volumes:
            - ./backgrounds:/backgrounds
            - ./favicon:/favicon
            - ./search:/search
            - ./sites:/sites
        environment:
            SITENAME: '自定义站点名称'
            OWMAPIKEY: '0a1b2c3d4e5f6a7b8c9d0a1b'
            LATLONG: '51.509865,-0.118092'

可使用以下可选环境变量配置Jump站点：

• SITENAME - 自定义站点名称
• SHOWCLOCK: 'false' - 隐藏时钟
• AMPMCLOCK: 'true' - 启用12小时制时钟格式
• SHOWGREETING: 'false' - 显示"#home"标签而非友好问候语
• CUSTOMGREETING: '自定义问候语' - 使用自定义问候语
• SHOWSEARCH : 'false' - 隐藏搜索按钮（禁用搜索）
• ALTLAYOUT: 'true' - 使用替代布局显示站点列表
• CUSTOMWIDTH: 1000 - 设置页面容器/站点列表的自定义宽度
• BGBLUR: 50 - 背景图片模糊百分比
• BGBRIGHT: 90 - 背景图片亮度百分比
• UNSPLASHAPIKEY - Unsplash API密钥，启用从Unsplash获取随机背景图片
• UNSPLASHCOLLECTIONS - Unsplash集合ID列表（逗号分隔），从中选择随机图片
• ALTBGPROVIDER - 替代背景图片提供商URL
• OWMAPIKEY - Open Weather Map API密钥，需同时定义LATLONG
• LATLONG - 默认位置的经纬度（例如"51.509865,-0.***"）
• METRICTEMP: 'true' - 温度单位（公制°C或英制°F）
• CHECKSTATUS: 'false' - 禁用站点可用性状态检查
• STATUSCACHE: 5 - 站点状态缓存持续时间（分钟）
• NOINDEX: 'true' - 在站点头部包含robots noindex元标签
• WWWURL - 当Jump托管在子目录时使用（例如"/startpage"）
• DISABLEIPV6 - 禁用IPv6（如需要）
• DOCKERSOCKET - 挂载的Docker套接字位置，用于无代理Docker集成（例如"/var/run/docker.sock"）
• DOCKERPROXYURL - Docker代理URL，用于带代理的Docker集成（例如"dockerproxy:2375"）
• DOCKERONLYSITES: 'false' - 设为true仅使用Docker集成，不定义sites.json
• LANGUAGE: 'en' - 设置语言代码（详见语言部分）
• CACHEBYPASS: 'true' - 绕过所有缓存，便于测试更改
• DEBUG: 'true' - 启用调试模式

注意： OWMAPIKEY和LATLONG配置选项必须同时定义。DOCKERSOCKET和DOCKERPROXYURL互斥。

卷映射

可如上述Docker Compose示例将"backgrounds"、"favicon"、"search"和"sites"目录映射到本地目录。容器启动时，若本地目录为空，将自动填充Jump的默认文件；若本地目录已包含文件，则使用本地文件。

Docker CLI

也可使用Docker CLI实现相同效果：

bash
docker run -d -p 8123:8080 \
--volume <本地背景图片路径>:/backgrounds \
--volume <本地图标路径>:/favicon \
--volume <本地站点配置路径>:/sites \
--volume <本地搜索配置路径>:/search \
--env SITENAME='自定义站点名称' \
--env OWMAPIKEY='<Open Weather API密钥>' \
--env LATLONG='<纬度,经度>' \
--name jump docker.xuanyuan.run/daledavies/jump

非Docker方式

克隆此仓库并将jumpapp目录中的所有内容复制到服务器，编辑config.php。

通过composer安装依赖，在网站根目录运行：

bash
composer install --no-dev

确保创建缓存目录并授予Web用户写入权限，缓存目录应与config.php中的cachedir配置匹配。

配置

Open Weather Map

通过在config.php中添加Open Weather Map API密钥或向Docker容器传递OWMAPIKEY环境变量（如上文所述），可配置Jump获取本地时间和天气更新。

还需提供默认LATLONG字符串（例如"51.509865,-0.***"），Jump将使用此值直到用户点击位置按钮并允许浏览器获取位置。

站点配置

sites.json文件用于定义站点的默认配置和手动添加起始页站点，适用于添加网络上任何位置的站点。Jump也可与Docker集成，自动列出同一Docker主机上运行的站点。

站点默认值和手动配置

编辑/sites/sites.json文件添加自定义站点：

json
{
    "default": {
        "nofollow": true,
        "icon": "my-default-icon.png",
        "newtab": false
    },
    "sites": [
        {
            "name": "Github",
            "url" : "https://github.com/daledavies/jump",
            "description": "示例描述",
            "nofollow": false,
            "newtab": true
        },
        {
            "name": "Docker Hub",
            "url" : "https://hub.docker.com/r/daledavies/jump"
        },
        {
            "name": "Bitwarden",
            "url" : "https://bitwarden.example.com",
            "description": "带描述的站点示例",
            "icon": "bitwarden.png",
            "tags": ["stuff"]
        },
        {
            "name": "Gitea",
            "url" : "https://git.example.com",
            "icon": "gitea.png",
            "tags": ["stuff"]
        },
        {
            "name": "Nextcloud",
            "url" : "https://cloud.example.com",
            "icon": "nextcloud.png",
            "tags": ["home", "stuff", "things"]
        },
        {
            "name": "Google",
            "url" : "https://www.google.com",
            "nofollow": false
        },
        {
            "name": "Teapot",
            "url" : "https://www.google.com/pagedoesnotexist",
            "status": {
                "allowed_status_codes": [418],
                "request_method": "GET",
                "url": "https://www.google.com/teapot",
                "verify_cert": false
            }
        }
    ]
}

• name和url为必填项
• description、tags、nofollow、newtab、icon和status为可选项

标签

可使用标签对站点分类，在sites.json的每个站点中列出多个标签。无标签的站点显示在主页，多标签站点可通过指定"home"标签显示在主页。

页面右上角仅在存在标签站点时显示标签选择按钮，点击打开包含所有标签的弹出菜单。

默认选项

Jump为未指定图标的站点提供内置默认图标，也可在default部分覆盖默认图标。还可将nofollow和newtab全局设为true。

图标

通过将自定义图标放在/sites/icons/目录并在sites.json中使用icon选项引用文件名，可为站点提供自定义图标。若未提供，Jump将尝试获取站点favicon，失败则显示默认图标。

Jump还支持https://github.com/walkxcode/dashboard-icons%E3%80%82%E4%BB%8Ehttps://github.com/walkxcode/dashboard-icons/tree/main/svg%E9%80%89%E6%8B%A9%E5%9B%BE%E6%A0%87%EF%BC%8C%E4%BD%BF%E7%94%A8%60icon%60%E9%80%89%E9%A1%B9%E6%B7%BB%E5%8A%A0%E6%96%87%E4%BB%B6%E5%90%8D%EF%BC%88%E4%B8%8D%E5%B8%A6%E6%89%A9%E5%B1%95%E5%90%8D%EF%BC%89%EF%BC%8C%E4%BE%8B%E5%A6%82%60adguard-home%60%E3%80%82

nofollow

使用"nofollow": true为特定站点链接添加rel="nofollow"；若全局默认设为true，可使用"nofollow": false为单个站点移除该属性。

newtab

使用"newtab": true使特定站点链接在新浏览器标签中打开。

状态检查

可针对每个站点定义状态检查选项：

• allowed_status_codes: 额外的4XX/5XX状态码列表，表示站点在线（例如"418 I'm a teapot"）
• request_method: 默认使用HEAD请求检查状态，可指定为GET
• url: 用于状态检查的替代URL，而非主站点URL
• verify_cert: 禁用SSL证书验证（适用于自签名证书站点）

Docker集成

强烈建议使用https://github.com/Tecnativa/docker-socket-proxy%E8%AE%BE%E7%BD%AEDocker%E9%9B%86%E6%88%90%EF%BC%8C%E9%81%BF%E5%85%8D%E7%9B%B4%E6%8E%A5%E5%B0%86%E4%B8%BB%E6%9C%BADocker API暴露给Jump。

使用代理

yaml
# 配置docker socket proxy容器
dockerproxy:
    image: docker.xuanyuan.run/tecnativa/docker-socket-proxy:latest
    environment:
        - CONTAINERS=1 # 允许查看容器
        - POST=0 # 设为只读连接
    volumes:
        - /var/run/docker.sock:/var/run/docker.sock:ro # 本地套接字只读挂载

# 配置Jump使用docker socket proxy
web:
    image: docker.xuanyuan.run/daledavies/jump
    ports:
        - 8123:8080
    volumes:
        - ./backgrounds:/backgrounds
        - ./favicon:/favicon
        - ./search:/search
        - ./sites:/sites
    environment:
        SITENAME: '自定义站点名称'
        DOCKERPROXYURL: 'dockerproxy:2375' # 匹配上述代理主机名和端口
    depends_on:
        - dockerproxy # 确保dockerproxy在jump之前启动

为Jump配置Docker站点

对每个要在起始页列出的Docker服务，按以下方式配置标签，每个标签对应手动配置部分的选项：

yaml
somesite:
    image: docker.xuanyuan.run/dockerimage
    labels:
        jump.name: '测试站点'
        jump.url: 'https://test.site'
        jump.description: '这是一个测试站点'
        jump.tags: 'home, stuff, things'
        jump.status.allowed_status_codes: '418, 500'
        jump.status.request_method: 'GET'
        jump.status.verify_cert: false

搜索引擎配置

编辑/search/searchengines.json文件自定义搜索下拉列表中的搜索引擎，列表中的第一个为默认搜索引擎：

json
[
    {
        "name": "Google",
        "url": "https://www.google.co.uk/search?q="
    },
    {
        "name": "DuckDuckGo",
        "url": "https://duckduckgo.com/?q="
    },
    {
        "name": "Bing",
        "url": "https://www.bing.com/search?q="
    }
]

可使用ctrl-shift-/键盘快捷键快速打开搜索栏并直接输入搜索内容。

背景图片

要使用自定义背景图片，只需将图片复制到/backgrounds/目录，Jump会在页面加载时自动随机显示。

若要使用Unsplash的随机背景图片，在config.php中添加Unsplash API密钥或向Docker容器传递UNSPLASHAPIKEY环境变量。可通过config.php的unsplashcollections选项或UNSPLASHCOLLECTIONS环境变量提供逗号分隔的集合ID列表。

网站图标(Favicon)

按Docker Compose或Docker示例映射favicon目录后，将默认icon.png文件替换为自定义PNG图标（确保文件名始终为icon.png）。

语言

Jump已翻译成以下语言，通过config.php的language选项或LANGUAGE环境变量传递相应语言代码即可使用：

• cs - 捷克语
• de - 德语
• es - 西班牙语
• it - 意大利语
• nl - 荷兰语
• pt - 葡萄牙语
• ru - 俄语
• ua - 乌克兰语

欢迎贡献更多翻译！如需贡献，请参考现有https://github.com/daledavies/jump/tree/main/jumpapp/translations%E5%B9%B6%E5%88%9B%E5%BB%BA%E6%8B%89%E5%8F%96%E8%AF%B7%E6%B1%82%E3%80%82

调试

若遇到问题，可启用内置调试选项。在config.php中设置debug为true或通过DEBUG环境变量启用。

解决问题时，也可使用cachebypass选项禁用Jump的所有缓存。