chore(release): turn into beta

fix(build): add dprint to optional dependencies to support ARMv7 (closes #1556 )
Merge pull request #1569 from TriliumNext/feature/fix_release
2025-03-30 20:51:08 +03:00 · 2025-03-30 18:04:09 +03:00 · 2025-03-30 17:59:48 +03:00 · 2025-03-30 17:43:34 +03:00 · 2025-03-30 17:23:20 +03:00 · 2025-03-30 17:06:59 +03:00
998 changed files with 51007 additions and 121409 deletions
@@ -1,10 +1,44 @@
-.git
-.idea
+# ignored Files
+.dockerignore
+.editorconfig
+.git*
+.prettier*
+electron*
+entitlements.plist
+nodemon.json
+renovate.json
+trilium.iml
+Dockerfile
+Dockerfile.*
+npm-debug.log
+/src/**/*.spec.ts
+
+# ignored folders
+/.cache
+/.git
+/.github
+/.idea
+/.vscode
 /bin
+/build
 /dist
 /docs
-/npm-debug.log
-node_modules
+/dump-db
+/e2e
+/integration-tests
+/spec
+/test
+/test-etapi
+/node_modules

-src/**/*.ts
-!src/services/asset_path.ts
+
+# exceptions
+!/bin/copy-dist.ts
+!/bin/cleanupNodeModules.ts
+
+# temporary exception to make copy-dist inside Docker build not fail
+# TriliumNextTODO: make copy-dist *not* requiring to copy these file for builds other than electron-forge
+!forge.config.cjs
+!/bin/tpl
+!/bin/electron-forge/desktop.ejs
+!/bin/electron-forge/sign-windows.cjs
@@ -0,0 +1,44 @@
+{
+  "typescript": {
+    "indentWidth": 4,
+    "quoteStyle": "preferDouble",
+    "semiColons": "prefer",
+    "quoteProps": "asNeeded",
+    "newLineKind": "lf",
+    "lineWidth": 200,
+    "trailingCommas": "never",
+    "arrayPattern.spaceAround": true,
+    "arrayExpression.spaceAround": true
+  },
+  "json": {
+  },
+  "markdown": {
+  },
+  "dockerfile": {
+  },
+  "malva": {
+  },
+  "markup": {
+  },
+  "yaml": {
+  },
+  "excludes": [
+    "**/node_modules",
+    "**/*-lock.json",
+    "*.html",
+    "*.md",
+    "*.yml",
+    "libraries/*",
+    "docs/*",
+    "src/public/app/doc_notes"
+  ],
+  "plugins": [
+    "https://plugins.dprint.dev/typescript-0.94.0.wasm",
+    "https://plugins.dprint.dev/json-0.20.0.wasm",
+    "https://plugins.dprint.dev/markdown-0.18.0.wasm",
+    "https://plugins.dprint.dev/dockerfile-0.3.2.wasm",
+    "https://plugins.dprint.dev/g-plane/malva-v0.11.1.wasm",
+    "https://plugins.dprint.dev/g-plane/markup_fmt-v0.19.0.wasm",
+    "https://plugins.dprint.dev/g-plane/pretty_yaml-v0.5.0.wasm"
+  ]
+}
@@ -1,3 +1,5 @@
 package-lock.json linguist-generated=true
 **/package-lock.json linguist-generated=true
+src/public/app/doc_notes/en/User[[:space:]]Guide/** linguist-generated=true
+src/public/app/doc_notes/en/User[[:space:]]Guide/**/*.md eol=lf
 libraries/** linguist-vendored
@@ -8,8 +8,11 @@ inputs:
  arch:
    description: "The architecture to build for: x64, arm64"
    required: true
-  extension:
-    description: "Platform specific extensions to copy in the output: dmg, deb, rpm, exe, zip"
+  shell:
+    description: "Which shell to use"
+    required: true
+  forge_platform:
+    description: "The --platform to pass to Electron Forge"
    required: true

 runs:
@@ -38,21 +41,21 @@ runs:

    - name: Verify certificates
      if: inputs.os == 'macos'
-      shell: bash
+      shell: ${{ inputs.shell }}
      run: |
        echo "Available signing identities:"
        security find-identity -v -p codesigning build.keychain

    - name: Set up Python and other macOS dependencies
      if: ${{ inputs.os == 'macos' }}
-      shell: bash
+      shell: ${{ inputs.shell }}
      run: |
        brew install python-setuptools
        brew install create-dmg

    - name: Install dependencies for RPM and Flatpak package building
      if: ${{ inputs.os == 'linux' }}
-      shell: bash
+      shell: ${{ inputs.shell }}
      run: |
        sudo apt-get update && sudo apt-get install rpm flatpak-builder elfutils
        flatpak remote-add --user --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
@@ -62,42 +65,35 @@ runs:

    # Build setup
    - name: Install dependencies
-      shell: bash
+      shell: ${{ inputs.shell }}
      run: npm ci

    - name: Update build info
-      shell: bash
+      shell: ${{ inputs.shell }}
      run: npm run chore:update-build-info

    # Critical debugging configuration
    - name: Run electron-forge build with enhanced logging
-      shell: bash
+      shell: ${{ inputs.shell }}
      env:
        # Pass through required environment variables for signing and notarization
        APPLE_TEAM_ID: ${{ env.APPLE_TEAM_ID }}
        APPLE_ID: ${{ env.APPLE_ID }}
        APPLE_ID_PASSWORD: ${{ env.APPLE_ID_PASSWORD }}
+        WINDOWS_SIGN_EXECUTABLE: ${{ env.WINDOWS_SIGN_EXECUTABLE }}
+        TRILIUM_ARTIFACT_NAME_HINT: TriliumNextNotes-${{ github.ref_name }}-${{ inputs.os }}-${{ inputs.arch }}
      run: |
-        # Map OS names to Electron Forge platform names
-        if [ "${{ inputs.os }}" = "macos" ]; then
-          PLATFORM="darwin"
-        elif [ "${{ inputs.os }}" = "windows" ]; then
-          PLATFORM="win32"
-        else
-          PLATFORM="${{ inputs.os }}"
-        fi
-
        npm run electron-forge:make -- \
          --arch=${{ inputs.arch }} \
-          --platform=$PLATFORM
+          --platform=${{ inputs.forge_platform }}

    # Add DMG signing step
    - name: Sign DMG
      if: inputs.os == 'macos'
-      shell: bash
+      shell: ${{ inputs.shell }}
      run: |
        echo "Signing DMG file..."
-        dmg_file=$(find out -name "*.dmg" -print -quit)
+        dmg_file=$(find ./dist -name "*.dmg" -print -quit)
        if [ -n "$dmg_file" ]; then
          echo "Found DMG: $dmg_file"
          # Get the first valid signing identity from the keychain
@@ -119,13 +115,13 @@ runs:

    - name: Verify code signing
      if: inputs.os == 'macos'
-      shell: bash
+      shell: ${{ inputs.shell }}
      run: |
        echo "Verifying code signing for all artifacts..."

        # First check the .app bundle
        echo "Looking for .app bundle..."
-        app_bundle=$(find out -name "*.app" -print -quit)
+        app_bundle=$(find ./dist -name "*.app" -print -quit)
        if [ -n "$app_bundle" ]; then
          echo "Found app bundle: $app_bundle"
          echo "Verifying app bundle signing..."
@@ -144,7 +140,7 @@ runs:

        # Then check DMG if it exists
        echo "Looking for DMG..."
-        dmg_file=$(find out -name "*.dmg" -print -quit)
+        dmg_file=$(find ./dist -name "*.dmg" -print -quit)
        if [ -n "$dmg_file" ]; then
          echo "Found DMG: $dmg_file"
          echo "Verifying DMG signing..."
@@ -160,54 +156,8 @@ runs:

        # Finally check ZIP if it exists
        echo "Looking for ZIP..."
-        zip_file=$(find out -name "*.zip" -print -quit)
+        zip_file=$(find ./dist -name "*.zip" -print -quit)
        if [ -n "$zip_file" ]; then
          echo "Found ZIP: $zip_file"
          echo "Note: ZIP files are not code signed, but their contents should be"
        fi
-
-    - name: Prepare artifacts
-      shell: bash
-      run: |
-        mkdir -p upload
-
-        if [ "${{ inputs.os }}" = "macos" ]; then
-          # For macOS, we need to look in specific directories based on the maker
-          echo "Collecting macOS artifacts..."
-
-          # Look for DMG files recursively
-          echo "Looking for DMG files..."
-          dmg_file=$(find out -name "*.dmg" -print -quit)
-          if [ -n "$dmg_file" ]; then
-            echo "Found DMG: $dmg_file"
-            cp "$dmg_file" "upload/TriliumNextNotes-${{ github.ref_name }}-macos-${{ inputs.arch }}.dmg"
-          else
-            echo "Warning: No DMG file found"
-          fi
-
-          # Look for ZIP files recursively
-          echo "Looking for ZIP files..."
-          zip_file=$(find out -name "*.zip" -print -quit)
-          if [ -n "$zip_file" ]; then
-            echo "Found ZIP: $zip_file"
-            cp "$zip_file" "upload/TriliumNextNotes-${{ github.ref_name }}-macos-${{ inputs.arch }}.zip"
-          else
-            echo "Warning: No ZIP file found"
-          fi
-        else
-          # For other platforms, use the existing logic but with better error handling
-          echo "Collecting artifacts for ${{ inputs.os }}..."
-          for ext in ${{ inputs.extension }}; do
-            echo "Looking for .$ext files..."
-            file=$(find out -name "*.$ext" -print -quit)
-            if [ -n "$file" ]; then
-              echo "Found $file for extension $ext"
-              cp "$file" "upload/TriliumNextNotes-${{ github.ref_name }}-${{ inputs.os }}-${{ inputs.arch }}.$ext"
-            else
-              echo "Warning: No file found with extension .$ext"
-            fi
-          done
-        fi
-
-        echo "Final contents of upload directory:"
-        ls -la upload/
@@ -11,7 +11,7 @@ runs:
    - name: Set up node & dependencies
      uses: actions/setup-node@v4
      with:
-        node-version: 20
+        node-version: 22
        cache: "npm"
    - name: Install dependencies
      shell: bash
@@ -1,9 +1,9 @@
 name: Dev
 on:
  push:
-    branches-ignore:
-      - 'develop'
-      - 'feature/update**'
+    branches: [ develop ]
+  pull_request:
+    branches: [ develop ]

 concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
@@ -26,7 +26,7 @@ jobs:
      - name: Set up node & dependencies
        uses: actions/setup-node@v4
        with:
-          node-version: 20
+          node-version: 22
          cache: "npm"

      - run: npm ci
@@ -44,16 +44,6 @@ jobs:
      - test_dev
    steps:
      - uses: actions/checkout@v4
-      - name: Set up node & dependencies
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: "npm"
-      - run: npm ci
-      - name: Run the TypeScript build
-        run: npx tsc
-      - name: Create server-package.json
-        run: cat package.json | grep -v electron > server-package.json
      - uses: docker/setup-buildx-action@v3
      - uses: docker/build-push-action@v6
        with:
@@ -82,20 +72,6 @@ jobs:
      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v3

-      - name: Set up node & dependencies
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: "npm"
-
-      - run: npm ci
-
-      - name: Run the TypeScript build
-        run: npx tsc
-
-      - name: Create server-package.json
-        run: cat package.json | grep -v electron > server-package.json
-
      - name: Build and export to Docker
        uses: docker/build-push-action@v6
        with:
@@ -45,7 +45,7 @@ jobs:
      - name: Set up node & dependencies
        uses: actions/setup-node@v4
        with:
-          node-version: 20
+          node-version: 22
          cache: "npm"

      - name: Install npm dependencies
@@ -57,9 +57,6 @@ jobs:
      - name: Run the TypeScript build
        run: npx tsc

-      - name: Create server-package.json
-        run: cat package.json | grep -v electron > server-package.json
-
      - name: Build and export to Docker
        uses: docker/build-push-action@v6
        with:
@@ -154,18 +151,6 @@ jobs:
      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v3

-
-      - name: Set up node & dependencies
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: "npm"
-      - run: npm ci
-      - name: Run the TypeScript build
-        run: npx tsc
-      - name: Create server-package.json
-        run: cat package.json | grep -v electron > server-package.json
-
      - name: Login to GHCR
        uses: docker/login-action@v3
        with:
@@ -1,93 +0,0 @@
-name: Main
-on:
-  push:
-    branches:
-      - "feature/update**"
-      - "feature/server_esm**"
-    paths-ignore:
-      - "docs/**"
-      - ".github/workflows/main-docker.yml"
-  workflow_dispatch:
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  make-electron:
-    name: Make Electron
-    strategy:
-      fail-fast: false
-      matrix:
-        arch: [x64, arm64]
-        os:
-          - name: macos
-            image: macos-latest
-            extension: [dmg, zip]
-          - name: linux
-            image: ubuntu-latest
-            extension: [deb, rpm, zip, flatpak]
-          - name: windows
-            image: windows-latest
-            extension: [exe, zip]
-    runs-on: ${{ matrix.os.image }}
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up node & dependencies
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-      - name: Run the build
-        uses: ./.github/actions/build-electron
-        with:
-          os: ${{ matrix.os.name }}
-          arch: ${{ matrix.arch }}
-          extension: ${{ matrix.os.extension }}
-        env:
-          APPLE_APP_CERTIFICATE_BASE64: ${{ secrets.APPLE_APP_CERTIFICATE_BASE64 }}
-          APPLE_APP_CERTIFICATE_PASSWORD: ${{ secrets.APPLE_APP_CERTIFICATE_PASSWORD }}
-          APPLE_INSTALLER_CERTIFICATE_BASE64: ${{ secrets.APPLE_INSTALLER_CERTIFICATE_BASE64 }}
-          APPLE_INSTALLER_CERTIFICATE_PASSWORD: ${{ secrets.APPLE_INSTALLER_CERTIFICATE_PASSWORD }}
-          APPLE_TEAM_ID: ${{ secrets.APPLE_TEAM_ID }}
-          APPLE_ID: ${{ secrets.APPLE_ID }}
-          APPLE_ID_PASSWORD: ${{ secrets.APPLE_ID_PASSWORD }}
-
-      # Clean up keychain after build
-      - name: Clean up keychain
-        if: matrix.os.name == 'macos' && always()
-        run: |
-          security delete-keychain build.keychain
-
-      - name: Publish artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: TriliumNextNotes ${{ matrix.os.name }} ${{ matrix.arch }}.zip
-          path: upload/*.zip
-      - name: Publish installer artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: TriliumNextNotes ${{ matrix.os.name }} ${{ matrix.arch }}.${{matrix.os.extension}}
-          path: upload/*.${{ matrix.os.extension }}
-
-  build_linux_server:
-    name: Build Linux Server
-    strategy:
-      fail-fast: false
-      matrix:
-        arch: [x64, arm64]
-        include:
-          - arch: x64
-            runs-on: ubuntu-latest
-          - arch: arm64
-            runs-on: ubuntu-24.04-arm
-    runs-on: ${{ matrix.runs-on }}
-    steps:
-      - uses: actions/checkout@v4
-      - name: Run the build
-        uses: ./.github/actions/build-server
-        with:
-          arch: ${{ matrix.arch }}
-      - uses: actions/upload-artifact@v4
-        with:
-          name: TriliumNextNotes linux server ${{ matrix.arch }}
-          path: upload/TriliumNextNotes-linux-${{ matrix.arch }}-${{ github.ref_name }}.tar.xz
@@ -5,6 +5,13 @@ on:
    - cron: "0 2 * * *" # run at 2 AM UTC
  # This can be used to allow manually triggering nightlies from the web interface
  workflow_dispatch:
+  push:
+    branches:
+      - renovate/electron-forge*
+  pull_request:
+    paths:
+      - .github/actions/build-electron/*
+      - forge.config.cjs
 env:
  GITHUB_UPLOAD_URL: https://uploads.github.com/repos/TriliumNext/Notes/releases/179589950/assets{?name,label}
  GITHUB_RELEASE_ID: 179589950
@@ -20,22 +27,24 @@ jobs:
        os:
          - name: macos
            image: macos-latest
-            extension: [dmg, zip]
+            shell: bash
+            forge_platform: darwin
          - name: linux
            image: ubuntu-latest
-            extension: [deb, rpm, zip, flatpak]
+            shell: bash
+            forge_platform: linux
          - name: windows
-            image: windows-latest
-            extension: [exe, zip]
+            image: win-signing
+            shell: cmd
+            forge_platform: win32
    runs-on: ${{ matrix.os.image }}
    steps:
      - uses: actions/checkout@v4
      - name: Set up node & dependencies
        uses: actions/setup-node@v4
        with:
-          node-version: 20
+          node-version: 22
      - name: Install dependencies
-        shell: bash
        run: npm ci
      - name: Update nightly version
        run: npm run chore:ci-update-nightly-version
@@ -44,7 +53,8 @@ jobs:
        with:
          os: ${{ matrix.os.name }}
          arch: ${{ matrix.arch }}
-          extension: ${{ join(matrix.os.extension, ' ') }}
+          shell: ${{ matrix.os.shell }}
+          forge_platform: ${{ matrix.os.forge_platform }}
        env:
          APPLE_APP_CERTIFICATE_BASE64: ${{ secrets.APPLE_APP_CERTIFICATE_BASE64 }}
          APPLE_APP_CERTIFICATE_PASSWORD: ${{ secrets.APPLE_APP_CERTIFICATE_PASSWORD }}
@@ -53,9 +63,11 @@ jobs:
          APPLE_TEAM_ID: ${{ secrets.APPLE_TEAM_ID }}
          APPLE_ID: ${{ secrets.APPLE_ID }}
          APPLE_ID_PASSWORD: ${{ secrets.APPLE_ID_PASSWORD }}
+          WINDOWS_SIGN_EXECUTABLE: ${{ vars.WINDOWS_SIGN_EXECUTABLE }}

      - name: Publish release
        uses: softprops/action-gh-release@v2
+        if: ${{ github.event_name != 'pull_request' }}
        with:
          make_latest: false
          prerelease: true
@@ -65,34 +77,9 @@ jobs:
          tag_name: nightly
          name: Nightly Build

-  nightly-server:
-    name: Deploy server nightly
-    strategy:
-      fail-fast: false
-      matrix:
-        arch: [x64, arm64]
-        include:
-          - arch: x64
-            runs-on: ubuntu-latest
-          - arch: arm64
-            runs-on: ubuntu-24.04-arm
-    runs-on: ${{ matrix.runs-on }}
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Run the build
-        uses: ./.github/actions/build-server
+      - name: Publish artifacts
+        uses: actions/upload-artifact@v4
+        if: ${{ github.event_name == 'pull_request' }}
        with:
-          os: linux
-          arch: ${{ matrix.arch }}
-
-      - name: Publish release
-        uses: softprops/action-gh-release@v2
-        with:
-          make_latest: false
-          prerelease: true
-          draft: false
-          fail_on_unmatched_files: true
-          files: upload/*.*
-          tag_name: nightly
-          name: Nightly Build
+          name: TriliumNextNotes ${{ matrix.os.name }} ${{ matrix.arch }}
+          path: upload
@@ -20,26 +20,30 @@ jobs:
        os:
          - name: macos
            image: macos-latest
-            extension: [dmg, zip]
+            shell: bash
+            forge_platform: darwin
          - name: linux
            image: ubuntu-latest
-            extension: [deb, rpm, zip, flatpak]
+            shell: bash
+            forge_platform: linux
          - name: windows
-            image: windows-latest
-            extension: [exe, zip]
+            image: win-signing
+            shell: cmd
+            forge_platform: win32
    runs-on: ${{ matrix.os.image }}
    steps:
      - uses: actions/checkout@v4
      - name: Set up node & dependencies
        uses: actions/setup-node@v4
        with:
-          node-version: 20
+          node-version: 22
      - name: Run the build
        uses: ./.github/actions/build-electron
        with:
          os: ${{ matrix.os.name }}
          arch: ${{ matrix.arch }}
-          extension: ${{ join(matrix.os.extension, ' ') }}
+          shell: ${{ matrix.os.shell }}
+          forge_platform: ${{ matrix.os.forge_platform }}
        env:
          APPLE_APP_CERTIFICATE_BASE64: ${{ secrets.APPLE_APP_CERTIFICATE_BASE64 }}
          APPLE_APP_CERTIFICATE_PASSWORD: ${{ secrets.APPLE_APP_CERTIFICATE_PASSWORD }}
@@ -48,6 +52,7 @@ jobs:
          APPLE_TEAM_ID: ${{ secrets.APPLE_TEAM_ID }}
          APPLE_ID: ${{ secrets.APPLE_ID }}
          APPLE_ID_PASSWORD: ${{ secrets.APPLE_ID_PASSWORD }}
+          WINDOWS_SIGN_EXECUTABLE: ${{ vars.WINDOWS_SIGN_EXECUTABLE }}

      - name: Publish release
        uses: softprops/action-gh-release@v2
@@ -36,4 +36,10 @@ images/app-icons/mac/*.png
 /playwright-report/
 /blob-report/
 /playwright/.cache/
-/playwright/.auth/
+/playwright/.auth/
+
+data-docs/backup
+data-docs/log
+data-docs/session
+data-docs/session_secret.txt
+data-docs/document.*
@@ -1,6 +0,0 @@
-*.html
-*.md
-*.yml
-libraries/*
-docs/*
-src/public/app/doc_notes/**/*
@@ -1,22 +0,0 @@
-{
-    "printWidth": 200,
-    "tabWidth": 4,
-    "useTabs": false,
-    "semi": true,
-    "singleQuote": false,
-    "quoteProps": "as-needed",
-    "trailingComma": "none",
-    "bracketSpacing": true,
-    "arrowParens": "always",
-    "proseWrap": "preserve",
-    "htmlWhitespaceSensitivity": "css",
-    "endOfLine": "lf",
-    "overrides": [
-        {
-            "files": ["*.json"],
-            "options": {
-                "tabWidth": 2
-            }
-        }
-    ]
-}
@@ -2,6 +2,7 @@
  "recommendations": [
    "lokalise.i18n-ally",
    "editorconfig.editorconfig",
-    "vitest.explorer"
+    "vitest.explorer",
+    "ms-playwright.playwright"
  ]
 }
