Skip to content

FliegendeWurst/TriliumDroid

Repository files navigation

Trilium Notes for Android test workflow translation status

Unofficial port of TriliumNext Notes to Android.

Features

  • Synchronisation with sync server / desktop app
  • Notes can be arranged into arbitrarily deep tree, where single notes can be placed into multiple places in the tree
  • WYSIWYG note editor based on AztecEditor
  • Fast and easy navigation between notes
  • Automatic note versioning
  • Note attributes and relations for organization, querying and advanced scripting
  • Note encryption with per-note granularity
  • Canvas notes powered by Excalidraw
  • Note map view (context-based / all notes)
  • Scripting API to automate tasks or send notifications
  • In-app user guide based on TriliumNext documentation

More features are planned, see the issue tracker for a full list.

Android integration

  • Note content can be shared to other apps
  • Received shared content is saved as new note
  • Translated UI: English, German, Turkish, Chinese (Simplified Han script)
  • Light/Dark Theme following system preference

Requirements

  • Sync server running TriliumNext/Trilium (any version from 0.93.0 to 0.63.7)
  • Android 7.0+

For using the app without a sync server, follow this issue.
If you're still using Android 6.0 or older, see this issue.
For other ways to use Trilium on mobile, see TriliumNext/Notes#72.

Screenshots

Note tree Free-form diagrams Full-screen navigation Note icon selection Jump-to-note dialog
note tree note tree navigation icons jump
collapsible sub-trees Excalidraw boxicons

Installation

If you already have F-Droid installed, you can add IzzyOnDroid's F-Droid repository in F-Droid's settings. Then install the app like any other.

Or if you prefer to install the app directly:

  1. Download the APK from IzzyOnDroid.
  2. Install the APK. You need to enable installing apps from unknown sources.
  3. Open the app and configure your sync server (hostname, port, password).
  4. Go back, wait until sync is finished.

Several parts of the user interface are configurable, check the app settings for more details. To edit notes, use the edit button in the toolbar.

Contribute

Please report bugs and missing features. Translations are done via Weblate.

If you're any good at Android app development using Kotlin, feel free to contribute code :)

Testing

The app is tested using both unit tests and emulator tests (details).

License

Copyright © 2023 Arne Keller

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.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Parts of this program are derived from zadam's Trilium Notes, the AGPL-3.0 applies.
Parts of this program are derived from Elian Doran's TriliumNext Notes, the AGPL-3.0 applies.
The MIT License applies to the boxicons included in the project (see boxicons_LICENSE.txt).
The GPL-3.0 license applies to the styles derived from Simple-Commons.
The MIT license applies to the bundled excalidraw (see license notices in app/src/main/assets/web.zip).
The GPL-2.0 (or later) license applies to the included CKEditor (app/src/main/assets/ckeditor.js).
For other included libraries, their respective license applies.