diff --git a/README.md b/README.md index cc1facf82..41db1c02e 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,7 @@ * [Package Manager](#package-manager) * [Docker Hosting](#docker-hosting) * [Unraid Hosting](#unraid-hosting) + * [TrueNAS Hosting](#TrueNAS-hosting) * [Insider Preview](#insider-preview) * [🏘️ Community](#️-community) * [🛠️ Development Guide](#️-development-guide) @@ -313,6 +314,42 @@ Publish parameters: --accessAuthCode=******(Access authorization code) +### TrueNAS Hosting + +
+TrueNAS Deployment + +Note: First run below commands in the TrueNAS Shell. please update Pool_1/Apps_Data/siyuan to match your dataset for Apps + +`zfs create Pool_1/Apps_Data/siyuan` + +`chown -R 1001:1002 /mnt/Pool_1/Apps_Data/siyuan` + +`chmod 755 /mnt/Pool_1/Apps_Data/siyuan` + +Navigate to Apps --> DiscoverApps --> More Options(on top right, besies Custom App) --> Install via YAML + +Template reference: + +``` +services: + siyuan: + image: b3log/siyuan + container_name: siyuan + command: ['--workspace=/siyuan/workspace/', '--accessAuthCode=2222'] + ports: + - 6806:6806 + volumes: + - /mnt/Pool_1/Apps_Data/siyuan:/siyuan/workspace # Adjust to your dataset path + restart: unless-stopped + environment: + - TZ=America/Los_Angeles # Replace with your timezone if needed + - PUID=1001 + - PGID=1002 +``` + +
+ ### Insider Preview We release insider preview before major updates, please visit [https://github.com/siyuan-note/insider](https://github.com/siyuan-note/insider).