Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-11-04 04:16:17 +01:00
Code Issues Packages Projects Releases Activity

chore(docs): sync

Browse Source
This commit is contained in:
Elian Doran
2025-04-11 20:05:22 +03:00
parent 2e4524361b
commit d1b308eced
43 changed files with 862 additions and 967 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/User Guide/User Guide/Advanced Usage/Attributes.md
View File

@@ -6,11 +6,9 @@ In Trilium, attributes are key-value pairs assigned to notes, providing addition
1. <a class="reference-link" href="Attributes/Labels.md">Labels</a> can be used for a variety of purposes, such as storing metadata or configuring the behaviour of notes. Labels are also searchable, enhancing note retrieval.
For more information, including predefined labels, see <a class="reference-link" href="Attributes/Labels.md">Labels</a>.
2. <a class="reference-link" href="Attributes/Relations.md">Relations</a> define connections between notes, similar to links. These can be used for metadata and scripting purposes.
For more information, including a list of predefined relations, see <a class="reference-link" href="Attributes/Relations.md">Relations</a>.
These attributes play a crucial role in organizing, categorising, and enhancing the functionality of notes.

1
docs/User Guide/User Guide/Advanced Usage/Bulk Actions.md
View File

@@ -79,7 +79,6 @@ These actions operate the <a class="reference-link" href="Attributes/Relations.
```javascript
note.title = note.title + " - suffix";
```
* To alter attributes of a note based on another attribute, such as setting the `#shareAlias` label to the title of the note:
```javascript

4
docs/User Guide/User Guide/Advanced Usage/Database/Manually altering the database/SQL Console.md
View File

@@ -8,15 +8,11 @@ It can be accessed by going to the [global menu](../../../Basic%20Concepts%20and
### Interaction
* Hovering the mouse over one of the tables listed at the top of the document will show the columns and their data type.
* Only one SQL statement can be run at once.
* To run the statement, press the ![](3_SQL%20Console_image.png)icon.
* For queries that return a result, the data will displayed in a table.
![](1_SQL%20Console_image.png)
### Saved SQL console

2
docs/User Guide/User Guide/Advanced Usage/Sharing.md
View File

@@ -10,11 +10,9 @@ To use the sharing feature, you must have a <a class="reference-link" href="../
1. **Enable Sharing**: To share a note, toggle the `Shared` switch within the note's interface. Once sharing is enabled, an URL will appear, which you can click to access the shared note.
![Share Note](Sharing_share-single-note.png)
2. **Access the Shared Note**: The link provided will open the note in your browser. If your server is not configured with a public IP, the URL will refer to `localhost (127.0.0.1)`.
![Shared Note Example](Sharing_share-single-note-.png)
## Sharing a Note Subtree

1
docs/User Guide/User Guide/Basic Concepts and Features/Import & Export/OneNote.md
View File

@@ -28,7 +28,6 @@ If exporting all sections at a time, they will not be grouped in folders - they
* If the Onenote header (that is at the top of each Onenote page) is not desired, you can use the following regex to remove them in a text editor like VsCode:
Find (using regex): `.<div.*><h1` Replace with: `<h1`
### Import into Trilium

3
docs/User Guide/User Guide/Basic Concepts and Features/Navigation/Workspaces.md
View File

@@ -4,14 +4,11 @@ Workspace is a concept built up on top of [note hoisting](Note%20Hoisting.md). I
So far workspace consists of these features:
* [note hoisting](Note%20Hoisting.md) - you can "zoom" into a workspace subtree to focus only on the relevant notes
* easy entering of workspace: 
![](1_Workspaces_image.png)
* visual identification of workspace in tabs:
![](Workspaces_image.png)
### Configuration

4
docs/User Guide/User Guide/Basic Concepts and Features/Notes/Read-Only Notes.md
View File

@@ -14,9 +14,9 @@ In addition, it's possible to change the number of characters at which the autom
Via the <a class="reference-link" href="../UI%20Elements/Ribbon.md">Ribbon</a>, by going to the _Basic Properties_ tab and looking for the _Editable_ selection. The following options are possible:
* **Auto**
This is the default behavior in which the note will be editable by default, unless it becomes large enough to trigger read-only mode.  
This is the default behavior in which the note will be editable by default, unless it becomes large enough to trigger read-only mode.
* **Read-only**
The note will be always marked as read-only, regardless of its size. Nevertheless, it's still possible to temporarily edit the note if needed. This is generally useful for notes that are not prone to change.  
The note will be always marked as read-only, regardless of its size. Nevertheless, it's still possible to temporarily edit the note if needed. This is generally useful for notes that are not prone to change.
* **Always Editable**
This option will bypass the automatic read-only activation for this particular note. It's useful for large notes that are frequently edited.

2
docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Launch Bar.md
View File

@@ -57,9 +57,7 @@ Right click either the _Available launchers_ or _Visible launchers_ sections and
3. **Custom Widget**
Allows defining a custom widget to be rendered inside the launcher. See [Widget Basics](../../Scripting/Custom%20Widgets/Widget%20Basics.md) for more information.
4. **Spacers**
Launchers that create some distance between other launchers for better visual distinction.
Launchers are configured via predefined [Promoted Attributes](../../Advanced%20Usage/Attributes/Promoted%20Attributes.md).

7
docs/User Guide/User Guide/Installation & Setup/Server Installation/2. Reverse proxy/Apache.md
View File

@@ -7,7 +7,6 @@ I've assumed you have created a DNS A record for `trilium.yourdomain.com` that y
docker pull triliumnext/notes:[VERSION]
docker create --name trilium -t -p 127.0.0.1:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/notes:[VERSION]
```
2. Configure Apache proxy and websocket proxy
1. Enable apache proxy modules
@@ -18,7 +17,6 @@ I've assumed you have created a DNS A record for `trilium.yourdomain.com` that y
a2enmod proxy_http
a2enmod proxy_wstunnel
```
2. Create a new let's encrypt certificate
```
@@ -26,7 +24,6 @@ I've assumed you have created a DNS A record for `trilium.yourdomain.com` that y
```
Choose standalone (2) and note the location of the created certificates (typically /etc/letsencrypt/live/...)
3. Create a new virtual host file for apache (you may want to use `apachectl -S` to determine the server root location, mine is /etc/apache2)
```
@@ -55,11 +52,8 @@ I've assumed you have created a DNS A record for `trilium.yourdomain.com` that y
Include /etc/letsencrypt/options-ssl-apache.conf
```
4. Enable the virtual host with `sudo a2ensite trilium.yourdomain.com.conf`
5. Reload apache2 with `sudo systemctl reload apache2`
3. Create and enable a systemd service to start the docker container on boot
1. Create a new empty file called `/lib/systemd/system/trilium.service` with the contents
@@ -78,7 +72,6 @@ I've assumed you have created a DNS A record for `trilium.yourdomain.com` that y
[Install]
WantedBy=local.target
```
2. Install, enable and start service
```

2
docs/User Guide/User Guide/Installation & Setup/Server Installation/2. Reverse proxy/Nginx.md
View File

@@ -7,14 +7,12 @@ Configure Nginx proxy and HTTPS. The operating system here is Ubuntu 18.04.
sudo apt-get install nginx
sudo apt-get remove apache2
```
2. Create configure file
```
cd /etc/nginx/conf.d
vim default.conf
```
3. Fill the file with the context shown below, part of the setting show be changed. Then you can enjoy your web with HTTPS forced and proxy.
```

10
docs/User Guide/User Guide/Installation & Setup/Server Installation/Multi-Factor Authentication.md
View File

@@ -20,13 +20,9 @@ TOTP (Time-Based One-Time Password) is a security feature that generates a uniqu
### TOTP
1. Start Trilium Notes normally.
2. Go to "Menu" -> "Options" -> "MFA"
3. Click the "Generate TOTP Secret" button
4. Copy the generated secret to your authentication app/extension
5. Set an environment variable "TOTP\_SECRET" as the generated secret. Environment variables can be set with a .env file in the root directory, by defining them in the command line, or with a docker container.
```
@@ -45,17 +41,11 @@ TOTP (Time-Based One-Time Password) is a security feature that generates a uniqu
# Docker
docker run -p 8080:8080 -v ~/trilium-data:/home/node/trilium-data -e TOTP_ENABLED="true" -e TOTP_SECRET="secret" triliumnext/notes:[VERSION]
```
6. Restart Trilium
7. Go to "Options" -> "MFA"
8. Click the "Generate Recovery Codes" button
9. Save the recovery codes. Recovery codes can be used once in place of the TOTP if you loose access to your authenticator. After a rerecovery code is used, it will show the unix timestamp when it was used in the MFA options tab.
10. Load the secret into an authentication app like google authenticator
### OpenID

1
docs/User Guide/User Guide/Note Types/File.md
View File

@@ -88,5 +88,4 @@ If the file could not be identified as any of the supported file types from abov
<img class="image_resized" style="aspect-ratio:853/315;width:50%;" src="6_File_image.png" width="853" height="315">
* Non-image files can be embedded into text notes as read-only widgets via the <a class="reference-link" href="Text/Include%20Note.md">Include Note</a> functionality.
* Image files can be embedded into text notes like normal images via <a class="reference-link" href="Text/Images/Image%20references.md">Image references</a>.