KolleK 文档
欢迎。KolleK 是一个私密的、可自托管的收藏管理平台,可以用来管理你收藏的任何东西:漫画、黑胶唱片、硬币、手表、葡萄酒、书籍、卡牌、电子游戏,或者其他任何你拥有的物品。你可以创建收藏,用自定义字段描述它们,为藏品添加照片和标签,并追踪你持有的每一件实体副本,包括它的品相、存放位置、价值和完整历史记录。
本文档站按照循序渐进的顺序组织,新读者可以从头开始阅读,不会在准备好之前遇到进阶概念。
章节导览
- 入门指南。KolleK 是什么、如何创建你的账户,以及你编目的第一件藏品。
- 核心概念。核心概念模型:账户、收藏、藏品、副本,以及与之相关的一切。
- 核心功能。日常编目工作:收藏、藏品、副本、照片和标签。
- 追踪副本的历史。金钱、价值、保险、外借、保养、来源、转移和文档记录。
- 整理你的收藏目录。类型与自定义字段、分类、套装、系列、位置、标签,以及照片库。
- 洞察。统计页面与仪表盘。
- 协作。邀请他人、角色设置,以及共享收藏。
- 你的账户与个人资料。个人信息、语言、头像和账户设置。
- 安全。两步验证、恢复代码、魔法链接、密码和 API 密钥。
- 数据安全与日常维护。回收站、删除操作,以及导出你的数据。
- 教程。将各项功能串联起来的完整端到端教程。
- 开发者与 API。面向基于 KolleK 进行开发的用户的身份验证、约定和 Webhook。
- 自托管与管理。实例的安装、配置、升级、备份和管理。
- 故障排查与常见问题。当某些行为不符合预期时的快速解答。
- 参考手册。术语表、所有字段与状态选项,以及 KolleK 发送的每一封邮件。
你应该从哪里开始
如果你是收藏者。 阅读 什么是 KolleK、创建你的账户,跟着 新手入门清单 操作,然后学习 KolleK 的组织方式 以及 藏品与副本的区别 这一关键概念。在此基础上,核心功能 中的指南会带你完成日常编目工作,而当你想要记录价值、外借和来源信息时,追踪副本的历史 随时可用。
如果你的账户有其他人在使用。 除了收藏者需要阅读的全部内容之外,还应阅读 账户、用户与角色、协作 章节、账户设置,以及 数据安全。
如果你运行着一个实例。 先阅读 云托管还是自托管,然后从 概述 开始,依次通读整个 自托管与管理 章节,并特别留意 应用密钥 部分。
如果你正在基于 API 进行开发。 阅读 API 概览 和 通过 API 进行身份验证,然后参考 /docs/api 上自动生成的接口文档。你也可以阅读 Webhook,不过目前还没有任何事件会触发它们。
KolleK 文档
在 GitHub 上编辑此页
此页面有帮助吗?