Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-10-26 15:56:29 +01:00
Code Issues Packages Projects Releases Activity

feat(docs): update doc references from triliumnext/notes to triliumnext/trilium

Browse Source
This commit is contained in:
perf3ct
2025-08-02 23:47:07 +00:00
parent 7a1ec266ad
commit 464c2bdf28
35 changed files with 88 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/User Guide/User Guide/Advanced Usage/Configuration (config.ini or e.md vendored
View File

@@ -1,5 +1,5 @@
# Configuration (config.ini or environment variables)
Trilium supports configuration via a file named `config.ini` and environment variables. Please review the file named [config-sample.ini](https://github.com/TriliumNext/Notes/blob/develop/apps/server/src/assets/config-sample.ini) in the [Notes](https://github.com/TriliumNext/Notes) repository to see what values are supported.
Trilium supports configuration via a file named `config.ini` and environment variables. Please review the file named [config-sample.ini](https://github.com/TriliumNext/Trilium/blob/develop/apps/server/src/assets/config-sample.ini) in the [Notes](https://github.com/TriliumNext/Trilium) repository to see what values are supported.
You can provide the same values via environment variables instead of the `config.ini` file, and these environment variables use the following format:

2
docs/User Guide/User Guide/Advanced Usage/Database/Demo Notes.md vendored
View File

@@ -13,7 +13,7 @@ There are some cases in which you may want to restore the original demo notes. F
You can easily restore the demo notes by using Trilium's built-in import feature by importing them:
* Download [this .zip archive](https://github.com/TriliumNext/Notes/raw/develop/db/demo.zip) with the latest version of the demo notes
* Download [this .zip archive](https://github.com/TriliumNext/Trilium/raw/develop/db/demo.zip) with the latest version of the demo notes
* Right click on any note in your tree under which you would like the demo notes to be imported
* Click "Import into note"
* Select the .zip archive to import it

4
docs/User Guide/User Guide/Advanced Usage/ETAPI (REST API).md vendored
View File

@@ -1,7 +1,7 @@
# ETAPI (REST API)
ETAPI is Trilium's public/external REST API. It is available since Trilium v0.50.
The documentation is in OpenAPI format, available [here](https://github.com/TriliumNext/Notes/blob/master/src/etapi/etapi.openapi.yaml).
The documentation is in OpenAPI format, available [here](https://github.com/TriliumNext/Trilium/blob/master/src/etapi/etapi.openapi.yaml).
## API clients
@@ -11,7 +11,7 @@ As an alternative to calling the API directly, there are client libraries to sim
## Obtaining a token
All operations with the REST API have to be authenticated using a token. You can get this token either from Options -> ETAPI or programmatically using the `/auth/login` REST call (see the [spec](https://github.com/TriliumNext/Notes/blob/master/src/etapi/etapi.openapi.yaml)).
All operations with the REST API have to be authenticated using a token. You can get this token either from Options -> ETAPI or programmatically using the `/auth/login` REST call (see the [spec](https://github.com/TriliumNext/Trilium/blob/master/src/etapi/etapi.openapi.yaml)).
## Authentication

2
docs/User Guide/User Guide/Basic Concepts and Features/Import & Export/Evernote.md vendored
View File

@@ -15,4 +15,4 @@ After importing the ENEX file, go over the imported notes and resources to be su
All resources (except for images) are created as note's attachments.
HTML inside ENEX files is not exactly valid so some formatting maybe broken or lost. You can report major problems into [Trilium issue tracker](https://github.com/TriliumNext/Notes/issues).
HTML inside ENEX files is not exactly valid so some formatting maybe broken or lost. You can report major problems into [Trilium issue tracker](https://github.com/TriliumNext/Trilium/issues).

2
docs/User Guide/User Guide/Basic Concepts and Features/Themes/Theme Gallery.md vendored
View File

@@ -27,4 +27,4 @@ These themes may or may not be compatible with the latest versions of TriliumNex
| [Blue](https://github.com/SiriusXT/trilium-theme-blue) (dark) | [SiriusXT](https://github.com/SiriusXT) |
> [!TIP]
> If you would like to add your theme to this gallery, write a new post in [👐 Show and tell](https://github.com/TriliumNext/Notes/discussions/categories/show-and-tell).
> If you would like to add your theme to this gallery, write a new post in [👐 Show and tell](https://github.com/TriliumNext/Trilium/discussions/categories/show-and-tell).

2
docs/User Guide/User Guide/Installation & Setup/Backup.md vendored
View File

@@ -40,4 +40,4 @@ noBackup=true
You can also review the [configuration](../Advanced%20Usage/Configuration%20\(config.ini%20or%20e.md) file to provide all `config.ini` values as environment variables instead.
See [sample config](https://github.com/TriliumNext/Notes/blob/master/config-sample.ini).
See [sample config](https://github.com/TriliumNext/Trilium/blob/master/config-sample.ini).

2
docs/User Guide/User Guide/Installation & Setup/Desktop Installation.md vendored
View File

@@ -1,7 +1,7 @@
# Desktop Installation
To install Trilium on your desktop, follow these steps:
1. **Download the Latest Release**: Obtain the appropriate binary release for your operating system from the [latest release page](https://github.com/TriliumNext/Notes/releases/latest) on GitHub.
1. **Download the Latest Release**: Obtain the appropriate binary release for your operating system from the [latest release page](https://github.com/TriliumNext/Trilium/releases/latest) on GitHub.
2. **Extract the Package**: Unzip the downloaded package to a location of your choice.
3. **Run the Application**: Launch Trilium by executing the `trilium` executable found within the unzipped folder.

4
docs/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Manually.md vendored
View File

@@ -26,12 +26,12 @@ sudo apt install libpng16-16 libpng-dev pkg-config autoconf libtool build-essent
### Download
You can either download source code zip/tar from [https://github.com/TriliumNext/Notes/releases/latest](https://github.com/TriliumNext/Notes/releases/latest).
You can either download source code zip/tar from [https://github.com/TriliumNext/Trilium/releases/latest](https://github.com/TriliumNext/Trilium/releases/latest).
For the latest version including betas, clone Git repository **from** `main` **branch** with:
```
git clone -b main https://github.com/triliumnext/notes.git
git clone -b main https://github.com/triliumnext/trilium.git
```
## Installation

2
docs/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Packaged version for Linux.md vendored
View File

@@ -4,7 +4,7 @@ This is essentially Trilium sources + node modules + node.js runtime packaged in
## Steps
* SSH into your server
* use `wget` (or `curl`) to download latest `TriliumNotes-Server-[VERSION]-linux-x64.tar.xz` (copy link from [release page](https://github.com/TriliumNext/Notes/releases), notice `-Server` suffix) on your server.
* use `wget` (or `curl`) to download latest `TriliumNotes-Server-[VERSION]-linux-x64.tar.xz` (copy link from [release page](https://github.com/TriliumNext/Trilium/releases), notice `-Server` suffix) on your server.
* unpack the archive, e.g. using `tar -xf -d TriliumNotes-Server-[VERSION]-linux-x64.tar.xz`
* `cd trilium-linux-x64-server`
* `./trilium.sh`

36
docs/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Using Docker.md vendored
View File

@@ -1,5 +1,5 @@
# Using Docker
Official docker images are published on docker hub for **AMD64**, **ARMv7** and **ARM64/v8**: [https://hub.docker.com/r/triliumnext/notes/](https://hub.docker.com/r/triliumnext/notes/)
Official docker images are published on docker hub for **AMD64**, **ARMv7** and **ARM64/v8**: [https://hub.docker.com/r/triliumnext/trilium/](https://hub.docker.com/r/triliumnext/trilium/)
## Prerequisites
@@ -10,14 +10,14 @@ If you need help installing Docker, reference the [Docker Installation Docs](htt
**Note:** Trilium's Docker container requires root privileges to operate correctly.
> [!WARNING]
> If you're using a SMB/CIFS share or folder as your Trilium data directory, [you'll need](https://github.com/TriliumNext/Notes/issues/415#issuecomment-2344824400) to add the mount options of `nobrl` and `noperm` when mounting your SMB share.
> If you're using a SMB/CIFS share or folder as your Trilium data directory, [you'll need](https://github.com/TriliumNext/Trilium/issues/415#issuecomment-2344824400) to add the mount options of `nobrl` and `noperm` when mounting your SMB share.
## Running with Docker Compose
### Grab the latest docker-compose.yml:
```
wget https://raw.githubusercontent.com/TriliumNext/Notes/master/docker-compose.yml
wget https://raw.githubusercontent.com/TriliumNext/Trilium/master/docker-compose.yml
```
Optionally, edit the `docker-compose.yml` file to configure the container settings prior to starting it. Unless configured otherwise, the data directory will be `~/trilium-data` and the container will be accessible at port 8080.
@@ -34,10 +34,10 @@ docker compose up -d
### Pulling the Docker Image
To pull the image, use the following command, replacing `[VERSION]` with the desired version or tag, such as `v0.91.6` or just `latest`. (See published tag names at [https://hub.docker.com/r/triliumnext/notes/tags](https://hub.docker.com/r/triliumnext/notes/tags).):
To pull the image, use the following command, replacing `[VERSION]` with the desired version or tag, such as `v0.91.6` or just `latest`. (See published tag names at [https://hub.docker.com/r/triliumnext/trilium/tags](https://hub.docker.com/r/triliumnext/trilium/tags).):
```
docker pull triliumnext/notes:v0.91.6
docker pull triliumnext/trilium:v0.91.6
```
**Warning:** Avoid using the "latest" tag, as it may automatically upgrade your instance to a new minor version, potentially disrupting sync setups or causing other issues.
@@ -53,7 +53,7 @@ Trilium requires a directory on the host system to store its data. This director
Run the container to make it accessible only from the localhost. This setup is suitable for testing or when using a proxy server like Nginx or Apache.
```
sudo docker run -t -i -p 127.0.0.1:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/notes:[VERSION]
sudo docker run -t -i -p 127.0.0.1:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/trilium:[VERSION]
```
1. Verify the container is running using `docker ps`.
@@ -70,13 +70,13 @@ docker network create -d macvlan -o parent=eth0 --subnet 192.168.2.0/24 --gatewa
Then, run the container with the network settings:
```
docker run --net=mynet -d -p 127.0.0.1:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/notes:-latest
docker run --net=mynet -d -p 127.0.0.1:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/trilium:-latest
```
To set a different user ID (UID) and group ID (GID) for the saved data, use the `USER_UID` and `USER_GID` environment variables:
```
docker run --net=mynet -d -p 127.0.0.1:8080:8080 -e "USER_UID=1001" -e "USER_GID=1001" -v ~/trilium-data:/home/node/trilium-data triliumnext/notes:-latest
docker run --net=mynet -d -p 127.0.0.1:8080:8080 -e "USER_UID=1001" -e "USER_GID=1001" -v ~/trilium-data:/home/node/trilium-data triliumnext/trilium:-latest
```
Find the local IP address using `docker inspect [container_name]` and access the service from devices on the local network.
@@ -91,7 +91,7 @@ docker inspect [container_name]
To allow access from any IP address, run the container as follows:
```
docker run -d -p 0.0.0.0:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/notes:[VERSION]
docker run -d -p 0.0.0.0:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/trilium:[VERSION]
```
Stop the container with `docker stop <CONTAINER ID>`, where the container ID is obtained from `docker ps`.
@@ -101,10 +101,10 @@ Stop the container with `docker stop <CONTAINER ID>`, where the container ID is
For a custom data directory, use:
```
-v ~/YourOwnDirectory:/home/node/trilium-data triliumnext/notes:[VERSION]
-v ~/YourOwnDirectory:/home/node/trilium-data triliumnext/trilium:[VERSION]
```
If you want to run your instance in a non-default way, please use the volume switch as follows: `-v ~/YourOwnDirectory:/home/node/trilium-data triliumnext/notes:<VERSION>`. It is important to be aware of how Docker works for volumes, with the first path being your own and the second the one to virtually bind to. [https://docs.docker.com/storage/volumes/](https://docs.docker.com/storage/volumes/) The path before the colon is the host directory, and the path after the colon is the container's path. More details can be found in the [Docker Volumes Documentation](https://docs.docker.com/storage/volumes/).
If you want to run your instance in a non-default way, please use the volume switch as follows: `-v ~/YourOwnDirectory:/home/node/trilium-data triliumnext/trilium:<VERSION>`. It is important to be aware of how Docker works for volumes, with the first path being your own and the second the one to virtually bind to. [https://docs.docker.com/storage/volumes/](https://docs.docker.com/storage/volumes/) The path before the colon is the host directory, and the path after the colon is the container's path. More details can be found in the [Docker Volumes Documentation](https://docs.docker.com/storage/volumes/).
## Reverse Proxy
@@ -132,10 +132,10 @@ Below are some commands to pull the rootless images:
```
# For Debian-based image
docker pull triliumnext/notes:rootless
docker pull triliumnext/trilium:rootless
# For Alpine-based image
docker pull triliumnext/notes:rootless-alpine
docker pull triliumnext/trilium:rootless-alpine
```
### Why Rootless?
@@ -171,13 +171,13 @@ TRILIUM_DATA_DIR=/path/to/your/data TRILIUM_UID=$(id -u) TRILIUM_GID=$(id -g) do
```
# Build the image
docker build -t triliumnext/notes:rootless -f apps/server/Dockerfile.rootless .
docker build -t triliumnext/trilium:rootless -f apps/server/Dockerfile.rootless .
# Run with default UID/GID (1000:1000)
docker run -d --name trilium -p 8080:8080 -v ~/trilium-data:/home/trilium/trilium-data triliumnext/notes:rootless
docker run -d --name trilium -p 8080:8080 -v ~/trilium-data:/home/trilium/trilium-data triliumnext/trilium:rootless
# Run with custom UID/GID
docker run -d --name trilium -p 8080:8080 --user $(id -u):$(id -g) -v ~/trilium-data:/home/trilium/trilium-data triliumnext/notes:rootless
docker run -d --name trilium -p 8080:8080 --user $(id -u):$(id -g) -v ~/trilium-data:/home/trilium/trilium-data triliumnext/trilium:rootless
```
@@ -224,11 +224,11 @@ If you would prefer, you can also customize the UID/GID at build time:
```
# For Debian-based image with custom UID/GID
docker build --build-arg USER=myuser --build-arg UID=1001 --build-arg GID=1001 \
-t triliumnext/notes:rootless-custom -f apps/server/Dockerfile.rootless .
-t triliumnext/trilium:rootless-custom -f apps/server/Dockerfile.rootless .
# For Alpine-based image with custom UID/GID
docker build --build-arg USER=myuser --build-arg UID=1001 --build-arg GID=1001 \
-t triliumnext/notes:alpine-rootless-custom -f apps/server/Dockerfile.alpine.rootless .
-t triliumnext/trilium:alpine-rootless-custom -f apps/server/Dockerfile.alpine.rootless .
```

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

@@ -4,8 +4,8 @@ I've assumed you have created a DNS A record for `trilium.yourdomain.com` that y
1. Download docker image and create container
```
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]
docker pull triliumnext/trilium:[VERSION]
docker create --name trilium -t -p 127.0.0.1:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/trilium:[VERSION]
```
2. Configure Apache proxy and websocket proxy

2
docs/User Guide/User Guide/Installation & Setup/Upgrading TriliumNext.md vendored
View File

@@ -6,7 +6,7 @@ This document outlines the steps required to upgrade Trilium to a new release ve
Trilium does not support built-in automatic upgrades; all updates must be performed manually. The upgrade process varies depending on the installation method:
* [**Docker Server Installation**](Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md): Pull the new image and restart the container.
* **Other Installations**: Download the latest version from the [release page](https://github.com/TriliumNext/Notes/releases/latest) and replace the existing application files.
* **Other Installations**: Download the latest version from the [release page](https://github.com/TriliumNext/Trilium/releases/latest) and replace the existing application files.
## Database Compatibility and Migration

2
docs/User Guide/User Guide/Theme development/Reference.md vendored
View File

@@ -91,7 +91,7 @@ body.electron:not(.native-titlebar) {
When running under Electron with native title bar off, a feature was introduced to use the platform-specific window buttons such as the semaphore on macOS.
See [Native title bar buttons by eliandoran · Pull Request #702 · TriliumNext/Notes](https://github.com/TriliumNext/Notes/pull/702) for the original implementation of this feature, including screenshots.
See [Native title bar buttons by eliandoran · Pull Request #702 · TriliumNext/Trilium](https://github.com/TriliumNext/Trilium/pull/702) for the original implementation of this feature, including screenshots.
#### On Windows

2
docs/User Guide/User Guide/Troubleshooting.md vendored
View File

@@ -67,5 +67,5 @@ If you continue using the existing document file, change your password (Options
Reporting bugs is highly valuable. Here are some tips:
* Use GitHub issues for reporting: [https://github.com/TriliumNext/Notes/issues](https://github.com/TriliumNext/Notes/issues)
* Use GitHub issues for reporting: [https://github.com/TriliumNext/Trilium/issues](https://github.com/TriliumNext/Trilium/issues)
* Refer to the [error logs](Troubleshooting/Error%20logs.md) page for information on providing necessary details.

2
docs/User Guide/User Guide/Troubleshooting/Error logs.md vendored
View File

@@ -26,7 +26,7 @@ Copy-paste (or screenshot) the logs. It's better to provide not just errors, but
## Providing sensitive data
If you don't feel comfortable attaching the logs or anything sensitive to the public GitHub issues, feel free to contact the devs in our Matrix [support channel](https://github.com/TriliumNext/Notes#-discuss-with-us).
If you don't feel comfortable attaching the logs or anything sensitive to the public GitHub issues, feel free to contact the devs in our Matrix [support channel](https://github.com/TriliumNext/Trilium#-discuss-with-us).
Use this email to also provide anything which could assist in analysing the bug - e.g. files/images/ZIPs being imported or [anonymized database](Anonymized%20Database.md).

2
docs/User Guide/User Guide/Troubleshooting/Reporting issues.md vendored
View File

@@ -1,4 +1,4 @@
# Reporting issues
Go to [Issues · TriliumNext/Notes](https://github.com/TriliumNext/Notes/issues) and press “New issue”.
Go to [Issues · TriliumNext/Trilium](https://github.com/TriliumNext/Trilium/issues) and press “New issue”.
If you are reporting a bug, select “Bug Report” and fill in the details.