@@ -1,62 +1,49 @@
 # Build stage
 FROM node:22.14.0-bullseye-slim AS builder

-# Configure build dependencies in a single layer
-RUN apt-get update && apt-get install -y --no-install-recommends \
-    autoconf \
-    automake \
-    g++ \
-    gcc \
-    libtool \
-    make \
-    nasm \
-    libpng-dev \
-    python3 \
-    && rm -rf /var/lib/apt/lists/*
-
-WORKDIR /usr/src/app
+WORKDIR /usr/src/app/build

 # Copy only necessary files for build
 COPY . .
-COPY server-package.json package.json

 # Build and cleanup in a single layer
-RUN cp -R build/src/* src/. && \
-    cp build/docker_healthcheck.js . && \    
-    rm docker_healthcheck.ts && \
-    npm install && \
-    npm run build:webpack && \
-    npm prune --omit=dev && \
+RUN npm ci && \
+    npm run build:prepare-dist && \
    npm cache clean --force && \
-    cp -r src/public/app/doc_notes src/public/app-dist/. && \
-    rm -rf src/public/app/* && \
-    mkdir -p src/public/app/services && \
-    cp -r build/src/public/app/services/mime_type_definitions.js src/public/app/services/mime_type_definitions.js && \
-    rm src/services/asset_path.ts && \
-    rm -r build
+    rm -rf build/node_modules && \
+    mv build/* \
+      start-docker.sh \
+      /usr/src/app/ && \
+    rm -rf \
+      /usr/src/app/build \
+      /tmp/node-compile-cache
+
+#TODO: improve node_modules handling in copy-dist/Dockerfile -> remove duplicated work
+#      currently copy-dist will copy certain node_module folders, but in the Dockerfile we delete them again (to keep image size down),
+#      as we install necessary dependencies in runtime buildstage anyways

 # Runtime stage
 FROM node:22.14.0-bullseye-slim

-# Install only runtime dependencies
-RUN apt-get update && apt-get install -y --no-install-recommends \
-    gosu \
-    && rm -rf /var/lib/apt/lists/* && \
-    rm -rf /var/cache/apt/*
-
 WORKDIR /usr/src/app

-# Copy only necessary files from builder
-COPY --from=builder /usr/src/app/node_modules ./node_modules
-COPY --from=builder /usr/src/app/src ./src
-COPY --from=builder /usr/src/app/db ./db
-COPY --from=builder /usr/src/app/docker_healthcheck.js .
-COPY --from=builder /usr/src/app/start-docker.sh .
-COPY --from=builder /usr/src/app/package.json .
-COPY --from=builder /usr/src/app/config-sample.ini .
-COPY --from=builder /usr/src/app/images ./images
-COPY --from=builder /usr/src/app/translations ./translations
-COPY --from=builder /usr/src/app/libraries ./libraries
+# Install only runtime dependencies
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends \
+      gosu && \
+    rm -rf \
+      /var/lib/apt/lists/* \
+      /var/cache/apt/*
+
+COPY --from=builder /usr/src/app ./
+
+RUN sed -i "/electron/d" package.json && \
+    npm ci --omit=dev && \
+    node --experimental-strip-types ./bin/cleanupNodeModules.ts . --skip-prune-dev-deps && \
+    npm cache clean --force && \
+    rm -rf \
+      /tmp/node-compile-cache \
+      /usr/src/app/bin/cleanupNodeModules.ts

 # Configure container
 EXPOSE 8080
@@ -1,38 +1,26 @@
 # Build stage
 FROM node:22.14.0-alpine AS builder

-# Configure build dependencies
-RUN apk add --no-cache --virtual .build-dependencies \
-    autoconf \
-    automake \
-    g++ \
-    gcc \
-    libtool \
-    make \
-    nasm \
-    libpng-dev \
-    python3
-
-WORKDIR /usr/src/app
+WORKDIR /usr/src/app/build

 # Copy only necessary files for build
 COPY . .
-COPY server-package.json package.json

 # Build and cleanup in a single layer
-RUN cp -R build/src/* src/. && \
-    cp build/docker_healthcheck.js . && \
-    rm docker_healthcheck.ts && \
-    npm install && \
-    npm run build:webpack && \
-    npm prune --omit=dev && \
+RUN npm ci && \
+    npm run build:prepare-dist && \
    npm cache clean --force && \
-    cp -r src/public/app/doc_notes src/public/app-dist/. && \
-    rm -rf src/public/app && \
-    mkdir -p src/public/app/services && \
-    cp -r build/src/public/app/services/mime_type_definitions.js src/public/app/services/mime_type_definitions.js && \
-    rm src/services/asset_path.ts && \
-    rm -r build
+    rm -rf build/node_modules && \
+    mv build/* \
+      start-docker.sh \
+      /usr/src/app/ && \
+    rm -rf \
+      /usr/src/app/build \
+      /tmp/node-compile-cache
+
+#TODO: improve node_modules handling in copy-dist/Dockerfile -> remove duplicated work
+#      currently copy-dist will copy certain node_module folders, but in the Dockerfile we delete them again (to keep image size down),
+#      as we install necessary dependencies in runtime buildstage anyways

 # Runtime stage
 FROM node:22.14.0-alpine
@@ -42,17 +30,15 @@ RUN apk add --no-cache su-exec shadow

 WORKDIR /usr/src/app

-# Copy only necessary files from builder
-COPY --from=builder /usr/src/app/node_modules ./node_modules
-COPY --from=builder /usr/src/app/src ./src
-COPY --from=builder /usr/src/app/db ./db
-COPY --from=builder /usr/src/app/docker_healthcheck.js .
-COPY --from=builder /usr/src/app/start-docker.sh .
-COPY --from=builder /usr/src/app/package.json .
-COPY --from=builder /usr/src/app/config-sample.ini .
-COPY --from=builder /usr/src/app/images ./images
-COPY --from=builder /usr/src/app/translations ./translations
-COPY --from=builder /usr/src/app/libraries ./libraries
+COPY --from=builder /usr/src/app ./
+
+RUN sed -i "/electron/d" package.json && \
+    npm ci --omit=dev && \
+    node --experimental-strip-types ./bin/cleanupNodeModules.ts . --skip-prune-dev-deps && \
+    npm cache clean --force && \
+    rm -rf \
+      /tmp/node-compile-cache \
+      /usr/src/app/bin/cleanupNodeModules.ts

 # Add application user
 RUN adduser -s /bin/false node; exit 0
@@ -37,6 +37,7 @@ Feel free to join our official conversations. We would love to hear what feature
 * Fast and easy [navigation between notes](https://triliumnext.github.io/Docs/Wiki/note-navigation), full text search and [note hoisting](https://triliumnext.github.io/Docs/Wiki/note-hoisting)
 * Seamless [note versioning](https://triliumnext.github.io/Docs/Wiki/note-revisions)
 * Note [attributes](https://triliumnext.github.io/Docs/Wiki/attributes) can be used for note organization, querying and advanced [scripting](https://triliumnext.github.io/Docs/Wiki/scripts)
+* Direct OpenID and TOTP integration for more secure login
 * [Synchronization](https://triliumnext.github.io/Docs/Wiki/synchronization) with self-hosted sync server
  * there's a [3rd party service for hosting synchronisation server](https://trilium.cc/paid-hosting)
 * [Sharing](https://triliumnext.github.io/Docs/Wiki/sharing) (publishing) notes to public internet
@@ -79,10 +80,11 @@ xattr -c "/path/to/Trilium Next.app"

 ### Mobile

-To use TriliumNext on a mobile device:
+To use TriliumNext on a mobile device, you can use a mobile web browser to access the mobile interface of a server installation (see below).

-* Use a mobile web browser to access the mobile interface of a server installation (see below)
-* Use of a mobile app is not yet supported ([see here](https://github.com/TriliumNext/Notes/issues/72)) to track mobile improvements.
+If you prefer a native Android app, you can use [TriliumDroid](https://apt.izzysoft.de/fdroid/index/apk/eu.fliegendewurst.triliumdroid). Report bugs and missing features at [their repository](https://github.com/FliegendeWurst/TriliumDroid).
+
+See issue https://github.com/TriliumNext/Notes/issues/72 for more information on mobile app support.

 ### Server

@@ -107,7 +109,8 @@ npm run server:start

 ### Documentation

-Head on over to our [Docs repo](https://github.com/TriliumNext/Docs)
+We are currently transitioning to a new documentation mechanism.
+Meanwhile you can still view the [archived Docs repository](https://github.com/TriliumNext/Docs).

 ## 👏 Shoutouts

@@ -1,13 +0,0 @@
-#!/usr/bin/env bash
-
-cd src/public
-echo Summary
-cloc HEAD \
-    --git --md \
-    --include-lang=javascript,typescript
-
-echo By file
-cloc HEAD \
-    --git --md \
-    --include-lang=javascript,typescript \
-    --by-file | grep \.js\|
@@ -5,11 +5,6 @@ set -e  # Fail on any command error
 VERSION=`jq -r ".version" package.json`
 SERIES=${VERSION:0:4}-latest

-cat package.json | grep -v electron > server-package.json
-
-echo "Compiling typescript..."
-npx tsc
-
 sudo docker build -t triliumnext/notes:$VERSION --network host -t triliumnext/notes:$SERIES .

 if [[ $VERSION != *"beta"* ]]; then
@@ -21,54 +21,53 @@ fi
 echo "Selected Arch: $ARCH"

 # Set Node.js version and architecture-specific filename
-NODE_VERSION=20.15.1
-NODE_ARCH=$ARCH
+NODE_VERSION=22.14.0

-# Debug output
-echo "Node arch: $NODE_ARCH"
+BUILD_DIR="./build"
+DIST_DIR="./dist"
+CLEANUP_SCRIPT="./bin/cleanupNodeModules.ts"

-# Special case for x64 in Node.js downloads
-if [ "$NODE_ARCH" = "x64" ]; then
-    NODE_FILENAME="x64"
-elif [ "$NODE_ARCH" = "arm64" ]; then
-    NODE_FILENAME="arm64"
-fi

-# Debug output
-echo "Node filename: $NODE_FILENAME"
+# Trigger the build
+echo "Build start"
+npm run build:prepare-dist
+echo "Build finished"

-PKG_DIR=dist/trilium-linux-${ARCH}-server
-echo "Package directory: $PKG_DIR"
+# pruning of unnecessary files and devDeps in node_modules
+node --experimental-strip-types $CLEANUP_SCRIPT $BUILD_DIR

-if [ "$1" != "DONTCOPY" ]
-then
-    # Need to modify copy-trilium.sh to accept the target directory
-    ./bin/copy-trilium.sh "$PKG_DIR"
-fi
+NODE_FILENAME=node-v${NODE_VERSION}-linux-${ARCH}

-cd dist
-wget https://nodejs.org/dist/v${NODE_VERSION}/node-v${NODE_VERSION}-linux-${NODE_FILENAME}.tar.xz
-tar xfJ node-v${NODE_VERSION}-linux-${NODE_FILENAME}.tar.xz
-rm node-v${NODE_VERSION}-linux-${NODE_FILENAME}.tar.xz
+echo "Downloading Node.js runtime $NODE_FILENAME..."
+cd $BUILD_DIR
+wget -qO- https://nodejs.org/dist/v${NODE_VERSION}/${NODE_FILENAME}.tar.xz | tar xfJ -
+mv $NODE_FILENAME node
 cd ..

-mv dist/node-v${NODE_VERSION}-linux-${NODE_FILENAME} $PKG_DIR/node

-rm -r $PKG_DIR/node/lib/node_modules/npm
-rm -r $PKG_DIR/node/include/node
+rm -r $BUILD_DIR/node/lib/node_modules/{npm,corepack} \
+    $BUILD_DIR/node/bin/{npm,npx,corepack} \
+    $BUILD_DIR/node/CHANGELOG.md \
+    $BUILD_DIR/node/include/node \
+    $BUILD_DIR/node_modules/electron* \
+    $BUILD_DIR/electron*.{js,map}

-rm -r $PKG_DIR/node_modules/electron*
-rm -r $PKG_DIR/electron*.js
+printf "#!/bin/sh\n./node/bin/node src/main" > $BUILD_DIR/trilium.sh
+chmod 755 $BUILD_DIR/trilium.sh

-printf "#!/bin/sh\n./node/bin/node src/main" > $PKG_DIR/trilium.sh
-chmod 755 $PKG_DIR/trilium.sh
-
-cp bin/tpl/anonymize-database.sql $PKG_DIR/
-
-cp -r translations $PKG_DIR/
+# TriliumNextTODO: is this still required? If yes → move to copy-dist/copy-trilium
+cp bin/tpl/anonymize-database.sql $BUILD_DIR/

 VERSION=`jq -r ".version" package.json`

-cd dist

-tar cJf trilium-linux-${ARCH}-server-${VERSION}.tar.xz trilium-linux-${ARCH}-server
+ARCHIVE_NAME="TriliumNextNotes-Server-${VERSION}-linux-${ARCH}"
+echo "Creating Archive $ARCHIVE_NAME..."
+
+mkdir $DIST_DIR
+cp -r "$BUILD_DIR" "$DIST_DIR/$ARCHIVE_NAME"
+cd $DIST_DIR
+tar cJf "$ARCHIVE_NAME.tar.xz" "$ARCHIVE_NAME"
+rm -rf "$ARCHIVE_NAME"
+
+echo "Server Build Completed!"
@@ -1,53 +0,0 @@
-#!/usr/bin/env bash
-
-set -e  # Fail on any command error
-
-if ! command -v jq &> /dev/null; then
-  echo "Missing command: jq"
-  exit 1
-fi
-
-if ! command -v fakeroot &> /dev/null; then
-  echo "Missing command: fakeroot"
-  exit 1
-fi
-
-if ! command -v dpkg-deb &> /dev/null; then
-  echo "Missing command: dpkg-deb"
-  exit 1
-fi
-
-if dpkg-deb 2>&1 | grep BusyBox &> /dev/null; then
-  echo "The dpkg-deb binary provided by BusyBox is not compatible. The Debian tool needs to be used instead."
-  exit 1
-fi
-
-if ! command -v wine &> /dev/null; then
-  echo "Missing command: wine"
-  exit 1
-fi
-
-echo "Deleting existing builds"
-
-rm -rf dist/*
-
-SRC_DIR=dist/trilium-src
-
-bin/copy-trilium.sh $SRC_DIR
-
-# we'll just copy the same SRC dir to all the builds so we don't have to do npm install in each separately
-cp -r $SRC_DIR ./dist/trilium-linux-x64-src
-cp -r $SRC_DIR ./dist/trilium-linux-x64-server
-cp -r $SRC_DIR ./dist/trilium-windows-x64-src
-cp -r $SRC_DIR ./dist/trilium-mac-x64-src
-cp -r $SRC_DIR ./dist/trilium-mac-arm64-src
-
-bin/build-win-x64.sh DONTCOPY
-
-bin/build-mac-x64.sh DONTCOPY
-
-bin/build-mac-arm64.sh DONTCOPY
-
-bin/build-linux-x64.sh DONTCOPY
-
-bin/build-server.sh DONTCOPY
@@ -0,0 +1,109 @@
+import fs from "fs-extra";
+import path from "path";
+import type { Dirent } from "fs-extra";
+import { execSync } from "node:child_process";
+
+/**
+ * Example usage with node >= v22:
+ *    node --experimental-strip-types bin/cleanupNodeModules.ts /path/to/build/folder [--skip-prune-dev-deps]
+ * Example usage with tsx:
+ *    tsx bin/cleanupNodeModules.ts /path/to/build/folder [--skip-prune-dev-deps]
+ */
+function main() {
+
+    if (process.argv.length > 4 || process.argv.length < 3) {
+        console.error("Usage: cleanupNodeModules.ts [path-to-build-folder] [--skip-prune-dev-deps]");
+        process.exit(1);
+    }
+
+    const basePath = process.argv[2];
+    const pruneDevDeps = process.argv[3] !== "--skip-prune-dev-deps";
+
+    if (!fs.existsSync(basePath)) {
+        console.error(`Supplied path '${basePath}' does not exist. Aborting.`);
+        process.exit(1);
+    }
+
+    console.log(`Starting pruning of node_modules ${!pruneDevDeps ? '(skipping npm pruning)' : ''} in '${basePath}'...`);
+    cleanupNodeModules(basePath, pruneDevDeps);
+    console.log("Successfully pruned node_modules.");
+}
+
+function cleanupNodeModules(basePath: string, pruneDevDeps: boolean = true) {
+
+    // This needs to run for the server and Docker build,
+    // but needs to be skipped for electron-forge: its
+    // built-in pruning takes care of it already
+    if (pruneDevDeps) {
+        execSync(`npm ci --omit=dev --prefix ${basePath}`);
+    }
+
+    const nodeModulesDirPath = path.join(basePath, "node_modules");
+    const nodeModulesContent = fs.readdirSync(nodeModulesDirPath, { recursive: true, withFileTypes: true });
+    //const libDir = fs.readdirSync(path.join(basePath, "./libraries"), { recursive: true, withFileTypes: true });
+
+    /**
+     * Delete unnecessary folders
+     */
+    const filterableDirs = new Set([
+        "demo",
+        "demos",
+        "doc",
+        "docs",
+        "example",
+        "examples",
+        "test",
+        "tests"
+    ]);
+
+    nodeModulesContent
+        .filter(el => el.isDirectory() && filterableDirs.has(el.name))
+        .forEach(dir => removeDirent(dir));
+
+    /**
+     * Delete unnecessary files based on file extension
+     * TODO filter out useless (README).md files
+     */
+    const filterableFileExt = new Set([
+        "ts",
+        "map"
+    ]);
+
+    nodeModulesContent
+        // TriliumNextTODO: check if we can improve this naive file ext matching, without introducing any additional dependency
+        .filter(el => el.isFile() && filterableFileExt.has(el.name.split(".").at(-1) || ""))
+        .forEach(dir => removeDirent(dir));
+
+
+    /**
+     * Delete specific unnecessary folders
+     * TODO: check if we want removeSync to throw an error, if path does not exist anymore -> currently it will silently fail
+     */
+    const extraFoldersDelete = new Set([
+        path.join(nodeModulesDirPath, ".bin"),
+        path.join(nodeModulesDirPath, "@excalidraw", "excalidraw", "dist", "dev"),
+        path.join(nodeModulesDirPath, "boxicons", "svg"),
+        path.join(nodeModulesDirPath, "boxicons", "node_modules"),
+        path.join(nodeModulesDirPath, "boxicons", "src"),
+        path.join(nodeModulesDirPath, "boxicons", "iconjar"),
+        path.join(nodeModulesDirPath, "@jimp", "plugin-print", "fonts"),
+        path.join(nodeModulesDirPath, "jimp", "dist", "browser") // missing "@" in front of jimp is not a typo here
+    ]);
+
+    nodeModulesContent
+        .filter(el => el.isDirectory() && extraFoldersDelete.has(path.join(el.parentPath, el.name)))
+        .forEach(dir => removeDirent(dir))
+}
+
+
+function removeDirent(el: Dirent) {
+    const elementToDelete = path.join(el.parentPath, el.name);
+    fs.removeSync(elementToDelete);
+
+    if (process.env.VERBOSE) {
+        console.log(`Deleted ${elementToDelete}`);
+    }
+
+}
+
+main()
@@ -1,9 +1,7 @@
 import fs from "fs-extra";
 import path from "path";

