triliumnext/trilium

Trilium Notes

!GitHub *** !*** patrons
!Docker Pulls !GitHub Downloads (all assets, all releases)
![RelativeCI]([] ![Translation status]([]

English | Chinese (Simplified) | Chinese (Traditional) | *** | 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 https://triliumnext.github.io/Docs/Wiki/screenshot-tour for quick overview:

https://triliumnext.github.io/Docs/Wiki/screenshot-tour

🎁 Features

• Notes can be arranged into arbitrarily deep tree. Single note can be placed into multiple places in the tree (see https://triliumnext.github.io/Docs/Wiki/cloning-notes)
• Rich WYSIWYG note editor including e.g. tables, images and https://triliumnext.github.io/Docs/Wiki/text-notes with markdown https://triliumnext.github.io/Docs/Wiki/text-notes#autoformat
• Support for editing https://triliumnext.github.io/Docs/Wiki/code-notes, including syntax highlighting
• Fast and easy https://triliumnext.github.io/Docs/Wiki/note-navigation, full text search and https://triliumnext.github.io/Docs/Wiki/note-hoisting
• Seamless https://triliumnext.github.io/Docs/Wiki/note-revisions
• Note https://triliumnext.github.io/Docs/Wiki/attributes can be used for note organization, querying and advanced https://triliumnext.github.io/Docs/Wiki/scripts
• UI available in English, German, Spanish, French, Romanian, and Chinese (simplified and traditional)
• Direct OpenID and TOTP integration for more secure login
• https://triliumnext.github.io/Docs/Wiki/synchronization with self-hosted sync server
  • there's a 3rd party service for hosting synchronisation server
• https://triliumnext.github.io/Docs/Wiki/sharing (publishing) notes to public internet
• Strong https://triliumnext.github.io/Docs/Wiki/protected-notes with per-note granularity
• Sketching diagrams, based on Excalidraw (note type "canvas")
• https://triliumnext.github.io/Docs/Wiki/relation-map and https://triliumnext.github.io/Docs/Wiki/link-map for visualizing notes and their relations
• Mind maps, based on Mind Elixir
• Geo maps with location pins and GPX tracks
• https://triliumnext.github.io/Docs/Wiki/scripts - see https://triliumnext.github.io/Docs/Wiki/advanced-showcases
• https://triliumnext.github.io/Docs/Wiki/etapi for automation
• Scales well in both usability and performance upwards of 100 000 notes
• Touch optimized https://triliumnext.github.io/Docs/Wiki/mobile-frontend for smartphones and tablets
• Built-in https://triliumnext.github.io/Docs/Wiki/themes, support for user themes
• https://triliumnext.github.io/Docs/Wiki/evernote-import and https://triliumnext.github.io/Docs/Wiki/markdown
• https://triliumnext.github.io/Docs/Wiki/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:

• https://github.com/Nriver/awesome-trilium for 3rd party themes, scripts, plugins and more.
• TriliumRocks! for tutorials, guides, and much more.

❓Why TriliumNext?

The original Trilium developer (https://github.com/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 https://github.com/TriliumNext/Trilium/releases/tag/v0.90.4 are compatible with the latest zadam/trilium version of https://github.com/zadam/trilium/releases/tag/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
• https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge

Until we finish reorganizing the documentation, you may also want to https://triliumnext.github.io/Docs.

💬 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
• https://github.com/TriliumNext/Trilium/discussions (For asynchronous discussions.)
• https://github.com/TriliumNext/Trilium/issues (For bug reports and feature requests.)

🏗 Installation

Windows / MacOS

Download the binary release for your platform from the https://github.com/TriliumNext/Trilium/releases/latest, unzip the package and run the trilium executable.

Linux

If your distribution is listed in the table below, use your distribution's package.

![Packaging status]([***]

You may also download the binary release for your platform from the https://github.com/TriliumNext/Trilium/releases/latest, 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 https://github.com/FliegendeWurst/TriliumDroid. 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 https://hub.docker.com/r/triliumnext/trilium) follow https://triliumnext.github.io/Docs/Wiki/server-installation.

💻 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:

![Translation status]([***]

Code

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

shell
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:

shell
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:

shell
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 https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide.

Developer Documentation

Please view the https://github.com/TriliumNext/Trilium/blob/main/docs/Developer%20Guide/Developer%20Guide/Environment%20Setup.md for details. If you have more questions, feel free to reach out via the links described in the "Discuss with us" section above.

👏 Shoutouts

• https://github.com/ckeditor/ckeditor5 - best WYSIWYG editor on the market, very interactive and listening team
• https://github.com/mar10/fancytree - very feature rich tree library without real competition. Trilium Notes would not be the same without it.
• https://github.com/codemirror/CodeMirror - code editor with support for huge amount of languages
• https://github.com/jsplumb/jsplumb - visual connectivity library without competition. Used in https://triliumnext.github.io/Docs/Wiki/relation-map.html and https://triliumnext.github.io/Docs/Wiki/note-map.html#link-map

🤝 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: https://github.com/***/eliandoran (See the developers for a full list)
• Show a token of gratitude to the original Trilium developer (https://github.com/***/zadam) via *** or *** (:).

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