kodehat/portkey

这是什么？

核心功能

• 01以起始页形式展示链接，并可按名称分组。
• 02支持自定义关键词的搜索，可选模糊匹配。
• 03自动获取并缓存外部链接的 favicon。
• 04门户图标支持 emoji、图片文件或 URL。
• 05可在指定路径添加自定义 HTML 页面。
• 06全部配置集中在一个 YAML 文件中，也可通过环境变量覆盖。

适用场景

• 将其设为浏览器起始页，集中访问常用的内部工具和网站。
• 在家庭服务器或内网中搭建团队共享的链接导航页。
• 在资源链接列表旁边发布一个简单的自定义说明页面。

快速上手

1. 1

   下载适用于你操作系统的 portkey 文件,并放到 PATH 路径中

2. 2

   创建 config.yml,或使用仓库中的示例配置

3. 3

   使用配置文件路径启动应用(若 config.yml 位于当前工作目录,则可省略该参数)

   portkey --config-path=<dir_to_config_yml>
4. 4

   在浏览器中打开已配置的主机和端口,默认为 http://localhost:3000

使用前须知

• !采用 AGPL-3.0 许可证,这是一种强 Copyleft 许可证,对网络提供的修改版本同样适用。
• !对于未设置图标的外部链接,它会发出出站 HTTP 请求以获取网站图标。

收录于专题

标签

常见问题

portkey 是什么？

一个轻量的自托管起始页，用一个配置文件管理链接集合，支持搜索和自定义页面。 portkey 是一个网页门户，可以用作浏览器起始页或个人链接面板。所有链接都写在一个 config.yml 文件里，可以按名称分组，应用会将其渲染为带搜索框的首页，并支持深色和浅色模式。

portkey 可以免费使用吗？用的什么许可证？

portkey 以 AGPL-3.0 许可证开源。用于商业产品前，请先确认许可证条款。

portkey 还在维护吗？

活跃维护中。portkey 最近一次提交是在 2026年11月6日。

portkey 适合用来做什么？

将其设为浏览器起始页，集中访问常用的内部工具和网站。 在家庭服务器或内网中搭建团队共享的链接导航页。 在资源链接列表旁边发布一个简单的自定义说明页面。

portkey 怎么安装和运行？

下载适用于你操作系统的 portkey 文件,并放到 PATH 路径中 创建 config.yml,或使用仓库中的示例配置 使用配置文件路径启动应用(若 config.yml 位于当前工作目录,则可省略该参数): portkey --config-path=<dir_to_config_yml> 在浏览器中打开已配置的主机和端口,默认为 http://localhost:3000

在哪里获取 portkey？

源代码和安装说明在 GitHub 上：https://github.com/kodehat/portkey