Hoshimi

首次运行

第一次启动 Hoshimi 后会看到什么:数据目录里多了什么、界面的布局、设置了访问密钥时如何登录、默认启用的两个匿名渠道,以及每样东西在哪里。

本页带你走一遍第一次启动之后的界面。还没有安装的话,先看快速开始。

启动时发生了什么

hoshimi serve
  • 不需要配置文件。 没有 config.json 时,Hoshimi 使用全部默认值:监听 127.0.0.1:10600,不设任何密钥,只启用两个匿名渠道。config.json 在你第一次保存设置、添加账户或执行 hoshimi config set 时才会创建。
  • 数据目录。 服务器在数据目录里创建 hoshimi.db(用量、签到记录、探测结果和 Playground 对话)和 server.json(正在运行的服务器的地址和 PID)。数据目录的位置见数据目录,也显示在 设置 › 关于 中。
  • 后台定时任务。 凭据续期(每 30 分钟)和每日签到随服务器启动,日志里会各有一行。还会在后台向 PyPI 查询是否有新版本。这三项都可以关闭,见配置。
  • 浏览器。 大约一秒后浏览器打开 http://127.0.0.1:10600,地址随即变成 http://127.0.0.1:10600/#/overview。页面地址都在 # 之后,可以直接收藏,例如 #/playground、#/settings?tab=access。

界面布局

位置内容
左侧导航栏概览、模型、渠道、用量、Playground;设置 在导航栏底部。窗口较窄时导航栏变成底部的标签栏。有渠道需要处理时,渠道 上会显示数字角标
右上角实时活动 按钮:显示正在进行的调用数,点开是今天的 Token、调用次数、缓存命中率,以及正在进行和刚刚完成的调用。旁边是主题按钮,在 浅色、深色、跟随系统 之间切换

界面语言默认跟随系统(支持英文、简体中文和日文),可以在 设置 › 常规 › 语言 中固定为某一种。主题、主题色、对比度和动画在 设置 › 外观 中调整。这些界面偏好只保存在当前浏览器里,不写入服务器。

登录(设置了工具访问密钥时)

默认没有任何密钥,打开就能用。概览 页 接口 一栏底部会写着 尚未设置工具访问密钥。

设置了工具访问密钥(server.access_token)之后,浏览器第一次访问时会弹出 请输入工具访问密钥 对话框:

  1. 在 工具访问密钥 中输入密钥。
  2. 点 登录(或按 Enter)。密钥错误时提示 工具访问密钥不正确。,原来保存的密钥不受影响。

验证通过后,密钥保存在这个浏览器的 localStorage 中,之后不再询问;换一个浏览器或设备需要重新登录。在 设置 › 访问 › 密钥 中修改或清除密钥后,当前浏览器自动更新,其他浏览器需要重新登录。

设置密钥的三种方式:

hoshimi config set server.access_token "换成一个长随机字符串"   # 写入配置,重启后生效
hoshimi serve --access-token "换成一个长随机字符串"              # 只作用于这一次启动

或者在 设置 › 访问 › 密钥 › 工具访问密钥 中保存,立即生效。

工具访问密钥保护 Web UI 和管理接口(/api/v1/*、/docs、/openapi.json);模型接口 /v1/* 由另一把独立的 模型 API 密钥 保护。Playground 走的是管理接口,所以只需要工具访问密钥。两把密钥的区别和局域网访问见安全。

API 文档按钮

概览 和 设置 › 关于 中的 API 文档 按钮只在没有设置工具访问密钥时出现:/docs 是一个普通页面,无法带上浏览器里保存的密钥。设置了密钥时,用带 Authorization: Bearer <tool-access-key> 的请求获取 /openapi.json,见 API 参考。

默认的两个匿名渠道

不做任何配置,Hoshimi 就启用了两个不需要账户的渠道:

渠道ID说明
OpenCode ZenopencodeOpenCode 的匿名免费入口
Kilo AIkiloKilo 的匿名免费入口

它们在 概览 和 渠道 页显示为 就绪,账户一栏写着 无需账户;打开渠道页会看到提示 此渠道无需账户即可使用;添加账户可获得更多额度。 能用哪些模型、额度多少,取决于上游当时的目录和服务状态,随时可能变化;添加自己的账户后,上游返回的目录也可能不同。

在命令行里确认:

$ hoshimi check
ok: 2 provider(s), 0 account(s) — kilo:0 (keyless), opencode:0 (keyless)
config: /home/you/.local/share/hoshimi/config.json

不需要它们时,在渠道页关闭 已启用 开关,或者:

hoshimi config set providers.kilo.enabled false
hoshimi config set providers.opencode.enabled false

(命令行修改在服务器重启后生效。)两个匿名入口的细节见匿名渠道。

各个页面

页面第一次打开时看到教程
概览今日(Token、调用次数、缓存命中、正在进行,以及最近 24 小时的趋势);接口(Base URL 和各接口地址,可复制);渠道(已设置的渠道及其状态);服务器(版本、最新版本、默认模型)概览
模型两个匿名渠道的模型目录。目录按渠道逐个加载(正在加载供应商:n/m);可以搜索、按 提供商 和 可用性 筛选,用 探测 检查哪些模型现在能用;每行可以 复制模型 id 或 在 Playground 中打开模型
渠道所有可接入的站点和服务。上方的筛选可切换 全部、使用中、需要处理、未设置、已关闭;选中一个渠道,右侧显示它的账户、今日用量、额度和网络设置,以及 登录 或 添加账号 按钮渠道
用量还没有请求经过网关时显示 还没有任何回答。之后可以按 24 小时、7 天、30 天、90 天或单日查看 Token、缓存、延迟和每一次调用用量
Playground一个空白对话(有什么可以帮你的?),模型已选好。内置工具默认全部关闭Playground
设置八个标签页:常规、工具、访问、安全、网络、自动化、外观、关于。每一项修改后立即保存设置

东西在哪里

要做的事去哪里
添加账户、登录免费站点渠道 → 选择站点 → 登录 或 添加账号
复制给客户端用的地址概览 › 接口
设置工具访问密钥和模型 API 密钥设置 › 访问 › 密钥
修改监听地址和端口设置 › 访问 › 监听地址(重启后生效)
允许局域网访问设置 › 安全,见安全
设置代理设置 › 网络;单个渠道在它自己的渠道页
请求未指定模型时用哪个设置 › 常规 › 默认模型
开启 Playground 的工具设置 › 工具,见 Playground 工具
关闭自动签到或凭据续期设置 › 自动化
找到数据目录和配置文件设置 › 关于(数据目录、配置文件、数据库、复制配置路径),或 hoshimi config path

接下来

本页目录