What is Lore?
Lore is an open source workspace where technical teams gather, search and maintain their documentation: runbooks, procedures, architecture documents and incident reports.
Documentation for version 0.1, in preparation. Commands, variables and API endpoints are proposals: they may change before the release.
What Lore does
- Library v0.1: spaces per team or domain, folders, and documents imported as PDF, Word, text or Markdown.
- Search v0.1: full-text search that finds technical identifiers exactly as written and opens each document at the right passage.
- Versions and statuses v0.1: every import creates a version; every document has a status and an owner.
- Permissions v0.1: roles per space and restricted documents, enforced everywhere, search included.
- Knowledge base v0.2: problem and solution articles, approved by the space owners.
- Assistant v0.3: optional answers in natural language, with their sources.
Where Lore stands
Lore is getting ready for version 0.1. Today, the application handles the initial setup, sign-in, invitations, password resets, My account and the administration of the organization: members, roles and security settings. The library, search, versions and document permissions come with version 0.1.
What Lore is not
Lore is not a chatbot. The assistant is an optional module, turned off by default: the library, search, versions and permissions will work entirely without artificial intelligence.
Principles
| Principle | What it means |
|---|---|
| Permissions first | Nobody sees the content of a document they cannot access: not in lists, results, excerpts, or through the assistant. |
| Sourced and verifiable | Every result points to the original document, version and passage. |
| Works without AI | The assistant is a module each organization turns on or not. |
| Easy to host | Lore and PostgreSQL, nothing else: with Docker, a .deb or .rpm package, or an archive, in less than five minutes. |
Where to start
- Installation: install Lore with Docker, a package or the archive.
- First steps: invite your team, adjust security and your account.
- Members and invitations: roles, invitations and password resets.
- Environment variables: every configuration option.
To see the application without installing anything, open the demo, filled with sample data.