{% extends "base.html" %} {% block title %}{{ _('about.page_title') }}{% endblock %} {% block content %}
LLMWikiNG (OKF Edition) is a local, privacy-friendly wiki platform developed by ZeroDot1. It is based on the standardized Open Knowledge Format (OKF) v0.2 and inspired by Andrej Karpathy's LLM-Wiki-Pattern. The wiki is built, maintained, and extended by intelligent LLM agents β and you can easily view, search, and manage it directly from your web browser.
Special thanks to https://github.com/tevsa for the great idea and awesome support in building this project!
[Label](/path/to/page.md)) instead of proprietary Wikilinks.wikis/<Name>/, managed via the WebUI.graph.css).static/js/search.js.#hashtags are clickable links leading to the Tag Cloud page (/tags). Tags are auto-generated during ingest & sync, and centrally persisted in data/tags.json.config.json (Dark Mode is default)./api/v1./tmp and restores them automatically after git reset.DOCKER_VOLUME_BASE path variable./update, /ingest, /backup, /search, /status, /lint, etc.) for AI assistants (AGY, Cursor, OpenCode, Hermes, Claude Code) to read, write, search, update, and manage the wiki using OKF v0.2 format. Supports query pagination, tool permission filtering, similarity recommendations, duplicate-safe metadata updates, and conflict detection via content_hash tracking in every page's frontmatter.{{ _('about.version_text') }} {{ app_version }}
| {{ _('about.tech_table_component') }} | {{ _('about.tech_table_version') }} |
|---|---|
| Python | {{ python_version }} |
| FastAPI (ASGI Framework) | {{ fastapi_version }} |
| Uvicorn (ASGI Server) | {{ uvicorn_version }} |
| Python-Markdown | {{ markdown_version }} |
| Matrix-Index | {{ matrix_version }} |
| Jinja2 | {{ jinja_version }} |
LLMWikiNG/ βββ run.py # π Entrypoint (starts the FastAPI server) βββ backend/ # FastAPI backend (core/, api/, services/) β βββ main.py # create_app(), uvicorn startup β βββ web.py # Jinja2Templates, base_context() β βββ core/ # config, security (Argon2), storage β βββ api/routes/ # pages.py, auth.py, api.py, register.py β βββ services/ # wiki, markdown, search, graph, lint, cache, β¦ βββ frontend/ # Tailwind CSS v4 pipeline βββ wiki.sh # CLI tool (Search, Ingest, Export, Lint, Update) βββ update.sh # β¬οΈ Self-update script (Git-based) βββ config.json # βοΈ Theme, SMTP & Language settings βββ start.sh # Startup script wrapper βββ wikis/ # Multi-wiki directories (wiki/ β wikis/main/) βββ raw/ # Archived raw sources βββ tools/ # Auxiliary utility tools βββ templates/ # HTML templates (Jinja2) βββ static/ # CSS (Tailwind, graph.css), JS-Module, Graph-Engine (Vanilla JS) βββ output_docs/ # Exported documents βββ .agy.yaml # Agent configuration
| Route | Description |
|---|---|
/ | Dashboard (Wiki switcher, stats & activity timeline) |
/login, /logout | Authentication (Username + Password) |
/register | User Registration / Initial Setup |
/users, /users/<id>/edit, /users/<id>/delete, /api-keys | User and API Key management (Admin only) |
/wikis/new | Initialize a new wiki via the WebUI |
/wiki/<name>/ | Wiki home page (index.md) |
/wiki/<name>/<page> | Renders a wiki page (with backlinks & trail) |
/wiki/<name>/<page>/export | Exports the page as Markdown to output_docs/ |
/wiki/<name>/<page>/delete | Deletes the page and updates search index |
/search | BM25 hybrid search page |
/lint | Web Linter (health checks) |
/status | System status and environment overview |
/briefings | Generates weekly reports and emails them |
/config | SMTP Configuration |
/ingest | Ingest panel (Upload, Textpaste, URL bookmarking) |
/graph | πΈοΈ Interactive Knowledge Graph (Lazy Loading, LOD) |
/graph/data/paginated | Paginated graph JSON for large wikis (lazy loading) |
/pending | β³ Pending uploads |
/raw | π¦ Raw sources explorer |
/edit | βοΈ Universal editor (WYSIWYG & Markdown modes) |
/settings | βοΈ Settings (Language, Theme, SMTP, Wiki Management, Users, Keys, Health, Updates) |
/docs | π Documentation |
/about | βΉοΈ About page |
/api/v1/* | π JSON API (Key-protected or Session Cookie): Wikis, pages, search, graph, stats, lint, status, users, API keys, ingest, export, system |
/mcp/sse, /mcp/messages | π€ Model Context Protocol (MCP) SSE/JSON-RPC channels (Key-protected) |
The web server can be started with the following CLI arguments (directly or via start.sh):
| Argument | Via start.sh | Description |
|---|---|---|
--port, -p PORT | ./start.sh 9090 | Port (default: 8080) |
--host, -H HOST | β | Bind host address (default: 0.0.0.0) |
--debug, -d | ./start.sh -d | Debug mode (Live-reload) |
--lang, -l CODE | ./start.sh --lang en | Default startup language |
| Command | Description |
|---|---|
./wiki.sh init | Initializes folders, Matrix search index, index.md, and log.md |
./wiki.sh search "Query" | Runs a full-text search (FTS5) via the Matrix index |
./wiki.sh ingest <file> | Ingests a new raw source into the wiki |
./wiki.sh export <page> | Exports a wiki page to output_docs/ |
./wiki.sh list | Lists all pages in the current wiki |
./wiki.sh lint | Performs a quick system health check |
./wiki.sh sync | Updates the Matrix index and tag index |
./wiki.sh reindex | Rebuilds index.md and activity logs |
./wiki.sh status | Shows wiki statistics and system health state |
./wiki.sh config | Displays current configuration |
./wiki.sh watcher | Starts the background file watcher for auto-sync |
./wiki.sh history <page> | Shows version history of a wiki page |
./wiki.sh export <page> --pdf | Exports a page as PDF to output_docs/ |
./wiki.sh reset | β οΈ Resets the wiki to factory settings |
./wiki.sh update | β¬οΈ Self-updates via GitHub |
./wiki.sh help | Shows the help panel |
This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).
Under this license, any modified versions of the software that are offered as a service over a network must disclose their full source code under the same license terms.
See the LICENSE file for the full text.
This project uses the following custom/external components:
Custom dependency-free graph engine – force-directed layout with Barnes-Hut O(n log n) approximation, Viewport Culling, Level-of-Detail rendering, and Lazy Loading rendered via the Canvas 2D API (no external libraries).
Author: ZeroDot1 for LLMWikiNG · License: AGPL-3.0