From 620e53c2557d0c543cd21236fdaad9496003737a Mon Sep 17 00:00:00 2001 From: Elian Doran Date: Mon, 17 Nov 2025 08:19:23 +0200 Subject: [PATCH] docs(user): fix broken reference link (see #7766) --- .../User Guide/Collections/Calendar.html | 6 ++ .../Using Docker.html | 56 ++++++++++--------- docs/Developer Guide/!!!meta.json | 14 ++--- .../Developer Guide/Documentation.md | 2 +- docs/User Guide/!!!meta.json | 7 +++ .../1. Installing the server/Using Docker.md | 2 +- 6 files changed, 52 insertions(+), 35 deletions(-) diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Calendar.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Calendar.html index 160cee491..701aaedb3 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Calendar.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Calendar.html @@ -112,6 +112,12 @@ When present (regardless of value), it will show the number of the week on the calendar. + + #calendar:initialDate + + Change the date the calendar opens on. When not present, the calendar + opens on the current date. + #calendar:view diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Using Docker.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Using Docker.html index a4c7191eb..06829a014 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Using Docker.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Using Docker.html @@ -39,8 +39,8 @@ 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]
    -
  1. Verify the container is running using docker ps.
    2. -
  2. Access Trilium via a web browser at 127.0.0.1:8080.
    3. +
  3. Verify the container is running using docker ps.
    4. +
  4. Access Trilium via a web browser at 127.0.0.1:8080.

Local Network Access

To make the container accessible only on your local network, first create @@ -65,9 +65,9 @@ docker inspect [container_name] is the container's path. More details can be found in the Docker Volumes Documentation.

Reverse Proxy

    -
  1. Nginx +
  2. Nginx
    3. -
  3. Apache +
  4. Apache

Note on --user Directive

@@ -101,10 +101,12 @@ docker pull triliumnext/trilium:rootless-alpine

How It Works

The rootless Trilium image:

    -
  1. Creates a non-root user (trilium) during build time
    2. -
  2. Configures the application to run as this non-root user
    3. -
  3. Allows runtime customization of the user's UID/GID via Docker's --user flag
    4. -
  4. Does not require a separate Docker entrypoint script
    5. +
  5. Creates a non-root user (trilium) during build time
    6. +
  6. Configures the application to run as this non-root user
    7. +
  7. Allows runtime customization of the user's UID/GID via Docker's --user flag
    8. +
  8. Does not require a separate Docker entrypoint script

Usage

Using docker-compose (Recommended)

# Run with default UID/GID (1000:1000)
@@ -127,51 +129,51 @@ docker run -d --name trilium -p 8080:8080 --user $(id -u):$(id -g) -v ~/trilium-

Environment Variables

For a complete list of configuration environment variables (network settings, - authentication, sync, etc.), see Configuration (config.ini or environment variables).

+ authentication, sync, etc.), see Configuration (config.ini or environment variables).

Volume Permissions

If you encounter permission issues with the data volume, ensure that:

    -
  1. The host directory has appropriate permissions for the UID/GID you're +
  2. The host directory has appropriate permissions for the UID/GID you're using
    3. -
  3. You're setting both TRILIUM_UID and TRILIUM_GID to +
  4. You're setting both TRILIUM_UID and TRILIUM_GID to match the owner of the host directory
# For example, if your data directory is owned by UID 1001 and GID 1001:
 TRILIUM_UID=1001 TRILIUM_GID=1001 docker-compose -f docker-compose.rootless.yml up -d

Considerations

Available Rootless Images

Two rootless variants are provided:

    -
  1. Debian-based (default): Uses the Debian Bullseye Slim +
  2. Debian-based (default): Uses the Debian Bullseye Slim base image
      -
    • Dockerfile: apps/server/Dockerfile.rootless +
    • Dockerfile: apps/server/Dockerfile.rootless
      • -
    • Recommended for most users
      • +
    • Recommended for most users
    3. -
  3. Alpine-based: Uses the Alpine base image for smaller +
  4. Alpine-based: Uses the Alpine base image for smaller size
      -
    • Dockerfile: apps/server/Dockerfile.alpine.rootless +
    • Dockerfile: apps/server/Dockerfile.alpine.rootless
      • -
    • Smaller image size, but may have compatibility issues with some systems
      • +
    • Smaller image size, but may have compatibility issues with some systems
@@ -186,7 +188,9 @@ docker build --build-arg USER=myuser --build-arg UID=1001 --build-arg GID=1001 \

Available build arguments:

\ No newline at end of file diff --git a/docs/Developer Guide/!!!meta.json b/docs/Developer Guide/!!!meta.json index 9e479b0cc..4d2ee2157 100644 --- a/docs/Developer Guide/!!!meta.json +++ b/docs/Developer Guide/!!!meta.json @@ -1961,6 +1961,13 @@ "isInheritable": false, "position": 10 }, + { + "type": "relation", + "name": "internalLink", + "value": "lXjOyKpUSKgE", + "isInheritable": false, + "position": 20 + }, { "type": "label", "name": "iconClass", @@ -1974,13 +1981,6 @@ "value": "i18n", "isInheritable": false, "position": 20 - }, - { - "type": "relation", - "name": "internalLink", - "value": "lXjOyKpUSKgE", - "isInheritable": false, - "position": 30 } ], "format": "markdown", diff --git a/docs/Developer Guide/Developer Guide/Documentation.md b/docs/Developer Guide/Developer Guide/Documentation.md index 617684bfd..df9104fa1 100644 --- a/docs/Developer Guide/Developer Guide/Documentation.md +++ b/docs/Developer Guide/Developer Guide/Documentation.md @@ -1,5 +1,5 @@ # Documentation -There are multiple types of documentation for Trilium: +There are multiple types of documentation for Trilium: * The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing F1. * The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers. diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json index 40a40e9fc..3fe30793c 100644 --- a/docs/User Guide/!!!meta.json +++ b/docs/User Guide/!!!meta.json @@ -694,6 +694,13 @@ "value": "bx bxl-docker", "isInheritable": false, "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "Gzjqa934BdH4", + "isInheritable": false, + "position": 50 } ], "format": "markdown", diff --git a/docs/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Using Docker.md b/docs/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Using Docker.md index 87f1a23de..5864a1583 100644 --- a/docs/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Using Docker.md +++ b/docs/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Using Docker.md @@ -187,7 +187,7 @@ docker run -d --name trilium -p 8080:8080 --user $(id -u):$(id -g) -v ~/trilium- * `TRILIUM_GID`: GID to use for the container process (passed to Docker's `--user` flag) * `TRILIUM_DATA_DIR`: Path to the data directory inside the container (default: `/home/node/trilium-data`) -For a complete list of configuration environment variables (network settings, authentication, sync, etc.), see Configuration (config.ini or environment variables). +For a complete list of configuration environment variables (network settings, authentication, sync, etc.), see Configuration (config.ini or environment variables). ### Volume Permissions