KolleK documentation

Welcome. KolleK is a private, self hostable home for everything you collect: comics, vinyl, coins, watches, wine, books, cards, video games, or anything else you can own. You create collections, describe them with your own custom fields, add items with photos and tags, and track every physical copy you hold, including its condition, storage location, value, and full history.

This portal is organized so a new reader can start at the top and never meet an advanced idea before they need it.

The sections

1. Getting Started. What KolleK is, creating your account, and your first catalogued item.
2. Core Concepts. The mental model: accounts, collections, items, copies, and everything around them.
3. Core Features. Day to day cataloguing: collections, items, copies, photos, and tags.
4. Tracking a Copy's History. Money, value, insurance, loans, care, provenance, moves, and documents.
5. Organizing Your Catalogue. Types and custom fields, categories, sets, series, locations, tags, and the photo library.
6. Insights. The statistics screen and the dashboard.
7. Collaboration. Inviting people, roles, and sharing collections.
8. Your Account and Profile. Personal details, language, avatar, and account settings.
9. Security. Two factor authentication, recovery codes, magic links, passwords, and API keys.
10. Data Safety and Housekeeping. The trash, deletions, and getting your data out.
11. Tutorials. Complete, end to end journeys that stitch the features together.
12. Developers and the API. Authentication, conventions, and webhooks for people building against KolleK.
13. Self Hosting and Administration. Installing, configuring, upgrading, backing up, and administering an instance.
14. Troubleshooting and FAQ. Quick answers when something does not behave as expected.
15. Reference. The glossary, every field and status option, and every email KolleK sends.

Where should you start

If you collect things. Read What is KolleK, create your account, follow the getting started checklist, then learn how KolleK is organized and the key idea of items versus copies. From there, the Core Features guides carry you through daily cataloguing, and Tracking a Copy's History is waiting when you want to record value, loans, and provenance.

If you own an account others use. Everything a collector reads, plus accounts, users, and roles, the Collaboration section, account settings, and Data Safety.

If you run an instance. Start with Cloud version versus self hosting, then work through Self Hosting and Administration from the overview onward, paying particular attention to the application key.

If you are building against the API. Read the API overview and authenticate with the API, then use the generated endpoint reference at /docs/api. Read webhooks knowing that no event fires them yet.