triliumnext/trilium repository overview

⁠Trilium Notes

English⁠ | Chinese (Simplified)⁠ | Chinese (Traditional)⁠ | Russian⁠ | Japanese⁠ | Italian⁠ | Spanish⁠

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

See screenshots⁠ for quick overview:

⁠🎁 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
  • there's a 3rd party service for hosting synchronisation 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 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.

⁠📖 Documentation

We're currently in the progress of moving the documentation to in-app (hit the F1 key within Trilium). As a result, there may be some missing parts until we've completed the migration. If you'd prefer to navigate through the documentation within GitHub, you can navigate the User Guide⁠ documentation.

Below are some quick links for your convenience to navigate the documentation:

• Server installation⁠
  • Docker installation⁠
• Upgrading TriliumNext⁠
• Concepts and Features - Note⁠
• Patterns of personal knowledge base⁠

Until we finish reorganizing the documentation, you may also want to browse the old documentation⁠.

⁠💬 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 General Matrix room is also bridged to XMPP⁠
• 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 to our Weblate page⁠.

Here's the language coverage we have so far:

⁠Code

Download the repository, install dependencies using pnpm and then run the server (available at http://localhost:8080⁠):

git clone https://github.com/TriliumNext/Trilium.git
cd Trilium
pnpm install
pnpm run server:start

⁠Documentation

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

git clone https://github.com/TriliumNext/Trilium.git
cd Trilium
pnpm install
pnpm nx run edit-docs:edit-docs

⁠Building the Executable

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

git clone https://github.com/TriliumNext/Trilium.git
cd Trilium
pnpm install
pnpm nx --project=desktop electron-forge:make -- --arch=x64 --platform=win32

For more details, see the development docs⁠.

⁠Developer Documentation

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

⁠👏 Shoutouts

• CKEditor 5⁠ - best WYSIWYG editor on the market, very interactive and listening team
• FancyTree⁠ - very feature rich tree library without real competition. Trilium Notes would not be the same without it.
• CodeMirror⁠ - code editor with support for huge amount of languages
• jsPlumb⁠ - visual connectivity library without competition. Used in relation maps⁠ and link maps⁠

⁠🤝 Support

Support for the TriliumNext organization will be possible in the near future. For now, you can:

• Support continued development on TriliumNext by supporting our developers: eliandoran⁠ (See the repository insights⁠ for a full list)
• Show a token of gratitude to the original Trilium developer (zadam⁠) via PayPal⁠ or Bitcoin (bitcoin:bc1qv3svjn40v89mnkre5vyvs2xw6y8phaltl385d2).

⁠🔑 License

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.