Trilium
Build your personal knowledge base with Trilium Notes
Install / Use
/learn @TriliumNext/TriliumREADME
Trilium Notes
<!-- translate:off --> <!-- LANGUAGE SWITCHER -->Chinese (Simplified Han script) | Chinese (Traditional Han script) | English | French | German | Greek | Italian | Japanese | Romanian | Spanish
<!-- translate:on -->Trilium Notes is a free and open-source, cross-platform hierarchical note taking application with focus on building large personal knowledge bases.
<img src="./docs/app.png" alt="Trilium Screenshot" width="1000">⏬ Download
- Latest release – stable version, recommended for most users.
- Nightly build – unstable development version, updated daily with the latest features and fixes.
📚 Documentation
Visit our comprehensive documentation at docs.triliumnotes.org
Our documentation is available in multiple formats:
- Online Documentation: Browse the full documentation at docs.triliumnotes.org
- In-App Help: Press
F1within Trilium to access the same documentation directly in the application - GitHub: Navigate through the User Guide in this repository
Quick Links
- Getting Started Guide
- Installation Instructions
- Docker Setup
- Upgrading TriliumNext
- Basic Concepts and Features
- Patterns of Personal Knowledge Base
🎁 Features
- Notes can be arranged into arbitrarily deep tree. Single note can be placed into multiple places in the tree (see cloning)
- Rich WYSIWYG note editor including e.g. tables, images and math with markdown autoformat
- Support for editing notes with source code, including syntax highlighting
- Fast and easy navigation between notes, full text search and note hoisting
- Seamless note versioning
- Note attributes can be used for note organization, querying and advanced scripting
- UI available in English, German, Spanish, French, Romanian, and Chinese (simplified and traditional)
- Direct OpenID and TOTP integration for more secure login
- Synchronization with self-hosted sync server
- Sharing (publishing) notes to public internet
- Strong note encryption with per-note granularity
- Sketching diagrams, based on Excalidraw (note type "canvas")
- Relation maps and note/link maps for visualizing notes and their relations
- Mind maps, based on Mind Elixir
- Geo maps with location pins and GPX tracks
- Scripting - see Advanced showcases
- REST API for automation
- Scales well in both usability and performance upwards of 100 000 notes
- Touch optimized mobile frontend for smartphones and tablets
- Built-in dark theme, support for user themes
- Evernote and Markdown import & export
- Web Clipper for easy saving of web content
- Customizable UI (sidebar buttons, user-defined widgets, ...)
- Metrics, along with a Grafana Dashboard.
✨ Check out the following third-party resources/communities for more TriliumNext related goodies:
- awesome-trilium for 3rd party themes, scripts, plugins and more.
- TriliumRocks! for tutorials, guides, and much more.
❓Why TriliumNext?
The original Trilium developer (Zadam) has graciously given the Trilium repository to the community project which resides at https://github.com/TriliumNext
⬆️Migrating from Zadam/Trilium?
There are no special migration steps to migrate from a zadam/Trilium instance to a TriliumNext/Trilium instance. Simply install TriliumNext/Trilium as usual and it will use your existing database.
Versions up to and including v0.90.4 are compatible with the latest zadam/trilium version of v0.63.7. Any later versions of TriliumNext/Trilium have their sync versions incremented which prevents direct migration.
💬 Discuss with us
Feel free to join our official conversations. We would love to hear what features, suggestions, or issues you may have!
- Matrix (For synchronous discussions.)
- The
GeneralMatrix room is also bridged to XMPP
- The
- Github Discussions (For asynchronous discussions.)
- Github Issues (For bug reports and feature requests.)
🏗 Installation
Windows / MacOS
Download the binary release for your platform from the latest release page, unzip the package and run the trilium executable.
Linux
If your distribution is listed in the table below, use your distribution's package.
You may also download the binary release for your platform from the latest release page, unzip the package and run the trilium executable.
TriliumNext is also provided as a Flatpak, but not yet published on FlatHub.
Browser (any OS)
If you use a server installation (see below), you can directly access the web interface (which is almost identical to the desktop app).
Currently only the latest versions of Chrome & Firefox are supported (and tested).
Mobile
To use TriliumNext on a mobile device, you can use a mobile web browser to access the mobile interface of a server installation (see below).
See issue https://github.com/TriliumNext/Trilium/issues/4962 for more information on mobile app support.
If you prefer a native Android app, you can use TriliumDroid. Report bugs and missing features at their repository. Note: It is best to disable automatic updates on your server installation (see below) when using TriliumDroid since the sync version must match between Trilium and TriliumDroid.
Server
To install TriliumNext on your own server (including via Docker from Dockerhub) follow the server installation docs.
💻 Contribute
Translations
If you are a native speaker, help us translate Trilium by heading over t