-const DEST_DIR = "./dist";
-const DEST_DIR_SRC = path.join(DEST_DIR, "src");
-const DEST_DIR_NODE_MODULES = path.join(DEST_DIR, "node_modules");
+const DEST_DIR = "./build";

 const VERBOSE = process.env.VERBOSE;

@@ -13,43 +11,40 @@ function log(...args: any[]) {
    }
 }

-async function copyNodeModuleFileOrFolder(source: string) {
-    const adjustedSource = source.substring(13);
-    const destination = path.join(DEST_DIR_NODE_MODULES, adjustedSource);
+try {

-    log(`Copying ${source} to ${destination}`);
-    await fs.ensureDir(path.dirname(destination));
-    await fs.copy(source, destination);
-}
-
-const copy = async () => {
-    for (const srcFile of fs.readdirSync("build")) {
-        const destFile = path.join(DEST_DIR, path.basename(srcFile));
-        log(`Copying source ${srcFile} -> ${destFile}.`);
-        fs.copySync(path.join("build", srcFile), destFile, { recursive: true });
-    }
-
-    const filesToCopy = [
-        "config-sample.ini",
-        "tsconfig.webpack.json",
+    const assetsToCopy = new Set([
+        // copy node_module, to avoid downloading packages a 2nd time during pruning
+        "./node_modules",
+        "./images",
+        "./libraries",
+        "./translations",
+        "./db",
+        "./config-sample.ini",
+        "./package-lock.json",
+        "./package.json",
+        "./LICENSE",
+        "./README.md",
+        "./forge.config.cjs",
+        "./bin/tpl/",
+        "./bin/cleanupNodeModules.ts",
+        "./bin/electron-forge/desktop.ejs",
+        "./bin/electron-forge/sign-windows.cjs",
+        "./src/views/",
        "./src/etapi/etapi.openapi.yaml",
-        "./src/routes/api/openapi.json"
-    ];
-    for (const file of filesToCopy) {
-        log(`Copying ${file}`);
-        await fs.copy(file, path.join(DEST_DIR, file));
-    }
+        "./src/routes/api/openapi.json",
+        "./src/public/icon.png",
+        "./src/public/manifest.webmanifest",
+        "./src/public/robots.txt",
+        "./src/public/fonts",
+        "./src/public/stylesheets",
+        "./src/public/translations",
+        "./packages/turndown-plugin-gfm/src"
+    ]);

-    const dirsToCopy = ["images", "libraries", "translations", "db"];
-    for (const dir of dirsToCopy) {
-        log(`Copying ${dir}`);
-        await fs.copy(dir, path.join(DEST_DIR, dir));
-    }
-
-    const srcDirsToCopy = ["./src/public", "./src/views", "./build"];
-    for (const dir of srcDirsToCopy) {
-        log(`Copying ${dir}`);
-        await fs.copy(dir, path.join(DEST_DIR_SRC, path.basename(dir)));
+    for (const asset of assetsToCopy) {
+        log(`Copying ${asset}`);
+        fs.copySync(asset, path.join(DEST_DIR, asset));
    }

    /**
@@ -58,59 +53,13 @@ const copy = async () => {
    const publicDirsToCopy = ["./src/public/app/doc_notes"];
    const PUBLIC_DIR = path.join(DEST_DIR, "src", "public", "app-dist");
    for (const dir of publicDirsToCopy) {
-        await fs.copy(dir, path.join(PUBLIC_DIR, path.basename(dir)));
+        fs.copySync(dir, path.join(PUBLIC_DIR, path.basename(dir)));
    }

-    const nodeModulesFile = [
-        "node_modules/react/umd/react.production.min.js",
-        "node_modules/react/umd/react.development.js",
-        "node_modules/react-dom/umd/react-dom.production.min.js",
-        "node_modules/react-dom/umd/react-dom.development.js",
-        "node_modules/katex/dist/katex.min.js",
-        "node_modules/katex/dist/contrib/mhchem.min.js",
-        "node_modules/katex/dist/contrib/auto-render.min.js",
-        "node_modules/@highlightjs/cdn-assets/highlight.min.js",
-        "node_modules/@mind-elixir/node-menu/dist/node-menu.umd.cjs"
-    ];
+    console.log("Copying complete!")

-    for (const file of nodeModulesFile) {
-        await copyNodeModuleFileOrFolder(file);
-    }
+} catch(err) {
+    console.error("Error during copy:", err)
+    process.exit(1)
+}

-    const nodeModulesFolder = [
-        "node_modules/@excalidraw/excalidraw/dist/",
-        "node_modules/katex/dist/",
-        "node_modules/dayjs/",
-        "node_modules/boxicons/css/",
-        "node_modules/boxicons/fonts/",
-        "node_modules/mermaid/dist/",
-        "node_modules/jquery/dist/",
-        "node_modules/jquery-hotkeys/",
-        "node_modules/split.js/dist/",
-        "node_modules/panzoom/dist/",
-        "node_modules/i18next/",
-        "node_modules/i18next-http-backend/",
-        "node_modules/jsplumb/dist/",
-        "node_modules/vanilla-js-wheel-zoom/dist/",
-        "node_modules/mark.js/dist/",
-        "node_modules/normalize.css/",
-        "node_modules/jquery.fancytree/dist/",
-        "node_modules/autocomplete.js/dist/",
-        "node_modules/codemirror/lib/",
-        "node_modules/codemirror/addon/",
-        "node_modules/codemirror/mode/",
-        "node_modules/codemirror/keymap/",
-        "node_modules/mind-elixir/dist/",
-        "node_modules/@highlightjs/cdn-assets/languages",
-        "node_modules/@highlightjs/cdn-assets/styles",
-        "node_modules/leaflet/dist"
-    ];
-
-    for (const folder of nodeModulesFolder) {
-        await copyNodeModuleFileOrFolder(folder);
-    }
-};
-
-copy()
-    .then(() => console.log("Copying complete!"))
-    .catch((err) => console.error("Error during copy:", err));
@@ -1,74 +0,0 @@
-#!/usr/bin/env bash
-
-set -e  # Fail on any command error
-shopt -s globstar
-
-if [[ $# -eq 0 ]] ; then
-    echo "Missing argument of target directory"
-    exit 1
-fi
-if ! [[ $(which npm) ]]; then
-    echo "Missing npm"
-    exit 1
-fi
-
-# Trigger the TypeScript build
-echo TypeScript build start
-npx tsc
-echo TypeScript build finished
-
-# Copy the TypeScript artifacts
-DIR="$1"
-rm -rf "$DIR"
-mkdir -pv "$DIR"
-
-echo Webpack start
-npm run build:webpack
-echo Webpack finish
-
-echo "Copying Trilium to build directory $DIR"
-
-for d in 'images' 'libraries' 'src' 'db'; do
-    cp -r "$d" "$DIR"/
-done
-
-for f in 'package.json' 'package-lock.json' 'README.md' 'LICENSE' 'config-sample.ini'; do
-    cp "$f" "$DIR"/
-done
-
-# Patch package.json main
-sed -i 's/.\/dist\/electron-main.js/electron-main.js/g' "$DIR/package.json"
-
-script_dir=$(realpath $(dirname $0))
-cp -R "$script_dir/../build/src" "$DIR"
-cp "$script_dir/../build/electron-main.js" "$DIR"
-
-# run in subshell (so we return to original dir)
-(cd $DIR && npm install --omit=dev --legacy-peer-deps)
-
-if [[ -d "$DIR"/node_modules ]]; then
-    # cleanup of useless files in dependencies
-    for d in 'image-q/demo' \
-        '@excalidraw/excalidraw/dist/excalidraw-assets-dev' '@excalidraw/excalidraw/dist/excalidraw.development.js' '@excalidraw/excalidraw/dist/excalidraw-with-preact.development.js' \
-        'mermaid/dist/mermaid.js' \
-        'boxicons/svg' 'boxicons/node_modules/react'/* \
-        '@jimp/plugin-print/fonts' 'jimp/browser' 'jimp/fonts'; do
-        [[ -e "$DIR"/node_modules/"$d" ]] && rm -r "$DIR"/node_modules/"$d"
-    done
-
-    # delete all tests (there are often large images as test file for jimp etc.)
-    for d in 'test' 'docs' 'demo' 'example'; do
-        find "$DIR"/node_modules -name "$d" -exec rm -rf {} +
-    done
-fi
-
-find $DIR/libraries -name "*.map" -type f -delete
-find $DIR/node_modules -name "*.map" -type f -delete
-find $DIR -name "*.ts" -type f -delete
-
-d="$DIR"/src/public
-[[ -d "$d"/app-dist ]] || mkdir -pv "$d"/app-dist
-cp -r "$d"/app/doc_notes "$d"/app-dist/
-
-rm -rf "$d"/app
-unset f d DIR
@@ -0,0 +1,14 @@
+const child_process = require("child_process");
+
+module.exports = function (filePath) {
+    const { WINDOWS_SIGN_EXECUTABLE } = process.env;
+
+    if (!WINDOWS_SIGN_EXECUTABLE) {
+        console.warn("[Sign] Skip signing due to missing environment variable.");
+        return;
+    }
+
+    const command = `${WINDOWS_SIGN_EXECUTABLE} --executable "${filePath}"`;
+    console.log(`[Sign] ${command}`);
+    child_process.execSync(command);
+}
@@ -16,7 +16,7 @@ chcp 65001
 :: Get Current Trilium executable directory and compute data directory
 SET DIR=%~dp0
 set NODE_TLS_REJECT_UNAUTHORIZED=0
-cd %DIR%
+cd "%DIR%"
 start trilium.exe
 GOTO END

@@ -15,8 +15,9 @@ chcp 65001

 :: Get Current Trilium executable directory and compute data directory
 SET DIR=%~dp0
+SET DIR=%DIR:~0,-1%
 SET TRILIUM_DATA_DIR=%DIR%\trilium-data
-cd %DIR%
+cd "%DIR%"
 start trilium.exe
 GOTO END

@@ -16,7 +16,7 @@ chcp 65001
 :: Get Current Trilium executable directory and compute data directory
 SET DIR=%~dp0
 SET TRILIUM_SAFE_MODE=1
-cd %DIR%
+cd "%DIR%"
 start trilium.exe --disable-gpu
 GOTO END

@@ -8,9 +8,6 @@ noAuthentication=false
 # set to true to disable backups (e.g. because of limited space on server)
 noBackup=false

-# Disable automatically generating desktop icon
-# noDesktopIcon=true
-
 [Network]
 # host setting is relevant only for web deployments - set the host on which the server will listen
 # host=0.0.0.0
@@ -46,4 +43,17 @@ cookieMaxAge=1814400
 [Sync]
 #syncServerHost=
 #syncServerTimeout=
-#syncServerProxy=
+#syncServerProxy=
+
+[MultiFactorAuthentication]
+# Set the base URL for OAuth/OpenID authentication
+# This is the URL of the service that will be used to verify the user's identity
+oauthBaseUrl=
+
+# Set the client ID for OAuth/OpenID authentication
+# This is the ID of the client that will be used to verify the user's identity
+oauthClientId=
+
+# Set the client secret for OAuth/OpenID authentication
+# This is the secret of the client that will be used to verify the user's identity
+oauthClientSecret=
@@ -0,0 +1,49 @@
+[General]
+# Instance name can be used to distinguish between different instances using backend api.getInstanceName()
+instanceName=
+
+# set to true to allow using Trilium without authentication (makes sense for server build only, desktop build doesn't need password)
+noAuthentication=false
+
+# set to true to disable backups (e.g. because of limited space on server)
+noBackup=false
+
+# Disable automatically generating desktop icon
+# noDesktopIcon=true
+
+[Network]
+# host setting is relevant only for web deployments - set the host on which the server will listen
+# host=0.0.0.0
+# port setting is relevant only for web deployments, desktop builds run on a fixed port (changeable with TRILIUM_PORT environment variable)
+port=8080
+# true for TLS/SSL/HTTPS (secure), false for HTTP (insecure).
+https=false
+# path to certificate (run "bash bin/generate-cert.sh" to generate self-signed certificate). Relevant only if https=true
+certPath=
+keyPath=
+# setting to give trust to reverse proxies, a comma-separated list of trusted rev. proxy IPs can be specified (CIDR notation is permitted),
+# alternatively 'true' will make use of the leftmost IP in X-Forwarded-For, ultimately an integer can be used to tell about the number of hops between
+# Trilium (which is hop 0) and the first trusted rev. proxy. 
+# once set, expressjs will use the X-Forwarded-For header set by the rev. proxy to determinate the real IPs of clients.
+# expressjs shortcuts are supported: loopback(127.0.0.1/8, ::1/128), linklocal(169.254.0.0/16, fe80::/10), uniquelocal(10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, fc00::/7)
+trustedReverseProxy=false
+
+
+[Session]
+# Use this setting to set a custom value for the "Path" Attribute value of the session cookie.
+# This can be useful, when you have several instances running on the same domain, under different paths (e.g. by using a reverse proxy).
+# It prevents your instances from overwriting each others' cookies, allowing you to stay logged in multiple instances simultanteously.
+# E.g. if you have instances running under https://your-domain.com/triliumNext/instanceA and https://your-domain.com/triliumNext/instanceB
+# you would want to set the cookiePath value to "/triliumNext/instanceA" for your first and "/triliumNext/instanceB" for your second instance
+cookiePath=/
+
+# Use this setting to set a custom value for the "Max-Age" Attribute of the session cookie.
+# This controls how long your session will be valid, before it expires and you need to log in again, when you use the "Remember Me" option.
+# Value needs to be entered in Seconds.
+# Default value is 1814400 Seconds, which is 21 Days.
+cookieMaxAge=1814400
+
+[Sync]
+#syncServerHost=
+#syncServerTimeout=
+#syncServerProxy=
@@ -0,0 +1,14 @@
+-- Add the oauth user data table
+CREATE TABLE IF NOT EXISTS "user_data"
+(
+    tmpID INT,
+    username TEXT,
+    email TEXT,
+    userIDEncryptedDataKey TEXT,
+    userIDVerificationHash TEXT,
+    salt TEXT,
+    derivedKey TEXT,
+    isSetup TEXT DEFAULT "false",
+    UNIQUE (tmpID),
+    PRIMARY KEY (tmpID)
+);
@@ -126,6 +126,19 @@ CREATE TABLE IF NOT EXISTS "attachments"
    utcDateScheduledForErasureSince TEXT DEFAULT NULL,
    isDeleted    INT  not null,
    deleteId    TEXT DEFAULT NULL);
+CREATE TABLE IF NOT EXISTS "user_data"
+(
+    tmpID INT,
+    username TEXT,
+    email TEXT,
+    userIDEncryptedDataKey TEXT,
+    userIDVerificationHash TEXT,
+    salt TEXT,
+    derivedKey TEXT,
+    isSetup TEXT DEFAULT "false",
+    UNIQUE (tmpID),
+    PRIMARY KEY (tmpID)
+);
 CREATE INDEX IDX_attachments_ownerId_role
    on attachments (ownerId, role);

@@ -0,0 +1,2 @@
+# User Guide
+The sub-children of this note are automatically synced.
@@ -0,0 +1,9 @@
+# Advanced Showcases
+Trilium offers advanced functionality through [Scripts](../Note%20Types/Code/Scripts.md) and [Promoted Attributes](Attributes/Promoted%20Attributes.md). To illustrate these features, we've prepared several showcases available in the [demo notes](Database.md):
+
+*   [Relation Map](../Note%20Types/Relation%20Map.md)
+*   [Day Notes](Advanced%20Showcases/Day%20Notes.md)
+*   [Weight Tracker](Advanced%20Showcases/Weight%20Tracker.md)
+*   [Task Manager](Advanced%20Showcases/Task%20Manager.md)
+
+It's important to note that these examples are not natively supported by Trilium out of the box; instead, they demonstrate what you can build within Trilium.
@@ -0,0 +1,60 @@
+# Day Notes
+A common pattern in note-taking is that a lot of notes will be centered around a certain date - e.g. you have some tasks which needs to be done on a certain date, you have meeting minutes from a certain date, you have your thoughts etc. and it all revolves around a date on which they occurred. For this reason, it makes sense to create a certain "day workspace" which will centralize all those notes relevant for a certain date.
+
+For this, Trilium provides a concept of "day note". Trilium semi-automatically generates a single note for each day. Under this note you can save all those relevant notes.
+
+Select an existing day note, and the menubar contains a calendar widget. Select any day to create a note for that day. 
+
+![](1_Day%20Notes_image.png)
+
+This pattern works well also because of [Cloning Notes](../../Basic%20Concepts%20and%20Features/Notes/Cloning%20Notes.md) functionality - note can appear in multiple places in the note tree, so besides appearing under day note, it can also be categorized into other notes.
+
+## Demo
+
+![](Day%20Notes_image.png)
+
+You can see the structure of day notes appearing under "Journal" note - there's a note for the whole year 2017, under it, you have "12 - December" which then contains "18 - Monday". This is our "day note" which contains some text in its content and also has some child notes (some of them are from [Task manager](Task%20Manager.md)).
+
+You can also notice how this day note has [promoted attribute](../Attributes/Promoted%20Attributes.md) "weight" where you can track your daily weight. This data is then used in [Weight tracker](Weight%20Tracker.md).
+
+## Templates
+
+Trilium provides [template](../Attributes/Template.md) functionality, and it could be used together with day notes.
+
+You can define one of the following relations on the root of the journal (identified by `#calendarRoot` label):
+
+*   yearTemplate
+*   monthTemplate
+*   dateTemplate
+
+All of these are relations. When Trilium creates a new note for year or month or date, it will take a look at the root and attach a corresponding `~template` relation to the newly created role. Using this, you can e.g. create your daily template with e.g. checkboxes for daily routine etc.
+
+## Date pattern
+
+It's possible to customize the title of generated date notes by defining a `#datePattern` label on a root calendar note (identified by `#calendarRoot` label). Following are possible values:
+
+*   `{dayInMonthPadded} - {weekDay}` day notes are named e.g. "24 - Monday"
+*   `{dayInMonthPadded}: {weekDay3}` day notes are named e.g. "24: Mon"
+*   `{dayInMonthPadded}: {weekDay2}` day notes are named e.g. "24: Mo"
+*   `{isoDate} - {weekDay}` day notes are named e.g. "2020-12-24 - Monday"
+*   `{ordinal}` is replaced with the ordinal date (e.g. 1st, 2nd, 3rd) etc.
+
+## Month pattern
+
+It is also possible to customize the title of generated month notes through the `#monthPattern` attribute, much like `#datePattern`. The options are:
+
+*   `{isoMonth}` results in an ISO 8061 formatted month (e.g. "2025-03" for March 2025)
+*   `{monthNumberPadded}` results in a number like `09` for September, and `11` for November
+*   `{month}` results in the full month name (e.g. `September` or `October`)
+*   `{shortMonth3}` is replaced with the first 3 letters of the month, e.g. Jan, Feb, etc.
+*   `{shortMonth4}` is replaced with the first 4 letters of the month, e.g. Sept, Octo, etc.
+
+The default is `{monthNumberPadded} - {month}`
+
+## Implementation
+
+Trilium has some special support for day notes in the form of [backend Script API](https://triliumnext.github.io/Notes/backend_api/BackendScriptApi.html) - see e.g. getDayNote() function.
+
+Day (and year, month) notes are created with a label - e.g. `#dateNote="2018-08-16"` this can then be used by other scripts to add new notes to day note etc.
+
+Journal also has relation `child:child:child:template=Day template` (see \[\[attribute inheritance\]\]) which effectively adds \[\[template\]\] to day notes (grand-grand-grand children of Journal).
@@ -0,0 +1,63 @@
+# Task Manager
+Task Manager is a [promoted attributes](../Attributes/Promoted%20Attributes.md) and [scripts](../../Note%20Types/Code/Scripts.md)showcase present in the [demo notes](../Database.md).
+
+## Demo
+
+![](../../Attachments/task-manager.png)
+
+Task Manager manages outstanding (TODO) tasks and finished tasks (non-empty doneDate attribute). Outstanding tasks are further categorized by location and arbitrary tags - whenever you change tag attribute in the task note, this task is then automatically moved to appropriate location.
+
+Task Manager also integrates with [day notes](Day%20Notes.md) - notes are [cloned](../../Basic%20Concepts%20and%20Features/Notes/Cloning%20Notes.md) into day note to both todoDate note and doneDate note (with [prefix](../../Basic%20Concepts%20and%20Features/Navigation/Tree%20Concepts.md) of either "TODO" or "DONE").
+
+## Implementation
+
+New tasks are created in the TODO note which has `~child:template` [relation](../Attributes.md)(see [attribute inheritance](../Attributes/Attribute%20Inheritance.md)) pointing to the task template.
+
+### Attributes
+
+Task template defines several [promoted attributes](../Attributes/Promoted%20Attributes.md) - todoDate, doneDate, tags, location. Importantly it also defines `~runOnAttributeChange` relation - [event](../../Note%20Types/Code/Events.md) handler which is run on attribute change. This [script](../../Note%20Types/Code/Scripts.md) handles when e.g. we fill out the doneDate attribute - meaning the task is done and should be moved to "Done" note and removed from TODO, locations and tags.
+
+### New task button
+
+There's also "button" note which contains simple script which adds a button to create new note (task) in the TODO note.
+
+```
+api.addButtonToToolbar({
+    title: 'New task',
+    icon: 'check',
+    shortcut: 'alt+n',
+    action: async () => {
+        // creating notes is backend (server) responsibility so we need to pass
+        // the control there
+        const taskNoteId = await api.runOnBackend(async () => {
+            const todoRootNote = await api.getNoteWithLabel('taskTodoRoot');
+            const {note} = await api.createNote(todoRootNote.noteId, 'new task', '');
+
+            return note.noteId;
+        });
+
+        // we got an ID of newly created note and we want to immediatelly display it
+        await api.activateNewNote(taskNoteId);
+    }
+});
+```
+
+### CSS
+
+In the demo screenshot above you may notice that TODO tasks are in red color and DONE tasks are green.
+
+This is done by having this CSS [code note](../../Note%20Types/Code.md) which defines extra CSS classes:
+
+```
+span.fancytree-node.todo .fancytree-title {
+    color: red !important;
+}
+
+span.fancytree-node.done .fancytree-title {
+    color: green !important;
+}
+```
+
+This [code note](../../Note%20Types/Code.md) has `#appCss` [label](../Attributes.md)which is recognized by Trilium on startup and loaded as CSS into the application.
+
+Second part of this functionality is based in event handler described above which assigns `#cssClass` label to the task to either "done" or "todo" based on the task status.
@@ -0,0 +1,70 @@
+# Weight Tracker
+![](Weight%20Tracker_image.png)
+
+The `Weight Tracker` is a [Script API](../../Note%20Types/Code/Script%20API.md) showcase present in the [demo notes](../Database.md).
+
+By adding `weight` as a [promoted attribute](../Attributes/Promoted%20Attributes.md) in the [template](../Attributes/Template.md) from which [day notes](Day%20Notes.md) are created, you can aggregate the data and plot weight change over time.
+
+## Implementation
+
+The `Weight Tracker` note in the screenshot above is of the type `Render Note`. That type of note doesn't have any useful content itself. Instead it is a placeholder where a [script](../../Note%20Types/Code/Scripts.md) can render its output.
+
+Scripts for `Render Notes` are defined in a [relation](../Attributes.md) called `~renderNote`. In this example, it's the `Weight Tracker`'s child `Implementation`. The Implementation consists of two [code notes](../../Note%20Types/Code.md) that contain some HTML and JavaScript respectively, which load all the notes with a `weight` attribute and display their values in a chart.
+
+To actually render the chart, we're using a third party library called [chart.js](https://www.chartjs.org/)which is imported as an attachment, since it's not built into Trilium.
+
+### Code
+
+Here's the content of the script which is placed in a [code note](../../Note%20Types/Code.md) of type `JS Frontend`:
+
+```
+async function getChartData() {
+    const days = await api.runOnBackend(async () => {
+        const notes = api.getNotesWithLabel('weight');
+        const days = [];
+
+        for (const note of notes) {
+            const date = note.getLabelValue('dateNote');
+            const weight = parseFloat(note.getLabelValue('weight'));
+
+            if (date && weight) {
+                days.push({ date, weight });
+            }
+        }
+
+        days.sort((a, b) => a.date > b.date ? 1 : -1);
+
+        return days;
+    });
+
+    const datasets = [
+        {
+            label: "Weight (kg)",
+            backgroundColor: 'red',
+            borderColor: 'red',
+            data: days.map(day => day.weight),
+            fill: false,
+            spanGaps: true,
+            datalabels: {
+                display: false
+            }
+        }
+    ];
+
+    return {
+        datasets: datasets,
+        labels: days.map(day => day.date)
+    };
+}
+
+const ctx = $("#canvas")[0].getContext("2d");
+
+new chartjs.Chart(ctx, {
+    type: 'line',
+    data: await getChartData()
+});
+```
+
+## How to remove the Weight Tracker button from the top bar
+
+In the link map of the `Weight Tracker`, there is a note called `Button`. Open it and delete or comment out its contents. The `Weight Tracker` button will disappear after you restart Trilium.
@@ -0,0 +1,82 @@
+# Attributes
+In Trilium, attributes are key-value pairs assigned to notes, providing additional metadata or functionality. There are two primary types of attributes:
+
+1.  **Labels**: Simple key-value text records
+2.  **Relations**: Named links to other notes
+
+These attributes play a crucial role in organizing, categorising, and enhancing the functionality of notes.
+
+![](Attributes_image.png)
+
+## Labels
+
+Labels in Trilium can be used for a variety of purposes:
+
+*   **Metadata**: Assign labels with optional values for categorization, such as `#year=1999`, `#genre="sci-fi"`, or `#author="Neal Stephenson"`
+*   **Configuration**: Labels can configure advanced features or settings
+*   **Scripts and Plugins**: Used to tag notes with special metadata, such as the "weight" attribute in the [Weight Tracker](Advanced%20Showcases/Weight%20Tracker.md)
+
+Labels are also searchable, enhancing note retrieval.
+
+### Common Labels for Advanced Configuration
+
+*   `**disableVersioning**`: Disables automatic versioning, ideal for large, unimportant notes like script libraries
+*   `**versioningLimit**`: Used to limit the number of revisions for a single note
+*   `**calendarRoot**`: Marks the note as the root for [day notes](Advanced%20Showcases/Day%20Notes.md). Only one note should carry this label
+*   `**archived**`: Hides notes from default search results and dialogs
+*   `**excludeFromExport**`: Excludes notes and their subtrees from export operations
+*   `**run**`: Specifies events to trigger scripts (e.g., `frontendStartup`, `hourly`)
+*   `**runAtHour**`: Defines specific hours for scripts to run, used with `#run=hourly`
+*   `**disableInclusion**`: Prevents a script from being included in parent script executions
+*   `**sorted**`: Automatically sorts child notes alphabetically by title
+*   `**top**`: Keeps the note at the top of its parent's list, useful with `sorted`
+*   `**hidePromotedAttributes**`: Hides certain attributes in the note's display
+*   `**readOnly**`: Sets the note to read-only mode, applicable to text and code notes
+*   `**autoReadOnlyDisabled**`: Disables automatic read-only mode for large notes
+*   `**appCss**`: Marks CSS notes used to modify Trilium’s appearance
+*   `**appTheme**`: Marks full CSS themes available in Trilium's options
+*   `**cssClass**`: Adds a CSS class to the note's representation in the tree
+*   `**iconClass**`: Adds a CSS class to the note's icon, useful for distinguishing notes visually. See [note icons](../Basic%20Concepts%20and%20Features/Notes/Note%20Icons.md)
+*   `**pageSize**`: Specifies the number of items per page in note listings
+*   `**customRequestHandler**` **and** `**customResourceProvider**`: Refer to [Custom request handler](Custom%20Request%20Handler.md)
+*   `**widget**`: Marks a note as a custom widget, added to Trilium's component tree
+*   `**workspace**` **and related attributes**: See [Workspace](../Basic%20Concepts%20and%20Features/Navigation/Workspace.md) for more details
+*   `**searchHome**`: Specifies the parent for new search notes
+*   `**inbox**`: Designates a default location for new notes created via the sidebar
+*   `**sqlConsoleHome**`: Default location for SQL console notes
+*   `**bookmarked**` **and** `**bookmarkFolder**`: See [Bookmarks](../Basic%20Concepts%20and%20Features/Navigation/Bookmarks.md)
+*   `**shareXXX**`: See [Sharing](Sharing.md)
+*   `**keyboardShortcut**`: Assigns a keyboard shortcut to open the note
+*   `**displayRelations**` **and** `**hideRelations**`: Manages the display of note relations
+*   `**titleTemplate**`: See [Default note title](Default%20Note%20Title.md)
+*   `**template**`: Makes the note available as a template
+*   `**toc**`: Controls the visibility of the table of contents
+*   `**color**`: Defines the color of the note in the tree and links
+*   `**hideChildrenOverview**`: Hides child notes in the parent note's editor
+*   `**viewType**`: Sets the view of child notes (grid or list)
+
+## Relations
+
+Relations define connections between notes, similar to links.
+
+### Uses
+
+*   **Metadata Relationships**: For example, linking a book note to an author note
+*   **Scripting**: Attaching scripts to events or conditions related to the note
+
+### Common Relations
+
+*   **Event-based Relations**: Such as `runOnNoteCreation` or `runOnNoteChange`, which trigger scripts on specific actions
+*   **Other Relations**: Include `template`, `renderNote`, `widget`, and sharing-related relations
+
+## Multiplicity
+
+Attributes in Trilium can be "multivalued", meaning multiple attributes with the same name can coexist.
+
+## Attribute Definitions and Promoted Attributes
+
+Special labels create "label/attribute" definitions, enhancing the organization and management of attributes. For more details, see [Promoted attributes](Attributes/Promoted%20Attributes.md).
+
+## Attribute Inheritance
+
+Trilium supports attribute inheritance, allowing child notes to inherit attributes from their parents. For more information, see [Attribute inheritance](Attributes/Attribute%20Inheritance.md).
@@ -0,0 +1,25 @@
+# Attribute Inheritance
+## 1\. Standard Inheritance
+
+In Trilium, attributes can be automatically inherited by child notes if they have the `isInheritable` flag set to `true`. This means the attribute (a key-value pair) is applied to the note and all its descendants.
+
+### Example Use Case
+
+The `archived` label can be set to be inheritable, allowing you to hide a whole subtree of notes from searches and other dialogs by applying this label at the top level.
+
+## 2\. Copying Inheritance
+
+Copying inheritance differs from standard inheritance by using a `child:` prefix in the attribute name. This prefix causes new child notes to automatically receive specific attributes from the parent note. These attributes are independent of the parent and will persist even if the note is moved elsewhere.
+
+### How to Use
+
+*   **Syntax:** `#child:attributeName`
+*   **Chained Inheritance:** You can chain this inheritance, such as `#child:child:attributeName`, where each child down the hierarchy receives the appropriate attribute.
+
+### Example
+
+If a parent note has the label `#child:exampleAttribute`, all newly created child notes will inherit the `#exampleAttribute` label. This can be useful for setting default properties for notes in a specific section.
+
+## 3\. Template Inheritance
+
+Attributes can also be inherited from [templates](Template.md). When a new note is created using a template, it inherits the attributes defined in that template. This is particularly useful for maintaining consistency across notes that follow a similar structure or function.
@@ -0,0 +1,32 @@
+# Promoted Attributes
+Promoted attributes are [attributes](../Attributes.md) which are considered important and thus are "promoted" onto the main note UI. See example below:
+
+![](../../Attachments/promoted-attributes.png)
+
+You can see the note having kind of form with several fields. Each of these is just regular attribute, the only difference is that they appear on the note itself.
+
+Attributes can be pretty useful since they allow for querying and script automation etc. but they are also inconveniently hidden. This allows you to select few of the important ones and push them to the front of the user.
+
+Now, how do we make attribute to appear on the UI?
+
+## Attribute definition
+
+Attribute is always name-value pair where both name and value are strings.
+
+_Attribute definition_ specifies how should this value be interpreted - is it just string, or is it a date? Should we allow multiple values or note? And importantly, should we _promote_ the attribute or not?
+
+![](Promoted%20Attributes_image.png)
+
+You can notice tag attribute definition. These "definition" attributes define how the "value" attributes should behave.
+
+So there's one attribute for value and one for definition. But notice how definition attribute is [Inheritable](Attribute%20Inheritance.md), meaning that it's also applied to all descendant note. So in a way, this definition is used for the whole subtree while "value" attributes are applied only for this note.
+
+### Inverse relation
+
+Some relations always occur in pairs - my favorite example is on the family. If you have a note representing husband and note representing wife, then there might be a relation between those two of `isPartnerOf`. This is bidirectional relationship - meaning that if a relation is pointing from husband to wife then there should be always another relation pointing from wife to husband.
+
+Another example is with parent - child relationship. Again these always occur in pairs, but in this case it's not exact same relation - the one going from parent to child might be called `isParentOf` and the other one going from child to parent might be called `isChildOf`.
+
+Relation definition allows you to specify such "inverse relation" - for the relation you just define you specify which is the inverse relation. Note that in the second example we should have two relation definitions - one for `isParentOf` which defines `isChildOf` as inverse relation and then second relation definition for `isChildOf` which defines `isParentOf` as inverse relation.
+
+What this does internally is that whenever we save a relation which has defined inverse relation, we check that this inverse relation exists on the relation target note. Similarly, when we delete relation, we also delete inverse relation on the target note.
@@ -0,0 +1,36 @@
+# Template
+A template in Trilium serves as a predefined structure for other notes, referred to as instance notes. Assigning a template to a note brings three main effects:
+
+1.  **Attribute Inheritance**: All attributes from the template note are [inherited](Attribute%20Inheritance.md) by the instance notes. Even attributes with `#isInheritable=false` are inherited by the instance notes, although only inheritable attributes are further inherited by the children of the instance notes.
+2.  **Content Duplication**: The content of the template note is copied to the instance note, provided the instance note is empty at the time of template assignment.
+3.  **Child Note Duplication**: All child notes of the template are deep-duplicated to the instance note.
+
+## Example
+
+A typical example would be a "Book" template note, which might include:
+
+*   **Promoted Attributes**: Such as publication year, author, etc. (see [promoted attributes](Promoted%20Attributes.md)).
+*   **Outline**: An outline for a book review, including sections like themes, conclusion, etc.
+*   **Child Notes**: Additional notes for highlights, summary, etc.
+
+![Template Example](../../Attachments/template.png)
+
+## Instance Note
+
+An instance note is a note related to a template note. This relationship means the instance note's content is initialized from the template, and all attributes from the template are inherited.
+
+To create an instance note through the UI:
+
+![show child note templates](../../Attachments/template-create-instance-n.png)
+
+For the template to appear in the menu, the template note must have the `#template` label. Do not confuse this with the `~template` relation, which links the instance note to the template note. If you use [workspaces](../../Basic%20Concepts%20and%20Features/Navigation/Workspace.md), you can also mark templates with `#workspaceTemplate` to display them only in the workspace.
+
+Templates can also be added or changed after note creation by creating a `~template` relation pointing to the desired template note.
+
+## Additional Notes
+
+From a visual perspective, templates can define `#iconClass` and `#cssClass` attributes, allowing all instance notes (e.g., books) to display a specific icon and CSS style.
+
+Explore the concept further in the [demo notes](../Database.md), including examples like the [Relation Map](../../Note%20Types/Relation%20Map.md), [Task Manager](../Advanced%20Showcases/Task%20Manager.md), and [Day Notes](../Advanced%20Showcases/Day%20Notes.md).
+
+Additionally, see [default note title](../Default%20Note%20Title.md) for creating title templates. Note templates and title templates can be combined by creating a `#titleTemplate` for a template note.
@@ -0,0 +1,16 @@
+# Bulk actions
+### Execute script
+
+For more complex scenarios, it is possible to type in a JavaScript expression in order to apply the necessary changes.
+
+To apply a suffix (`- suffix` in this example), to the note title:
+
+```javascript
+note.title = note.title + " - suffix";
+```
+
+To alter attributes of a note in a bulk action, such as setting the `#shareAlias` label to the title of the note:
+
+```javascript
+note.setLabel("shareAlias", note.title)
+```
@@ -0,0 +1,30 @@
+# 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/config-sample.ini) in the [Notes](https://github.com/TriliumNext/Notes) 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:
+
+1.  Environment variables should be prefixed with `TRILIUM_` and use underscores to represent the INI section structure.
+2.  The format is: `TRILIUM_<SECTION>_<KEY>=<VALUE>`
+3.  The environment variables will override any matching values from config.ini
+
+For example, if you have this in your config.ini:
+
+```
+[Network]
+host=localhost
+port=8080
+```
+
+You can override these values using environment variables:
+
+```
+TRILIUM_NETWORK_HOST=0.0.0.0
+TRILIUM_NETWORK_PORT=9000
+```
+
+The code will:
+
+1.  First load the `config.ini` file as before
+2.  Then scan all environment variables for ones starting with `TRILIUM_`
+3.  Parse these variables into section/key pairs
+4.  Merge them with the config from the file, with environment variables taking precedence
@@ -0,0 +1,88 @@
+# Custom Request Handler
+Trilium provides a mechanism for [scripts](../Note%20Types/Code/Scripts.md) to open a public REST endpoint. This opens a way for various integrations with other services - a simple example would be creating new note from Slack by issuing a slash command (e.g. `/trilium buy milk`).
+
+## Create note from outside Trilium
+
+Let's take a look at an example. The goal is to provide a REST endpoint to which we can send title and content and Trilium will create a note.
+
+We'll start with creating a JavaScript backend [code note](../Note%20Types/Code.md) containing:
+
+```
+const {req, res} = api;
+const {secret, title, content} = req.body;
+
+if (req.method == 'POST' && secret === 'secret-password') {
+    // notes must be saved somewhere in the tree hierarchy specified by a parent note. 
+    // This is defined by a relation from this code note to the "target" parent note
+    // alternetively you can just use constant noteId for simplicity (get that from "Note Info" dialog of the desired parent note)
+    const targetParentNoteId = api.currentNote.getRelationValue('targetNote');
+    
+    const {note} = api.createTextNote(targetParentNoteId, title, content);
+    const notePojo = note.getPojo();
+
+    res.status(201).json(notePojo);
+}
+else {
+    res.send(400);
+}
+```
+
+This script note has also following two attributes:
+
+*   label `#customRequestHandler` with value `create-note`
+*   relation `~targetNote` pointing to a note where new notes should be saved
+
+### Explanation
+
+Let's test this by using an HTTP client to send a request:
+
+```
+POST http://my.trilium.org/custom/create-note
+Content-Type: application/json
+
+{
+  "secret": "secret-password",
+  "title": "hello",
+  "content": "world"
+}+++++++++++++++++++++++++++++++++++++++++++++++
+```
+
+Notice the `/custom` part in the request path - Trilium considers any request with this prefix as "custom" and tries to find a matching handler by looking at all notes which have `customRequestHandler` [label](Attributes.md). Value of this label then contains a regular expression which will match the request path (in our case trivial regex "create-note").
+
+Trilium will then find our code note created above and execute it. `api.req`, `api.res` are set to [request](https://expressjs.com/en/api.html#req) and [response](https://expressjs.com/en/api.html#res)objects from which we can get details of the request and also respond.
+
+In the code note we check the request method and then use trivial authentication - keep in mind that these endpoints are by default totally unauthenticated, and you need to take care of this yourself.
+
+Once we pass these checks we will just create the desired note using [Script API](../Note%20Types/Code/Script%20API.md).
+
+## Custom resource provider
+
+Another common use case is that you want to just expose a file note - in such case you create label `customResourceProvider` (value is again path regex).
+
+For more information, see [Custom Resource Providers](Custom%20Resource%20Providers.md).
+
+## Advanced concepts
+
+`api.req` and `api.res` are Express.js objects - you can always look into its [documentation](https://expressjs.com/en/api.html) for details.
+
+### Parameters
+
+REST request paths often contain parameters in the URL, e.g.:
+
+```
+http://my.trilium.org/custom/notes/123
+```
+
+The last part is dynamic so the matching of the URL must also be dynamic - for this reason the matching is done with regular expressions. Following `customRequestHandler` value would match it:
+
+```
+notes/([0-9]+)
+```
+
+Additionally, this also defines a matching group with the use of parenthesis which then makes it easier to extract the value. The matched groups are available in `api.pathParams`:
+
+```
+const noteId = api.pathParams[0];
+```
+
+Often you also need query params (as in e.g. `http://my.trilium.org/custom/notes?noteId=123`), you can get those with standard express `req.query.noteId`.
@@ -0,0 +1,34 @@
+# Custom Resource Providers
+A custom resource provider allows any file imported into Trilium (images, fonts, stylesheets) to be publicly accessible via a URL.
+
+A potential use case for this is to add embed a custom font alongside a theme.
+
+## Steps for creating a custom resource provider
+
+1.  Import a file such as an image or a font into Trilium by drag & drop.
+2.  Select the file and go to the _Owned Attributes_ section.
+3.  Add the label `#customResourceProvider=hello`.
+4.  To test if it is working, use a browser to navigate to `<protocol>://<host>/custom/hello` (where `<protocol>` is either `http` or `https` based on your setup, and `<host>` is the host or IP to your Trilium server instance). If you are running the TriliumNext application without a server, use `http://localhost:37840` as the base URL.
+5.  If everything went well, at the previous step the browser should have downloaded the file uploaded in the first step.
+
+Instead of `hello`, the name can be:
+
+*   A path, such as `fonts/Roboto.ttf`, which would be accessible via `<host>/custom/fonts/Roboto.ttf`.
+*   As a more advanced use case, a regular expression to match multiple routes, such as `hello/.*` which will be accessible via `/custom/hello/1`, `/custom/hello/2`, `/custom/hello/world`, etc.
+
+## Using it in a theme
+
+For example, if you have a custom font to be imported by the theme, first upload a font file into Trilium and assign it the `#customResourceProvider=fonts/myfont.ttf` attribute.
+
+Then modify the theme CSS to point to:
+
+```css
+@font-face {
+	font-family: customFont;
+	src: url("/custom/fonts/myfont.ttf");
+}
+
+div {
+	font-family: customFont;
+}
+```
@@ -0,0 +1,37 @@
+# Database
+Your Trilium data is stored in a [SQLite](https://www.sqlite.org) database which contains all notes, tree structure, metadata, and most of the configuration. The database file is named `document.db` and is stored in the application's default [Data directory](../Installation%20%26%20Setup/Data%20directory.md).
+
+## Demo Notes
+
+When you run Trilium for the first time, it will generate a new database containing demo notes. These notes showcase its many features, such as:
+
+*   [Relation Map](../Note%20Types/Relation%20Map.md)
+*   [Day Notes](Advanced%20Showcases/Day%20Notes.md)
+*   [Weight Tracker](Advanced%20Showcases/Weight%20Tracker.md)
+*   [Task Manager](Advanced%20Showcases/Task%20Manager.md)
+*   [Custom CSS Themes](../Basic%20Concepts%20and%20Features/Themes.md)
+
+### Restoring Demo Notes
+
+There are some cases in which you may want to restore the original demo notes. For example, if you experimented with some of the more advanced features and want to see the original reference, or if you simply want to explore the latest version of the demo notes, which might showcase new features.
+
+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
+*   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
+
+## Manually Modifying the Database
+
+Trilium provides a lot of flexibility, and with it, opportunities for advanced users to tweak it. If you need to explore or modify the database directly, you can use a tool such as [SQLite Browser](https://sqlitebrowser.org/) to work directly on the database file.
+
+See [Manually altering the database](Database/Manually%20altering%20the%20database.md) for more information.
+
+## How to Reset the Database
+
+If you are experimenting with Trilium and want to return it to its original state, you can do that by deleting the current database. When you restart the application, it will generate a new database containing the original demo notes.
+
+To delete the database, simply go to the [data directory](../Installation%20%26%20Setup/Data%20directory.md) and delete the `document.db` file (and any other files starting with `document.db`).
+
+If you do not need to preserve any configurations that might be stored in the `config.ini` file, you can just delete all of the [data directory's](../Installation%20%26%20Setup/Data%20directory.md) contents to fully restore the application to its original state. You can also review the [configuration](Configuration%20\(config.ini%20or%20e.md) file to provide all `config.ini` values as environment variables instead.
@@ -0,0 +1,42 @@
+# Manually altering the database
+There are some situations where modifying the SQLite database that Trilium uses is desirable.
+
+If you are doing any advanced development or troubleshooting where you manually modify the database, you might want to consider creating backups of your `document.db` file.
+
+## Modifying it internally using the SQL Console
+
+The SQL Console is Trilium's built-in database editor.
+
+See [SQL Console](Manually%20altering%20the%20database/SQL%20Console.md).
+
+## Externally modifying the database
+
+Sometimes the SQL Console cannot be used (for example if the application cannot start).
+
+When making external modifications, consider closing the desktop application. If modifying the server database, then stop the service or Docker container.
+
+### Using DB Browser for SQLite
+
+DB Browser for SQLite is a cross-platform editor that can be used to alter the database using a graphical user interface.
+
+To do so:
+
+1.  In the main menu, select File → Open database… and navigate to the database in the [Data directory](../../Installation%20%26%20Setup/Data%20directory.md).
+2.  Select the _Execute SQL_ tab.
+3.  Type in the desired SQL statement.
+4.  Press the "Play" button in the toolbar underneath the "Execute SQL" tab (or F5 key).
+5.  Press "Write Changes" in the main toolbar.
+6.  Close the application or close the database.
+
+![](Manually%20altering%20the%20data.png)
+
+### Using the SQLite CLI
+
+First, start the SQLite 3 CLI by specifying the path to the database:
+
+```
+sqlite3 ~/.local/share/trilium-data/document.db
+```
+
+*   In the prompt simply type the statement and make sure it ends with a `;` character.
+*   To exit, simply type `.quit` and enter.
@@ -0,0 +1,28 @@
+# SQL Console
+The SQL Console is Trilium's built-in database editor.
+
+It can be accessed by going to the [global menu](../../../Basic%20Concepts%20and%20Features/UI%20Elements) → Advanced → Open SQL Console.
+
+![](SQL%20Console_image.png)
+
+### 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
+
+SQL queries or commands can be saved into a dedicated note.
+
+To do so, simply write the query and press the ![](2_SQL%20Console_image.png)button. Once saved, the note will appear in [Day Notes](../../Advanced%20Showcases/Day%20Notes.md).
+
+*   The SQL expression will not be displayed by default, but it can still be viewed by going to the note context menu and selecting _Note source_.
+*   The expression cannot be modified. If needed, recreate it by copying the statement back into the SQL console and then saving it again.
@@ -0,0 +1,30 @@
+# Default Note Title
+When a new note is created, its name is by default "new note". In some cases, it can be desirable to have a different or even a dynamic default note title.
+
+For this use case, Trilium (since v0.52) supports `#titleTemplate` [label](Attributes.md). You can create such a label for a given note, assign it a value, and this value will be used as a default title when creating child notes. As with other labels, you can make it inheritable to apply recursively, and you can even place it on the root note to have it applied globally everywhere.
+
+As an example use case, imagine you collect books you've read in a given year like this:
+
+*   2022 Books
+    *   Neal Stephenson: Anathem, 2008
+    *   Franz Kafka: Die Verwandlung, 1915
+
+Now, to the parent note "2022 Books" you can assign label `#titleTemplate="[Author name]: [Book title], [Publication year]"`.
+
+And all children of "2022 Books" will be created with initial title "\[Author name\]: \[Book title\], \[Publication year\]". There's no artificial intelligence here, the idea is to just prompt you to manually fill in the pieces of information into the note title by yourself.
+
+## Dynamic value
+
+The value of `#titleTemplate` is evaluated at the point of note's creation as a JavaScript string, which means it can be enriched with the help of JS string interpolation with dynamic data.
+
+As an example, imagine you collect server outage incidents and write some notes. It looks like this:
+
+*   Incidents
+    *   2022-05-09: System crash
+    *   2022-05-15: Backup delay
+
+You can automatize the date assignment by assigning a label `#titleTemplate="${now.format('YYYY-MM-DD')}: "` to the parent note "Incidents". Whenever a new child note is created, the title template is evaluated with the injected [now](https://day.js.org/docs/en/display/format) object.
+
+Second variable injected is [parentNote](https://triliumnext.github.io/Notes/backend_api/BNote.html), an example could be `#titleTemplate="${parentNote.getLabelValue('authorName')}'s literary works"`.
+
+See also \[\[[template](Attributes/Template.md)\]\] which provides similar capabilities, including default note's content.
@@ -0,0 +1,54 @@
+# 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).
+
+## API clients
+
+As an alternative to calling the API directly, there are client libraries to simplify this
+
+*   [trilium-py](https://github.com/Nriver/trilium-py), you can use Python to communicate with Trilium.
+
+## Authentication
+
+All operations 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)):
+
+```
+GET https://myserver.com/etapi/app-info
+Authorization: ETAPITOKEN
+```
+
+Alternatively, since 0.56 you can also use basic auth format:
+
+```
+GET https://myserver.com/etapi/app-info
+Authorization: Basic BATOKEN
+```
+
+*   Where `BATOKEN = BASE64(username + ':' + password)` - this is a standard Basic Auth serialization
+*   Where `username` is "etapi"
+*   And `password` is the generated ETAPI token described above.
+
+Basic Auth is meant to be used with tools which support only basic auth.
+
+## Interaction using Bash scripts
+
+It is possible to write simple Bash scripts to interact with Trilium. As an example, here's how to obtain the HTML content of a note:
+
+```sh
+#!/usr/bin/env bash
+
+# Configuration
+TOKEN=z1vA4fkGxjOR_ZXLrZeqHEFOv65yV3882iFCRtNIK9k9iWrHliITNSLQ=
+SERVER=http://localhost:8080
+
+# Download a note by ID
+NOTE_ID="i6ra4ZshJhgN"
+curl "$SERVER/etapi/notes/$NOTE_ID/content" -H "Authorization: $TOKEN" 
+```
+
+Make sure to replace the values of:
+
+*   `TOKEN` with your ETAPI token.
+*   `SERVER` with the correct protocol, host name and port to your Trilium instance.
+*   `NOTE_ID` with an existing note ID to download.
@@ -0,0 +1,32 @@
+# Note Map (Link map, Tree map)
+Note map is a visualisation of connections between notes.
+
+This provides an insight into a structure ("web") of notes.
+
+There are two types of note map:
+
+*   Link Map, which shows relations between notes.
+*   Note Map, which shows the hierarchical tree structure.
+
+## Link Map
+
+Shows [relations](Attributes.md) between notes:
+
+![](1_Note%20Map%20\(Link%20map,%20Tree%20m.png)
+
+## Tree Map
+
+Shows hierarchical map of notes:
+
+![](Note%20Map%20\(Link%20map,%20Tree%20m.png)
+
+## Dedicated note type
+
+Apart from the note map feature which can be accessed from any note, it is also possible to create a dedicated note which will display the relations in full screen. See [Note Map](../Note%20Types/Note%20Map.md) for more information.
+
+## See also
+
+[Relation map](../Note%20Types/Relation%20Map.md) is a similar concept, with some differences:
+
+*   note map is automatically generated while relation map must be created manually
+*   relation map is a type of note while a link map is just virtual visualization
@@ -0,0 +1,55 @@
+# Note source
+## Understanding the source code of the different notes
+
+Internally, the structure of the content of each note is different based on the [Note Types](../Note%20Types).
+
+For example:
+
+*   [Text Notes](#root/_hidden/_options/_optionsTextNotes) are represented internally as HTML, using the [CKEditor](Technologies%20used/CKEditor.md) representation. Note that due to the custom plugins, some HTML elements are specific to Trilium only, for example the admonitions.
+*   [Code Notes](#root/_hidden/_options/_optionsCodeNotes) are plain text and are represented internally as-is.
+*   [Geo map](../Note%20Types/Geo%20map.md) notes contain only minimal information (viewport, zoom) as a JSON.
+*   [Canvas](../Note%20Types/Canvas.md) notes are represented as JSON, with Trilium's own information alongside with [Excalidraw](Technologies%20used/Excalidraw.md)'s internal JSON representation format.
+*   [Mind Map](../Note%20Types/Mind%20Map.md) notes are represented as JSON, with the internal format of [MindElixir](Technologies%20used/MindElixir.md).
+
+Note that some information is also stored as [Attachments](../Attachments). For example [Canvas](../Note%20Types/Canvas.md) notes use the attachments feature to store the custom libraries, and alongside with [Mind Map](../Note%20Types/Mind%20Map.md) and other similar note types it stores an SVG representation of the content for use in other features such as including in other notes, shared notes, etc.
+
+Here's part of the HTML representation of this note, as it's stored in the database (but prettified).
+
+```html
+<h2>
+	Understanding the source code of the different notes
+</h2>
+<p>
+	Internally, the structure of the content of each note is different based on the&nbsp;
+	<a class="reference-link" href="../Note%20Types">
+		Note Types
+	</a>
+	.
+</p>
+```
+
+## Viewing the source code
+
+It is possible to view the source code of a note by pressing the contextual menu in [Note buttons](../Basic%20Concepts%20and%20Features/UI%20Elements/Note%20buttons.md) and selecting _Note source_.
+
+![](Note%20source_image.png)
+
+The source code will be displayed in a new tab.
+
+For some note types, such as text notes, the source code is also formatted in order to be more easily readable.
+
+## Modifying the source code
+
+It is possible to modify the source code of a note directly, however not via the _Note source_ functionality. 
+
+To do so:
+
+1.  Change the note type from the real note type (e.g. Canvas, Geo Type) to Code (plain text) or the corresponding format such as JSON or HTML.
+2.  Confirm the warning about changing the note type.
+3.  The source code will appear, make the necessary modifications.
+4.  Change the note type back to the real note type.
+
+> [!WARNING]
+> Depending on the changes made, there is a risk that the note will not render properly. It's best to save a revision before making any big changes.
+> 
+> If the note does not render properly, modify the source code again or revert to a prior revision. Since the error handling for unexpected changes might not always be perfect, it be required to refresh the application.
@@ -0,0 +1,101 @@
+# Sharing
+Trilium allows you to share selected notes as **publicly accessible** read-only documents. This feature is particularly useful for publishing content directly from your Trilium notes, making it accessible to others online.
+
+## Prerequisites
+
+To use the sharing feature, you must have a [server installation](../Installation%20%26%20Setup/Server%20Installation.md) of Trilium. This is necessary because the notes will be hosted from the server.
+
+## How to Share a Note
+
+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](../Attachments/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](../Attachments/share-single-note-web.png)
+    
+
+## Sharing a Note Subtree
+
+When you share a note, you actually share the entire subtree of notes beneath it. If the note has child notes, they will also be included in the shared content. For example, sharing the "Formatting" subtree will display a page with basic navigation for exploring all the notes within that subtree.
+
+![Shared Subtree Example](../Attachments/share-multiple-notes-web.png)
+
+## Viewing All Shared Notes
+
+You can view a list of all shared notes by clicking on "Show Shared Notes Subtree." This allows you to manage and navigate through all the notes you have made public.
+
+## Security Considerations
+
+Shared notes are published on the open internet and can be accessed by anyone with the URL. The URL's randomness does not provide security, so it is crucial not to share sensitive information through this feature.
+
+### Password Protection
+
+To protect shared notes with a username and password, you can use the `#shareCredentials` attribute. Add this label to the note with the format `#shareCredentials="username:password"`. To protect an entire subtree, make sure the label is [inheritable](Attributes/Attribute%20Inheritance.md).
+
+## Advanced Sharing Options
+
+### Customizing the Appearance of Shared Notes
+
+The default shared page is basic in design, but you can customize it using your own CSS:
+
+*   **Custom CSS**: Link a CSS [code note](../Note%20Types/Code.md) to the shared page by adding a `~shareCss` relation to the note. If you want this style to apply to the entire subtree, make the label inheritable. You can hide the CSS code note from the tree navigation by adding the `#shareHiddenFromTree` label.
+*   **Omitting Default CSS**: For extensive styling changes, use the `#shareOmitDefaultCss` label to avoid conflicts with Trilium's [default stylesheet](../Basic%20Concepts%20and%20Features/Themes.md).
+
+### Adding JavaScript
+
+You can inject custom JavaScript into the shared note using the `~shareJs` relation. This allows you to access note attributes or traverse the note tree using the `fetchNote()` API, which retrieves note data based on its ID.
+
+Example:
+
+```javascript
+const currentNote = await fetchNote();
+const parentNote = await fetchNote(currentNote.parentNoteIds[0]);
+
+for (const attr of parentNote.attributes) {
+    console.log(attr.type, attr.name, attr.value);
+}
+```
+
+### Creating Human-Readable URL Aliases
+
+Shared notes typically have URLs like `http://domain.tld/share/knvU8aJy4dJ7`, where the last part is the note's ID. You can make these URLs more user-friendly by adding the `#shareAlias` label to individual notes (e.g., `#shareAlias=highlighting`). This will change the URL to `http://domain.tld/share/highlighting`.
+
+**Important**:
+
+1.  Ensure that aliases are unique.
+2.  Using slashes (`/`) within aliases to create subpaths is not supported.
+
+### Viewing and Managing Shared Notes
+
+All shared notes are grouped under an automatically managed "Shared Notes" section. From here, you can view, share, or unshare notes by moving or cloning them within this section.
+
+![Shared Notes List](../Attachments/shared-list.png)
+
+### Setting a Custom Favicon
+
+To customize the favicon for your shared pages, create a relation `~shareFavicon` pointing to a file note containing the favicon (e.g., in `.ico` format).
+
+### Sharing a Note as the Root
+
+You can designate a specific note or folder as the root of your shared content by adding the `#shareRoot` label. This note will be linked when visiting `[http://domain.tld/share](http://domain/share)`, making it easier to use Trilium as a fully-fledged website. Consider combining this with the `#shareIndex` label, which will display a list of all shared notes.
+
+## Additional Options
+
+*   **Raw Note Sharing**: Use the `#shareRaw` label to share a note without any HTML wrapper.
+*   **Disallow Robot Indexing**: Add the `#shareDisallowRobotIndexing` label to prevent search engines from indexing the shared page by including a `noindex, follow` meta tag and `X-Robots-Tag: noindex` header.
+*   **Shared Notes Index**: For text notes with the `#shareIndex` label, the content will display a list of all shared note roots.
+
+## Limitations
+
+While the sharing feature is powerful, it has some limitations:
+
+*   **No Relation Map Support**
+*   **Book Notes**: Only show a list of child notes.
+*   **Code Notes**: No syntax highlighting.
+*   **Static Note Tree**
+*   **Protected Notes**: Cannot be shared.
+*   **Include Notes**: Not supported.
+
+Some of these limitations may be addressed in future updates.
@@ -0,0 +1,16 @@
+# Serving directly the content of a note
+When accessing a shared note, Trilium will render it as a web page. Sometimes it's desirable to serve the content directly so that it can be used in a script or downloaded by the user.
+
+| A note displayed as a web page (HTML) | A note displayed as a raw format |
+| --- | --- |
+| ![](1_Serving%20directly%20the%20conte.png) | ![](Serving%20directly%20the%20conte.png) |
+
+## By adding an attribute to the note
+
+Simply add the `#shareRaw` attribute and the note will always be rendered _raw_ when accessed from the share URL.
+
+## By altering the URL
+
+Append `?raw` to the URL to display a note in its raw format regardless of whether the `#shareRaw` attribute is added on the note.
+
+![](Serving%20directly%20the%20conte.png)
@@ -0,0 +1,4 @@
+# Technologies used
+One core aspect of Trilium that allows it to have support for multiple [Note Types](../Note%20Types) is the fact that it makes use of various off-the-shelf or reusable libraries.
+
+The sub-pages showcase some of the technologies used, for a better understanding of how Trilium works but also to credit the developers of that particular technology.
@@ -0,0 +1,34 @@
+# CKEditor
+## Editor core
+
+The CKEditor is the WYSIWYG (standing for What You See Is What You Get) editor behind [Text](../../Note%20Types/Text.md) notes.
+
+Their website is [ckeditor.com](https://ckeditor.com/).
+
+CKEditor by itself is a commercial product, but the core is open-source. As described in [its documentation](https://ckeditor.com/docs/ckeditor5/latest/features/index.html), the editor supports quite a large number of features. Do note that not all the features are enabled in Trilium.
+
+## Premium features
+
+Some features are marked as premium in the CKEditor feature set. This means that they cannot be used without a license.
+
+Trilium cannot benefit from any of these premium features as they require a commercial license, however we are in discussions with the CKEditor team to allow us to use a subset of these premium features such as [Slash commands](https://ckeditor.com/docs/ckeditor5/latest/features/slash-commands.html).
+
+## Plugins
+
+The CKEditor ecosystem is quite extensible, in the sense that custom plugins can be written to extend the functionality of the editor beyond its original scope.
+
+Trilium makes use of such features:
+
+*   The math feature is added by a version of [isaul32/ckeditor5-math: Math feature for CKEditor 5.](https://github.com/isaul32/ckeditor5-math) modified by us to fit our needs.
+*   We also make use of modified upstream plugins such as [ckeditor/ckeditor5-mermaid](https://github.com/ckeditor/ckeditor5-mermaid) to allow inline Mermaid code.
+*   [mlewand/ckeditor5-keyboard-marker: Plugin adds support for the keyboard input element (<kbd>) to CKEditor 5.](https://github.com/mlewand/ckeditor5-keyboard-marker)
+*   A modified version of [ThomasAitken/ckeditor5-footnotes: Footnotes plugin for CKEditor5](https://github.com/ThomasAitken/ckeditor5-footnotes) to allow footnotes.
+
+Apart from that, Trilium also has its own set of specific plugins such as:
+
+*   Cut to note
+*   Include note
+*   Mentions, for linking pages.
+*   Markdown import.
+*   Reference links.
+*   etc.
@@ -0,0 +1,4 @@
+# Excalidraw
+[Excalidraw](https://excalidraw.com/) is the technology behind the [Canvas](../../Note%20Types/Canvas.md) notes. The source code of the library is available on [GitHub](https://github.com/excalidraw/excalidraw).
+
+We are using an unmodified version of it, so it shares the same [issues](https://github.com/excalidraw/excalidraw/issues) as the original.
@@ -0,0 +1,10 @@
+# Leaflet
+Leaflet is the library behind [Geo map](../../Note%20Types/Geo%20map.md) notes.
+
+## Plugins
+
+Leaflet is also highly customizable via external plugins.
+
+Currently we use:
+
+*   [mpetazzoni/leaflet-gpx: A GPX track plugin for Leaflet.js](https://github.com/mpetazzoni/leaflet-gpx)
@@ -0,0 +1,12 @@
+# MindElixir
+MindElixir is the library we are using for the [Mind Map](../../Note%20Types/Mind%20Map.md) note types.
+
+The main library is available on [GitHub as mind-elixir-core](https://github.com/SSShooter/mind-elixir-core/issues).
+
+The library is embedded as-is without additional modifications.
+
+Issues with its functionality should generally be reported [upstream](https://github.com/ssshooter/mind-elixir-core).
+
+## Plugins
+
+MindElixir supports plugins, and one such plugin we are making use of is [SSShooter/node-menu: A node menu plugin of mind-elixir](https://github.com/SSShooter/node-menu), which allows editing the fonts, colors, links of nodes.
@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg width="147px" height="32px" viewBox="0 0 147 32" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:sketch="http://www.bohemiancoding.com/sketch/ns">
+    <!-- Generator: Sketch 3.0.4 (8053) - http://www.bohemiancoding.com/sketch -->
+    <title>button</title>
+    <desc>Created with Sketch.</desc>
+    <defs></defs>
+    <g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd" sketch:type="MSPage">
+        <g id="button" sketch:type="MSLayerGroup">
+            <rect id="Background" fill="#7056BF" sketch:type="MSShapeGroup" x="0" y="0" width="147" height="32" rx="4"></rect>
+            <g id="Icon" transform="translate(10.000000, 8.000000)" fill="#FFFFFF" sketch:type="MSShapeGroup">
+                <path d="M14.819,3.216 L9.103,0.25 C8.464,-0.082 7.536,-0.081 6.898,0.25 L1.181,3.216 C0.496,3.571 0,4.365 0,5.102 L0,11.035 C0,11.774 0.497,12.566 1.181,12.921 L4.039,14.404 C4.529,14.656 5.134,14.467 5.388,13.978 C5.642,13.487 5.451,12.884 4.961,12.629 L2.106,11.148 C2.068,11.124 2.008,11.039 2,11.035 L1.996,5.143 C2.008,5.098 2.068,5.013 2.103,4.991 L7.816,2.026 C7.897,1.991 8.106,1.992 8.181,2.025 L13.894,4.989 C13.932,5.013 13.992,5.098 14,5.102 L14.003,10.995 C13.992,11.039 13.932,11.124 13.898,11.146 L11.039,12.629 C10.549,12.884 10.358,13.487 10.612,13.978 C10.79,14.32 11.14,14.517 11.501,14.517 C11.656,14.517 11.814,14.481 11.961,14.404 L14.818,12.921 C15.503,12.566 16,11.774 16,11.035 L16,5.102 C16,4.365 15.504,3.571 14.819,3.216" id="App"></path>
+                <path d="M11.707,9.707 C12.098,9.316 12.098,8.684 11.707,8.293 L8.708,5.294 C8.616,5.201 8.505,5.128 8.382,5.077 C8.138,4.976 7.862,4.976 7.618,5.077 C7.495,5.128 7.385,5.201 7.292,5.294 L4.293,8.293 C3.902,8.684 3.902,9.316 4.293,9.707 C4.488,9.902 4.744,10 5,10 C5.256,10 5.512,9.902 5.707,9.707 L7,8.414 L7,15 C7,15.553 7.447,16 8,16 C8.553,16 9,15.553 9,15 L9,8.414 L10.293,9.707 C10.488,9.902 10.744,10 11,10 C11.256,10 11.512,9.902 11.707,9.707" id="Arrow"></path>
+            </g>
+            <path d="M81.393,21.091 C81.744,21.091 82.173,21.052 82.368,21.013 L82.368,20.09 C82.186,20.142 81.913,20.181 81.666,20.181 C80.834,20.181 80.6,19.817 80.6,19.089 L80.6,15.059 L82.381,15.059 L82.381,14.136 L80.6,14.136 L80.6,11.692 L79.482,11.692 L79.482,14.136 L78.286,14.136 L78.286,15.059 L79.482,15.059 L79.482,19.336 C79.482,20.532 79.95,21.091 81.393,21.091 Z M86.697,21.143 C88.374,21.143 89.882,19.921 89.882,17.568 C89.882,15.202 88.374,13.993 86.697,13.993 C85.007,13.993 83.499,15.202 83.499,17.568 C83.499,19.921 85.02,21.143 86.697,21.143 Z M86.697,20.194 C85.306,20.194 84.63,19.024 84.63,17.568 C84.63,16.021 85.384,14.955 86.697,14.955 C88.062,14.955 88.751,16.138 88.751,17.568 C88.751,19.141 87.997,20.194 86.697,20.194 Z M94.705,21 L95.849,21 L95.849,16.463 L100.802,16.463 L100.802,21 L101.946,21 L101.946,11.38 L100.802,11.38 L100.802,15.41 L95.849,15.41 L95.849,11.38 L94.705,11.38 L94.705,21 Z M106.834,21.143 C108.121,21.143 108.992,20.597 109.629,19.687 L108.979,19.115 C108.459,19.83 107.9,20.233 106.912,20.233 C105.781,20.233 104.884,19.401 104.845,17.854 L109.694,17.854 L109.694,17.62 C109.694,15.137 108.459,13.993 106.834,13.993 C105.391,13.993 103.727,15.072 103.727,17.568 C103.727,19.96 105.209,21.143 106.834,21.143 Z M104.871,16.983 C105.027,15.566 105.898,14.929 106.821,14.929 C107.952,14.929 108.537,15.761 108.628,16.983 L104.871,16.983 Z M111.293,21 L112.411,21 L112.411,16.567 C112.918,15.592 113.737,15.02 114.829,15.02 C114.868,15.02 115.115,15.02 115.154,15.033 L115.232,13.993 L115.089,13.993 C113.75,13.993 112.944,14.617 112.437,15.41 L112.411,15.41 L112.411,14.136 L111.293,14.136 L111.293,21 Z M119.301,21.143 C120.978,21.143 122.486,19.921 122.486,17.568 C122.486,15.202 120.978,13.993 119.301,13.993 C117.611,13.993 116.103,15.202 116.103,17.568 C116.103,19.921 117.624,21.143 119.301,21.143 Z M119.301,20.194 C117.91,20.194 117.234,19.024 117.234,17.568 C117.234,16.021 117.988,14.955 119.301,14.955 C120.666,14.955 121.355,16.138 121.355,17.568 C121.355,19.141 120.601,20.194 119.301,20.194 Z M124.072,21 L125.19,21 L125.19,18.894 L126.555,17.425 L128.583,21 L129.779,21 L127.283,16.593 L129.532,14.136 L128.258,14.136 L125.19,17.568 L125.19,11.38 L124.072,11.38 L124.072,21 Z M133.055,21.13 C134.173,21.13 135.031,20.558 135.629,19.973 L135.629,21 L136.76,21 L136.76,14.136 L135.629,14.136 L135.629,19.089 C134.914,19.765 134.238,20.194 133.406,20.194 C132.535,20.194 132.145,19.765 132.145,18.855 L132.145,14.136 L131.027,14.136 L131.027,19.089 C131.027,20.389 131.742,21.13 133.055,21.13 L133.055,21.13 Z" id="to-Heroku" fill="#B7A7D5" sketch:type="MSShapeGroup"></path>
+            <path d="M34.183,21 L36.718,21 C39.773,21 41.567,19.427 41.567,16.164 C41.567,12.94 39.812,11.38 36.718,11.38 L34.183,11.38 L34.183,21 Z M35.327,19.973 L35.327,12.433 L36.835,12.433 C39.175,12.433 40.423,13.577 40.423,16.164 C40.423,18.842 39.188,19.973 36.861,19.973 L35.327,19.973 Z M46,21.143 C47.287,21.143 48.158,20.597 48.795,19.687 L48.145,19.115 C47.625,19.83 47.066,20.233 46.078,20.233 C44.947,20.233 44.05,19.401 44.011,17.854 L48.86,17.854 L48.86,17.62 C48.86,15.137 47.625,13.993 46,13.993 C44.557,13.993 42.893,15.072 42.893,17.568 C42.893,19.96 44.375,21.143 46,21.143 Z M44.037,16.983 C44.193,15.566 45.064,14.929 45.987,14.929 C47.118,14.929 47.703,15.761 47.794,16.983 L44.037,16.983 Z M50.459,23.6 L51.577,23.6 L51.577,20.116 C52.162,20.727 52.877,21.104 53.722,21.104 C55.399,21.104 56.634,19.947 56.634,17.555 C56.634,15.163 55.412,13.993 53.839,13.993 C52.812,13.993 52.097,14.513 51.577,15.085 L51.577,14.136 L50.459,14.136 L50.459,23.6 Z M53.566,20.194 C52.838,20.194 52.175,19.83 51.577,19.154 L51.577,16.008 C52.149,15.384 52.786,14.955 53.579,14.955 C54.684,14.955 55.516,15.813 55.516,17.568 C55.516,19.388 54.762,20.194 53.566,20.194 Z M58.324,21 L59.442,21 L59.442,11.38 L58.324,11.38 L58.324,21 Z M64.304,21.143 C65.981,21.143 67.489,19.921 67.489,17.568 C67.489,15.202 65.981,13.993 64.304,13.993 C62.614,13.993 61.106,15.202 61.106,17.568 C61.106,19.921 62.627,21.143 64.304,21.143 Z M64.304,20.194 C62.913,20.194 62.237,19.024 62.237,17.568 C62.237,16.021 62.991,14.955 64.304,14.955 C65.669,14.955 66.358,16.138 66.358,17.568 C66.358,19.141 65.604,20.194 64.304,20.194 Z M69.465,23.639 C70.804,23.639 71.337,22.989 71.805,21.78 L74.743,14.136 L73.612,14.136 L71.597,19.687 L71.571,19.687 L69.556,14.136 L68.373,14.136 L71.025,21.039 L70.765,21.715 C70.492,22.391 70.154,22.69 69.452,22.69 C68.971,22.69 68.633,22.625 68.438,22.573 L68.178,23.47 C68.477,23.561 68.854,23.639 69.465,23.639 L69.465,23.639 Z" id="Deploy" fill="#FFFFFF" sketch:type="MSShapeGroup"></path>
+        </g>
+    </g>
+</svg>
--- a/Show More
+++ b/Show More