Repository files navigation

^{Special thanks to:}

Warp, built for coding with multiple AI agents
^{Available for macOS, Linux and Windows}

Chinese (Simplified Han script) |Chinese (Traditional Han script) |English |French |German |Greek |Italian |Japanese |Romanian |Spanish

Trilium Notes is a free and open-source, cross-platform hierarchical note taking application with focus on building large personal knowledge bases.

• Latest release – stable version, recommended for most users.
• Nightly build – unstable development version, updated daily with the latest features and fixes.

Visit our comprehensive documentation atdocs.triliumnotes.org

Our documentation is available in multiple formats:

• Online Documentation: Browse the full documentation atdocs.triliumnotes.org
• In-App Help: PressF1 within Trilium to access the same documentation directly in the application
• GitHub: Navigate through theUser Guide in this repository

• Getting Started Guide
• Installation Instructions
• Docker Setup
• Upgrading TriliumNext
• Basic Concepts and Features
• Patterns of Personal Knowledge Base

• Notes can be arranged into arbitrarily deep tree. Single note can be placed into multiple places in the tree (seecloning)
• Rich WYSIWYG note editor including e.g. tables, images andmath with markdownautoformat
• Support for editingnotes with source code, including syntax highlighting
• Fast and easynavigation between notes, full text search andnote hoisting
• Seamlessnote versioning
• Noteattributes can be used for note organization, querying and advancedscripting
• UI available in English, German, Spanish, French, Romanian, and Chinese (simplified and traditional)
• DirectOpenID and TOTP integration for more secure login
• Synchronization with self-hosted sync server
  • there are3rd party services for hosting synchronisation server
• Sharing (publishing) notes to public internet
• Strongnote encryption with per-note granularity
• Sketching diagrams, based onExcalidraw (note type "canvas")
• Relation maps andnote/link maps for visualizing notes and their relations
• Mind maps, based onMind Elixir
• Geo maps with location pins and GPX tracks
• Scripting - seeAdvanced showcases
• REST API for automation
• Scales well in both usability and performance upwards of 100 000 notes
• Touch optimizedmobile frontend for smartphones and tablets
• Built-indark theme, support for user themes
• Evernote andMarkdown 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.

The original Trilium developer (Zadam) has graciously given the Trilium repository to the community project which resides athttps://github.com/TriliumNext

There are no special migration steps to migrate from a zadam/Trilium instance to a TriliumNext/Trilium instance. Simplyinstall TriliumNext/Trilium as usual and it will use your existing database.

Versions up to and includingv0.90.4 are compatible with the latest zadam/trilium version ofv0.63.7. Any later versions of TriliumNext/Trilium have their sync versions incremented which prevents direct migration.

Feel free to join our official conversations. We would love to hear what features, suggestions, or issues you may have!

• Matrix (For synchronous discussions.)
  • TheGeneral Matrix room is also bridged toXMPP
• Github Discussions (For asynchronous discussions.)
• Github Issues (For bug reports and feature requests.)

Download the binary release for your platform from thelatest release page, unzip the package and run thetrilium executable.

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 thelatest release page, unzip the package and run thetrilium executable.

TriliumNext is also provided as a Flatpak, but not yet published on FlatHub.

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).

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#4962 for more information on mobile app support.

If you prefer a native Android app, you can useTriliumDroid.Report bugs and missing features attheir 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.

To install TriliumNext on your own server (including via Docker fromDockerhub) followthe server installation docs.

If you are a native speaker, help us translate Trilium by heading over to ourWeblate page.

Here's the language coverage we have so far:

Download the repository, install dependencies usingpnpm and then run the server (available athttp://localhost:8080):

git clone https://github.com/TriliumNext/Trilium.gitcd Triliumpnpm installpnpm run server:start

Download the repository, install dependencies usingpnpm and then run the environment required to edit the documentation:

git clone https://github.com/TriliumNext/Trilium.gitcd Triliumpnpm installpnpm edit-docs:edit-docs

Alternatively, if you have Nix installed:

# Run directlynix run .#edit-docs# Or install to your profilenix profile install .#edit-docstrilium-edit-docs

Download the repository, install dependencies usingpnpm and then build the desktop app for Windows:

git clone https://github.com/TriliumNext/Trilium.gitcd Triliumpnpm installpnpm run --filter desktop electron-forge:make --arch=x64 --platform=win32

For more details, see thedevelopment docs.

Please view thedocumentation guide for details. If you have more questions, feel free to reach out via the links described in the "Discuss with us" section above.

• zadam for the original concept and implementation of the application.
• Sarah Hussein for designing the application icon.
• nriver for his work on internationalization.
• Thomas Frei for his original work on the Canvas.
• antoniotejada for the original syntax highlight widget.
• Dosu for providing us with the automated responses to GitHub issues and discussions.
• Tabler Icons for the system tray icons.

Trilium would not be possible without the technologies behind it:

• CKEditor 5 - the visual editor behind text notes. We are grateful for being offered a set of the premium features.
• CodeMirror - code editor with support for huge amount of languages.
• Excalidraw - the infinite whiteboard used in Canvas notes.
• Mind Elixir - providing the mind map functionality.
• Leaflet - for rendering geographical maps.
• Tabulator - for the interactive table used in collections.
• FancyTree - feature-rich tree library without real competition.
• jsPlumb - visual connectivity library. Used inrelation maps andlink maps

Trilium is built and maintained withhundreds of hours of work. Your support keeps it open-source, improves features, and covers costs such as hosting.

Consider supporting the main developer (eliandoran) of the application via:

• GitHub Sponsors
• PayPal
• Buy Me a Coffee

Copyright 2017-2025 zadam, Elian Doran, and other contributors

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.