mirror of
				https://github.com/zadam/trilium.git
				synced 2025-10-31 10:26:08 +01:00 
			
		
		
		
	fix(docs): revert references that were full URLs to old Notes repo
This commit is contained in:
		| @@ -17,5 +17,5 @@ Go to `packages/ckeditor5-build-balloon-trilium/build` and copy `ckeditor.js` an | ||||
| An example shell command to copy it: | ||||
|  | ||||
| ``` | ||||
| cp build/ckeditor.* ~/Projects/TriliumNext/Trilium/libraries/ckeditor/ | ||||
| cp build/ckeditor.* ~/Projects/TriliumNext/Notes/libraries/ckeditor/ | ||||
| ``` | ||||
| @@ -20,14 +20,14 @@ If you are installing esbuild with npm, make sure that you don't specify the | ||||
| "--no-optional" or "--omit=optional" flags. The "optionalDependencies" feature | ||||
| of "package.json" is used by esbuild to install the correct binary executable | ||||
| for your current platform. | ||||
|     at generateBinPath (/home/elian/Projects/TriliumNext/Trilium/node_modules/esbuild/lib/main.js:1752:15) | ||||
|     at esbuildCommandAndArgs (/home/elian/Projects/TriliumNext/Trilium/node_modules/esbuild/lib/main.js:1822:33) | ||||
|     at ensureServiceIsRunning (/home/elian/Projects/TriliumNext/Trilium/node_modules/esbuild/lib/main.js:1979:25) | ||||
|     at transform (/home/elian/Projects/TriliumNext/Trilium/node_modules/esbuild/lib/main.js:1880:37) | ||||
|     at file:///home/elian/Projects/TriliumNext/Trilium/node_modules/tsx/dist/index-DlKgSVBb.mjs:16:2755 | ||||
|     at applyTransformers (file:///home/elian/Projects/TriliumNext/Trilium/node_modules/tsx/dist/index-DlKgSVBb.mjs:16:1266) | ||||
|     at transform (file:///home/elian/Projects/TriliumNext/Trilium/node_modules/tsx/dist/index-DlKgSVBb.mjs:16:2702) | ||||
|     at load (file:///home/elian/Projects/TriliumNext/Trilium/node_modules/tsx/dist/esm/index.mjs?1734213798404:2:2245) | ||||
|     at generateBinPath (/home/elian/Projects/TriliumNext/Notes/node_modules/esbuild/lib/main.js:1752:15) | ||||
|     at esbuildCommandAndArgs (/home/elian/Projects/TriliumNext/Notes/node_modules/esbuild/lib/main.js:1822:33) | ||||
|     at ensureServiceIsRunning (/home/elian/Projects/TriliumNext/Notes/node_modules/esbuild/lib/main.js:1979:25) | ||||
|     at transform (/home/elian/Projects/TriliumNext/Notes/node_modules/esbuild/lib/main.js:1880:37) | ||||
|     at file:///home/elian/Projects/TriliumNext/Notes/node_modules/tsx/dist/index-DlKgSVBb.mjs:16:2755 | ||||
|     at applyTransformers (file:///home/elian/Projects/TriliumNext/Notes/node_modules/tsx/dist/index-DlKgSVBb.mjs:16:1266) | ||||
|     at transform (file:///home/elian/Projects/TriliumNext/Notes/node_modules/tsx/dist/index-DlKgSVBb.mjs:16:2702) | ||||
|     at load (file:///home/elian/Projects/TriliumNext/Notes/node_modules/tsx/dist/esm/index.mjs?1734213798404:2:2245) | ||||
|     at async nextLoad (node:internal/modules/esm/hooks:868:22) | ||||
|     at async Hooks.load (node:internal/modules/esm/hooks:451:20) | ||||
| ``` | ||||
|   | ||||
| @@ -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/trilium/](https://hub.docker.com/r/triliumnext/trilium/) | ||||
| 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/) | ||||
|  | ||||
| ## 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/Trilium/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/Notes/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/Trilium/master/docker-compose.yml | ||||
| wget https://raw.githubusercontent.com/TriliumNext/Notes/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/trilium/tags](https://hub.docker.com/r/triliumnext/trilium/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/notes/tags](https://hub.docker.com/r/triliumnext/notes/tags).): | ||||
|  | ||||
| ``` | ||||
| docker pull triliumnext/trilium:v0.91.6 | ||||
| docker pull triliumnext/notes: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/trilium:[VERSION] | ||||
| sudo docker run -t -i -p 127.0.0.1:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/notes:[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/trilium:-latest | ||||
| docker run --net=mynet -d -p 127.0.0.1:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/notes:-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/trilium:-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/notes:-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/trilium:[VERSION] | ||||
| docker run -d -p 0.0.0.0:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/notes:[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/trilium:[VERSION] | ||||
| -v ~/YourOwnDirectory:/home/node/trilium-data triliumnext/notes:[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/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/). | ||||
| 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/). | ||||
|  | ||||
| ## Reverse Proxy | ||||
|  | ||||
| @@ -132,10 +132,10 @@ Below are some commands to pull the rootless images: | ||||
|  | ||||
| ``` | ||||
| # For Debian-based image | ||||
| docker pull triliumnext/trilium:rootless | ||||
| docker pull triliumnext/notes:rootless | ||||
|  | ||||
| # For Alpine-based image | ||||
| docker pull triliumnext/trilium:rootless-alpine | ||||
| docker pull triliumnext/notes: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/trilium:rootless -f apps/server/Dockerfile.rootless . | ||||
| docker build -t triliumnext/notes: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/trilium:rootless | ||||
| docker run -d --name trilium -p 8080:8080 -v ~/trilium-data:/home/trilium/trilium-data triliumnext/notes: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/trilium:rootless | ||||
| docker run -d --name trilium -p 8080:8080 --user $(id -u):$(id -g) -v ~/trilium-data:/home/trilium/trilium-data triliumnext/notes: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/trilium:rootless-custom -f apps/server/Dockerfile.rootless . | ||||
|   -t triliumnext/notes: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/trilium:alpine-rootless-custom -f apps/server/Dockerfile.alpine.rootless . | ||||
|   -t triliumnext/notes:alpine-rootless-custom -f apps/server/Dockerfile.alpine.rootless . | ||||
|  | ||||
| ``` | ||||
|  | ||||
|   | ||||
| @@ -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/Trilium](https://github.com/TriliumNext/Trilium/pull/702) for the original implementation of this feature, including screenshots. | ||||
| 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. | ||||
|  | ||||
| #### On Windows | ||||
|  | ||||
|   | ||||
		Reference in New Issue
	
	Block a user