|
| 1 | +# Trilium Notes |
| 2 | + |
| 3 | + |
| 4 | +\ |
| 5 | + |
| 6 | +\ |
| 8 | +[](https://app.relative-ci.com/projects/Di5q7dz9daNDZ9UXi0Bp) |
| 9 | +[](https://hosted.weblate.org/engage/trilium/) |
| 11 | + |
| 12 | +[English](./README.md) | [Chinese (Simplified)](./docs/README-ZH_CN.md) | |
| 13 | +[Chinese (Traditional)](./docs/README-ZH_TW.md) | [Russian](./docs/README-ru.md) |
| 14 | +| [Japanese](./docs/README-ja.md) | [Italian](./docs/README-it.md) | |
| 15 | +[Spanish](./docs/README-es.md) |
| 16 | + |
| 17 | +Trilium Notes is a free and open-source, cross-platform hierarchical note taking |
| 18 | +application with focus on building large personal knowledge bases. |
| 19 | + |
| 20 | +See [screenshots](https://triliumnext.github.io/Docs/Wiki/screenshot-tour) for |
| 21 | +quick overview: |
| 22 | + |
| 23 | +<a href="https://triliumnext.github.io/Docs/Wiki/screenshot-tour"><img src="./docs/app.png" alt="Trilium Screenshot" width="1000"></a> |
| 24 | + |
| 25 | +## 📚 Documentation |
| 26 | + |
| 27 | +**Visit our comprehensive documentation at |
| 28 | +[docs.triliumnotes.org](https://docs.triliumnotes.org/)** |
| 29 | + |
| 30 | +Our documentation is available in multiple formats: |
| 31 | +- **Online Documentation**: Browse the full documentation at |
| 32 | + [docs.triliumnotes.org](https://docs.triliumnotes.org/) |
| 33 | +- **In-App Help**: Press `F1` within Trilium to access the same documentation |
| 34 | + directly in the application |
| 35 | +- **GitHub**: Navigate through the [User |
| 36 | + Guide](./docs/User%20Guide/User%20Guide/) in this repository |
| 37 | + |
| 38 | +### Quick Links |
| 39 | +- [Getting Started Guide](https://docs.triliumnotes.org/) |
| 40 | +- [Installation |
| 41 | + Instructions](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation.md) |
| 42 | +- [Docker |
| 43 | + Setup](./docs/User%20Guide/User%20Guide/Installation%20&%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md) |
| 44 | +- [Upgrading |
| 45 | + TriliumNext](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Upgrading%20TriliumNext.md) |
| 46 | +- [Basic Concepts and |
| 47 | + Features](./docs/User%20Guide/User%20Guide/Basic%20Concepts%20and%20Features/Notes.md) |
| 48 | +- [Patterns of Personal Knowledge |
| 49 | + Base](https://triliumnext.github.io/Docs/Wiki/patterns-of-personal-knowledge) |
| 50 | + |
| 51 | +## 🎁 Features |
| 52 | + |
| 53 | +* Notes can be arranged into arbitrarily deep tree. Single note can be placed |
| 54 | + into multiple places in the tree (see |
| 55 | + [cloning](https://triliumnext.github.io/Docs/Wiki/cloning-notes)) |
| 56 | +* Rich WYSIWYG note editor including e.g. tables, images and |
| 57 | + [math](https://triliumnext.github.io/Docs/Wiki/text-notes) with markdown |
| 58 | + [autoformat](https://triliumnext.github.io/Docs/Wiki/text-notes#autoformat) |
| 59 | +* Support for editing [notes with source |
| 60 | + code](https://triliumnext.github.io/Docs/Wiki/code-notes), including syntax |
| 61 | + highlighting |
| 62 | +* Fast and easy [navigation between |
| 63 | + notes](https://triliumnext.github.io/Docs/Wiki/note-navigation), full text |
| 64 | + search and [note |
| 65 | + hoisting](https://triliumnext.github.io/Docs/Wiki/note-hoisting) |
| 66 | +* Seamless [note |
| 67 | + versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions) |
| 68 | +* Note [attributes](https://triliumnext.github.io/Docs/Wiki/attributes) can be |
| 69 | + used for note organization, querying and advanced |
| 70 | + [scripting](https://triliumnext.github.io/Docs/Wiki/scripts) |
| 71 | +* UI available in English, German, Spanish, French, Romanian, and Chinese |
| 72 | + (simplified and traditional) |
| 73 | +* Direct [OpenID and TOTP |
| 74 | + integration](./docs/User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation/Multi-Factor%20Authentication.md) |
| 75 | + for more secure login |
| 76 | +* [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization) |
| 77 | + with self-hosted sync server |
| 78 | + * there's a [3rd party service for hosting synchronisation |
| 79 | + server](https://trilium.cc/paid-hosting) |
| 80 | +* [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes |
| 81 | + to public internet |
| 82 | +* Strong [note |
| 83 | + encryption](https://triliumnext.github.io/Docs/Wiki/protected-notes) with |
| 84 | + per-note granularity |
| 85 | +* Sketching diagrams, based on [Excalidraw](https://excalidraw.com/) (note type |
| 86 | + "canvas") |
| 87 | +* [Relation maps](https://triliumnext.github.io/Docs/Wiki/relation-map) and |
| 88 | + [link maps](https://triliumnext.github.io/Docs/Wiki/link-map) for visualizing |
| 89 | + notes and their relations |
| 90 | +* Mind maps, based on [Mind Elixir](https://docs.mind-elixir.com/) |
| 91 | +* [Geo maps](./docs/User%20Guide/User%20Guide/Note%20Types/Geo%20Map.md) with |
| 92 | + location pins and GPX tracks |
| 93 | +* [Scripting](https://triliumnext.github.io/Docs/Wiki/scripts) - see [Advanced |
| 94 | + showcases](https://triliumnext.github.io/Docs/Wiki/advanced-showcases) |
| 95 | +* [REST API](https://triliumnext.github.io/Docs/Wiki/etapi) for automation |
| 96 | +* Scales well in both usability and performance upwards of 100 000 notes |
| 97 | +* Touch optimized [mobile |
| 98 | + frontend](https://triliumnext.github.io/Docs/Wiki/mobile-frontend) for |
| 99 | + smartphones and tablets |
| 100 | +* Built-in [dark theme](https://triliumnext.github.io/Docs/Wiki/themes), support |
| 101 | + for user themes |
| 102 | +* [Evernote](https://triliumnext.github.io/Docs/Wiki/evernote-import) and |
| 103 | + [Markdown import & export](https://triliumnext.github.io/Docs/Wiki/markdown) |
| 104 | +* [Web Clipper](https://triliumnext.github.io/Docs/Wiki/web-clipper) for easy |
| 105 | + saving of web content |
| 106 | +* Customizable UI (sidebar buttons, user-defined widgets, ...) |
| 107 | +* [Metrics](./docs/User%20Guide/User%20Guide/Advanced%20Usage/Metrics.md), along |
| 108 | + with a [Grafana |
| 109 | + Dashboard](./docs/User%20Guide/User%20Guide/Advanced%20Usage/Metrics/grafana-dashboard.json) |
| 110 | + |
| 111 | +✨ Check out the following third-party resources/communities for more TriliumNext |
| 112 | +related goodies: |
| 113 | + |
| 114 | +- [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party |
| 115 | + themes, scripts, plugins and more. |
| 116 | +- [TriliumRocks!](https://trilium.rocks/) for tutorials, guides, and much more. |
| 117 | + |
| 118 | +## ❓Why TriliumNext? |
| 119 | + |
| 120 | +The original Trilium developer ([Zadam](https://github.com/zadam)) has |
| 121 | +graciously given the Trilium repository to the community project which resides |
| 122 | +at https://github.com/TriliumNext |
| 123 | + |
| 124 | +### ⬆️Migrating from Zadam/Trilium? |
| 125 | + |
| 126 | +There are no special migration steps to migrate from a zadam/Trilium instance to |
| 127 | +a TriliumNext/Trilium instance. Simply [install |
| 128 | +TriliumNext/Trilium](#-installation) as usual and it will use your existing |
| 129 | +database. |
| 130 | + |
| 131 | +Versions up to and including |
| 132 | +[v0.90.4](https://github.com/TriliumNext/Trilium/releases/tag/v0.90.4) are |
| 133 | +compatible with the latest zadam/trilium version of |
| 134 | +[v0.63.7](https://github.com/zadam/trilium/releases/tag/v0.63.7). Any later |
| 135 | +versions of TriliumNext/Trilium have their sync versions incremented which |
| 136 | +prevents direct migration. |
| 137 | + |
| 138 | +## 💬 Discuss with us |
| 139 | + |
| 140 | +Feel free to join our official conversations. We would love to hear what |
| 141 | +features, suggestions, or issues you may have! |
| 142 | + |
| 143 | +- [Matrix](https://matrix.to/#/#triliumnext:matrix.org) (For synchronous |
| 144 | + discussions.) |
| 145 | + - The `General` Matrix room is also bridged to |
| 146 | + [XMPP ](xmpp:[email protected]?join) |
| 147 | +- [Github Discussions](https://github.com/TriliumNext/Trilium/discussions) (For |
| 148 | + asynchronous discussions.) |
| 149 | +- [Github Issues](https://github.com/TriliumNext/Trilium/issues) (For bug |
| 150 | + reports and feature requests.) |
| 151 | + |
| 152 | +## 🏗 Installation |
| 153 | + |
| 154 | +### Windows / MacOS |
| 155 | + |
| 156 | +Download the binary release for your platform from the [latest release |
| 157 | +page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the package |
| 158 | +and run the `trilium` executable. |
| 159 | + |
| 160 | +### Linux |
| 161 | + |
| 162 | +If your distribution is listed in the table below, use your distribution's |
| 163 | +package. |
| 164 | + |
| 165 | +[](https://repology.org/project/triliumnext/versions) |
| 167 | + |
| 168 | +You may also download the binary release for your platform from the [latest |
| 169 | +release page](https://github.com/TriliumNext/Trilium/releases/latest), unzip the |
| 170 | +package and run the `trilium` executable. |
| 171 | + |
| 172 | +TriliumNext is also provided as a Flatpak, but not yet published on FlatHub. |
| 173 | + |
| 174 | +### Browser (any OS) |
| 175 | + |
| 176 | +If you use a server installation (see below), you can directly access the web |
| 177 | +interface (which is almost identical to the desktop app). |
| 178 | + |
| 179 | +Currently only the latest versions of Chrome & Firefox are supported (and |
| 180 | +tested). |
| 181 | + |
| 182 | +### Mobile |
| 183 | + |
| 184 | +To use TriliumNext on a mobile device, you can use a mobile web browser to |
| 185 | +access the mobile interface of a server installation (see below). |
| 186 | + |
| 187 | +See issue https://github.com/TriliumNext/Trilium/issues/4962 for more |
| 188 | +information on mobile app support. |
| 189 | + |
| 190 | +If you prefer a native Android app, you can use |
| 191 | +[TriliumDroid](https://apt.izzysoft.de/fdroid/index/apk/eu.fliegendewurst.triliumdroid). |
| 192 | +Report bugs and missing features at [their |
| 193 | +repository](https://github.com/FliegendeWurst/TriliumDroid). Note: It is best to |
| 194 | +disable automatic updates on your server installation (see below) when using |
| 195 | +TriliumDroid since the sync version must match between Trilium and TriliumDroid. |
| 196 | + |
| 197 | +### Server |
| 198 | + |
| 199 | +To install TriliumNext on your own server (including via Docker from |
| 200 | +[Dockerhub](https://hub.docker.com/r/triliumnext/trilium)) follow [the server |
| 201 | +installation docs](https://triliumnext.github.io/Docs/Wiki/server-installation). |
| 202 | + |
| 203 | + |
| 204 | +## 💻 Contribute |
| 205 | + |
| 206 | +### Translations |
| 207 | + |
| 208 | +If you are a native speaker, help us translate Trilium by heading over to our |
| 209 | +[Weblate page](https://hosted.weblate.org/engage/trilium/). |
| 210 | + |
| 211 | +Here's the language coverage we have so far: |
| 212 | + |
| 213 | +[](https://hosted.weblate.org/engage/trilium/) |
| 215 | + |
| 216 | +### Code |
| 217 | + |
| 218 | +Download the repository, install dependencies using `pnpm` and then run the |
| 219 | +server (available at http://localhost:8080): |
| 220 | +```shell |
| 221 | +git clone https://github.com/TriliumNext/Trilium.git |
| 222 | +cd Trilium |
| 223 | +pnpm install |
| 224 | +pnpm run server:start |
| 225 | +``` |
| 226 | + |
| 227 | +### Documentation |
| 228 | + |
| 229 | +Download the repository, install dependencies using `pnpm` and then run the |
| 230 | +environment required to edit the documentation: |
| 231 | +```shell |
| 232 | +git clone https://github.com/TriliumNext/Trilium.git |
| 233 | +cd Trilium |
| 234 | +pnpm install |
| 235 | +pnpm edit-docs:edit-docs |
| 236 | +``` |
| 237 | + |
| 238 | +### Building the Executable |
| 239 | +Download the repository, install dependencies using `pnpm` and then build the |
| 240 | +desktop app for Windows: |
| 241 | +```shell |
| 242 | +git clone https://github.com/TriliumNext/Trilium.git |
| 243 | +cd Trilium |
| 244 | +pnpm install |
| 245 | +pnpm run --filter desktop electron-forge:make --arch=x64 --platform=win32 |
| 246 | +``` |
| 247 | + |
| 248 | +For more details, see the [development |
| 249 | +docs](https://github.com/TriliumNext/Trilium/tree/main/docs/Developer%20Guide/Developer%20Guide). |
| 250 | + |
| 251 | +### Developer Documentation |
| 252 | + |
| 253 | +Please view the [documentation |
| 254 | +guide](https://github.com/TriliumNext/Trilium/blob/main/docs/Developer%20Guide/Developer%20Guide/Environment%20Setup.md) |
| 255 | +for details. If you have more questions, feel free to reach out via the links |
| 256 | +described in the "Discuss with us" section above. |
| 257 | + |
| 258 | +## 👏 Shoutouts |
| 259 | + |
| 260 | +* [zadam](https://github.com/zadam) for the original concept and implementation |
| 261 | + of the application. |
| 262 | +* [Sarah Hussein](https://github.com/Sarah-Hussein) for designing the |
| 263 | + application icon. |
| 264 | +* [nriver](https://github.com/nriver) for his work on internationalization. |
| 265 | +* [Thomas Frei](https://github.com/thfrei) for his original work on the Canvas. |
| 266 | +* [antoniotejada](https://github.com/nriver) for the original syntax highlight |
| 267 | + widget. |
| 268 | +* [Dosu](https://dosu.dev/) for providing us with the automated responses to |
| 269 | + GitHub issues and discussions. |
| 270 | +* [Tabler Icons](https://tabler.io/icons) for the system tray icons. |
| 271 | + |
| 272 | +Trilium would not be possible without the technologies behind it: |
| 273 | + |
| 274 | +* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - the visual editor behind |
| 275 | + text notes. We are grateful for being offered a set of the premium features. |
| 276 | +* [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with |
| 277 | + support for huge amount of languages. |
| 278 | +* [Excalidraw](https://github.com/excalidraw/excalidraw) - the infinite |
| 279 | + whiteboard used in Canvas notes. |
| 280 | +* [Mind Elixir](https://github.com/SSShooter/mind-elixir-core) - providing the |
| 281 | + mind map functionality. |
| 282 | +* [Leaflet](https://github.com/Leaflet/Leaflet) - for rendering geographical |
| 283 | + maps. |
| 284 | +* [Tabulator](https://github.com/olifolkerd/tabulator) - for the interactive |
| 285 | + table used in collections. |
| 286 | +* [FancyTree](https://github.com/mar10/fancytree) - feature-rich tree library |
| 287 | + without real competition. |
| 288 | +* [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library. |
| 289 | + Used in [relation |
| 290 | + maps](https://triliumnext.github.io/Docs/Wiki/relation-map.html) and [link |
| 291 | + maps](https://triliumnext.github.io/Docs/Wiki/note-map.html#link-map) |
| 292 | + |
| 293 | +## 🤝 Support |
| 294 | + |
| 295 | +Trilium is built and maintained with [hundreds of hours of |
| 296 | +work](https://github.com/TriliumNext/Trilium/graphs/commit-activity). Your |
| 297 | +support keeps it open-source, improves features, and covers costs such as |
| 298 | +hosting. |
| 299 | + |
| 300 | +Consider supporting the main developer |
| 301 | +([eliandoran](https://github.com/eliandoran)) of the application via: |
| 302 | + |
| 303 | +- [GitHub Sponsors](https://github.com/sponsors/eliandoran) |
| 304 | +- [PayPal](https://paypal.me/eliandoran) |
| 305 | +- [Buy Me a Coffee](https://buymeacoffee.com/eliandoran) |
| 306 | + |
| 307 | +## 🔑 License |
| 308 | + |
| 309 | +Copyright 2017-2025 zadam, Elian Doran, and other contributors |
| 310 | + |
| 311 | +This program is free software: you can redistribute it and/or modify it under |
| 312 | +the terms of the GNU Affero General Public License as published by the Free |
| 313 | +Software Foundation, either version 3 of the License, or (at your option) any |
| 314 | +later version. |
0 commit comments