mirror of
https://github.com/zadam/trilium.git
synced 2025-10-30 19:19:03 +01:00
39 lines
2.8 KiB
Markdown
Vendored
39 lines
2.8 KiB
Markdown
Vendored
# User Guide
|
||
Trilium is an open-source solution for note-taking and organizing a personal knowledge base. Use it locally on your desktop, or sync it with your self-hosted server to keep your notes everywhere you go.
|
||
|
||
For a quick overview of the application, visit our website at [triliumnotes.org](https://triliumnotes.org/).
|
||
|
||
> [!TIP]
|
||
> The same documentation can be accessed locally from within the Trilium Notes application by pressing <kbd>F1</kbd>.
|
||
|
||
## Documentation
|
||
|
||
This [wiki](https://github.com/zadam/trilium/wiki) contains additional and more in-depth information on some topics. See the sidebar for listing of all available pages.
|
||
|
||
## Quick Start
|
||
|
||
### Choose the setup
|
||
|
||
**Local only desktop/laptop** - Allows a single instance on a desktop and will save the notes locally on that desktop.
|
||
|
||
* <a class="reference-link" href="User%20Guide/Installation%20%26%20Setup/Desktop%20Installation.md">Desktop Installation</a>
|
||
|
||
**Server with web only access** - Installs the application on the server and allows access from any web browser on any device, including mobile.
|
||
|
||
1. <a class="reference-link" href="User%20Guide/Installation%20%26%20Setup/Server%20Installation.md">Server Installation</a>
|
||
2. <a class="reference-link" href="User%20Guide/Installation%20%26%20Setup/Mobile%20Frontend.md">Mobile Frontend</a> (optional)
|
||
3. <a class="reference-link" href="User%20Guide/Installation%20%26%20Setup/Server%20Installation/Third-party%20cloud%20hosting.md">Third-party cloud hosting</a>
|
||
|
||
**Combination of server and desktop/laptop** - Install the application on both a server, for web access and data synchronization, and desktop instance(s). This allows all the data to be stored on the server and either accessed from the web browser, or the desktop application. The desktop application will sync and store the data locally so that it can be used when offline.
|
||
|
||
1. <a class="reference-link" href="/Server installation">[missing note]</a>
|
||
|
||
<a class="reference-link" href="User%20Guide/Installation%20%26%20Setup/Server%20Installation.md">Server Installation</a>
|
||
2. <a class="reference-link" href="User%20Guide/Installation%20%26%20Setup/Mobile%20Frontend.md">Mobile Frontend</a> (optional)
|
||
3. <a class="reference-link" href="User%20Guide/Installation%20%26%20Setup/Desktop%20Installation.md">Desktop Installation</a>
|
||
4. <a class="reference-link" href="User%20Guide/Installation%20%26%20Setup/Synchronization.md">Synchronization</a><a class="reference-link" href="/Synchronization">[missing note]</a>
|
||
|
||
### Basic concepts
|
||
|
||
1. Understand <a class="reference-link" href="User%20Guide/Basic%20Concepts%20and%20Features/Notes.md">Notes</a>.<a class="reference-link" href="/Note">[missing note]</a>
|
||
2. Browse through <a class="reference-link" href="User%20Guide/Note%20Types/Collections.md">Collections</a>.<a class="reference-link" href="/Screenshot tour">[missing note]</a> |