[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"project-1034":3},{"id":4,"name":5,"fullName":6,"owner":7,"repo":5,"description":8,"homepage":9,"htmlUrl":10,"language":11,"languages":10,"totalLinesOfCode":10,"stars":12,"forks":13,"watchers":14,"openIssues":15,"contributorsCount":16,"subscribersCount":16,"size":16,"stars1d":17,"stars7d":18,"stars30d":19,"stars90d":16,"forks30d":16,"starsTrendScore":20,"compositeScore":21,"rankGlobal":10,"rankLanguage":10,"license":22,"archived":23,"fork":23,"defaultBranch":24,"hasWiki":23,"hasPages":23,"topics":25,"createdAt":10,"pushedAt":10,"updatedAt":45,"readmeContent":46,"aiSummary":47,"trendingCount":16,"starSnapshotCount":16,"syncStatus":48,"lastSyncTime":49,"discoverSource":50},1034,"siyuan","siyuan-note\u002Fsiyuan","siyuan-note","A privacy-first, self-hosted, fully open source personal knowledge management software, written in typescript and golang.","https:\u002F\u002Fb3log.org\u002Fsiyuan",null,"TypeScript",44391,2832,175,324,0,18,134,570,87,45,"GNU Affero General Public License v3.0",false,"master",[26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44],"anki","chatgpt","deepseek","electron","evernote","knowledge-base","local-first","markdown","note-taking","notes-app","notion","obsidian","ocr","ollama","openclaw","pdf","s3","self-hosted","webdav","2026-06-12 02:00:22","\u003Cp align=\"center\">\n\u003Cimg alt=\"SiYuan\" src=\"https:\u002F\u002Fb3log.org\u002Fimages\u002Fbrand\u002Fsiyuan-128.png\">\n\u003Cbr>\n\u003Cem>Refactor your thinking\u003C\u002Fem>\n\u003Cbr>\u003Cbr>\n\u003Ca title=\"Build Status\" target=\"_blank\" href=\"https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fsiyuan\u002Factions\u002Fworkflows\u002Fci.yml\">\u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Factions\u002Fworkflow\u002Fstatus\u002Fsiyuan-note\u002Fsiyuan\u002Fcd.yml?style=flat-square\">\u003C\u002Fa>\n\u003Ca title=\"Releases\" target=\"_blank\" href=\"https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fsiyuan\u002Freleases\">\u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Frelease\u002Fsiyuan-note\u002Fsiyuan.svg?style=flat-square&color=9CF\">\u003C\u002Fa>\n\u003Ca title=\"Downloads\" target=\"_blank\" href=\"https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fsiyuan\u002Freleases\">\u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fdownloads\u002Fsiyuan-note\u002Fsiyuan\u002Ftotal.svg?style=flat-square&color=blueviolet\">\u003C\u002Fa>\n\u003Cbr>\n\u003Ca title=\"Docker Pulls\" target=\"_blank\" href=\"https:\u002F\u002Fhub.docker.com\u002Fr\u002Fb3log\u002Fsiyuan\">\u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fdocker\u002Fpulls\u002Fb3log\u002Fsiyuan.svg?style=flat-square&color=green\">\u003C\u002Fa>\n\u003Ca title=\"Docker Image Size\" target=\"_blank\" href=\"https:\u002F\u002Fhub.docker.com\u002Fr\u002Fb3log\u002Fsiyuan\">\u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fdocker\u002Fimage-size\u002Fb3log\u002Fsiyuan.svg?style=flat-square&color=ff96b4\">\u003C\u002Fa>\n\u003Ca title=\"Hits\" target=\"_blank\" href=\"https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fsiyuan\">\u003Cimg src=\"https:\u002F\u002Fhits.b3log.org\u002Fsiyuan-note\u002Fsiyuan.svg\">\u003C\u002Fa>\n\u003Cbr>\n\u003Ca title=\"AGPLv3\" target=\"_blank\" href=\"https:\u002F\u002Fwww.gnu.org\u002Flicenses\u002Fagpl-3.0.txt\">\u003Cimg src=\"http:\u002F\u002Fimg.shields.io\u002Fbadge\u002Flicense-AGPLv3-orange.svg?style=flat-square\">\u003C\u002Fa>\n\u003Ca title=\"Code Size\" target=\"_blank\" href=\"https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fsiyuan\">\u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Flanguages\u002Fcode-size\u002Fsiyuan-note\u002Fsiyuan.svg?style=flat-square&color=yellow\">\u003C\u002Fa>\n\u003Ca title=\"GitHub Pull Requests\" target=\"_blank\" href=\"https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fsiyuan\u002Fpulls\">\u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fissues-pr-closed\u002Fsiyuan-note\u002Fsiyuan.svg?style=flat-square&color=FF9966\">\u003C\u002Fa>\n\u003Cbr>\n\u003Ca title=\"GitHub Commits\" target=\"_blank\" href=\"https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fsiyuan\u002Fcommits\u002Fmaster\">\u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fcommit-activity\u002Fm\u002Fsiyuan-note\u002Fsiyuan.svg?style=flat-square\">\u003C\u002Fa>\n\u003Ca title=\"Last Commit\" target=\"_blank\" href=\"https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fsiyuan\u002Fcommits\u002Fmaster\">\u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Flast-commit\u002Fsiyuan-note\u002Fsiyuan.svg?style=flat-square&color=FF9900\">\u003C\u002Fa>\n\u003Cbr>\u003Cbr>\n\u003Ca title=\"Twitter\" target=\"_blank\" href=\"https:\u002F\u002Ftwitter.com\u002Fb3logos\">\u003Cimg alt=\"Twitter Follow\" src=\"https:\u002F\u002Fimg.shields.io\u002Ftwitter\u002Ffollow\u002Fb3logos?label=Follow&style=social\">\u003C\u002Fa>\n\u003Ca title=\"Discord\" target=\"_blank\" href=\"https:\u002F\u002Fdiscord.gg\u002FdmMbCqVX7G\">\u003Cimg alt=\"Chat on Discord\" src=\"https:\u002F\u002Fimg.shields.io\u002Fdiscord\u002F808152298789666826?label=Discord&logo=Discord&style=social\">\u003C\u002Fa>\n\u003Cbr>\u003Cbr>\n\u003Ca href=\"https:\u002F\u002Ftrendshift.io\u002Frepositories\u002F3949\" target=\"_blank\">\u003Cimg src=\"https:\u002F\u002Ftrendshift.io\u002Fapi\u002Fbadge\u002Frepositories\u002F3949\" alt=\"siyuan-note%2Fsiyuan | Trendshift\" style=\"width: 250px; height: 55px;\" width=\"250\" height=\"55\"\u002F>\u003C\u002Fa>\n\u003C\u002Fp>\n\n\u003Cp align=\"center\">\n\u003Cb>English\u003C\u002Fb>\n| \u003Ca href=\"README_zh_CN.md\">中文\u003C\u002Fa>\n| \u003Ca href=\"README_ja_JP.md\">日本語\u003C\u002Fa>\n| \u003Ca href=\"README_tr_TR.md\">Türkçe\u003C\u002Fa>\n\u003C\u002Fp>\n\n---\n\n## Table of Contents\n\n* [💡 Introduction](#-introduction)\n* [🔮 Features](#-features)\n* [🏗️ Architecture and Ecosystem](#-architecture-and-ecosystem)\n* [🌟 Star History](#-star-history)\n* [🗺️ Roadmap](#️-roadmap)\n* [🚀 Download Setup](#-download-setup)\n  * [App Market](#app-market)\n  * [Installation Package](#installation-package)\n  * [Package Manager](#package-manager)\n  * [Docker Hosting](#docker-hosting)\n  * [Unraid Hosting](#unraid-hosting)\n  * [TrueNAS Hosting](#TrueNAS-hosting)\n  * [Insider Preview](#insider-preview)\n* [🏘️ Community](#️-community)\n* [🛠️ Development Guide](#️-development-guide)\n* [❓ FAQ](#-faq)\n  * [How does SiYuan store data?](#how-does-siyuan-store-data)\n  * [Does it support data synchronization through a third-party sync disk?](#does-it-support-data-synchronization-through-a-third-party-sync-disk)\n  * [Is SiYuan open source?](#is-siyuan-open-source)\n  * [How to upgrade to a new version?](#how-to-upgrade-to-a-new-version)\n  * [What if some blocks (such as paragraph blocks in list items) cannot find the block icon?](#what-if-some-blocks-such-as-paragraph-blocks-in-list-items-cannot-find-the-block-icon)\n  * [What should I do if the data repo key is lost?](#what-should-i-do-if-the-data-repo-key-is-lost)\n  * [Do I need to pay for it?](#do-i-need-to-pay-for-it)\n* [🙏 Acknowledgement](#-acknowledgement)\n  * [Contributors](#contributors)\n\n---\n\n## 💡 Introduction\n\nSiYuan is a privacy-first personal knowledge management system, support fine-grained block-level reference and Markdown\nWYSIWYG.\n\nWelcome to [SiYuan English Discussion Forum](https:\u002F\u002Fliuyun.io) to learn more.\n\n![feature0.png](https:\u002F\u002Fb3logfile.com\u002Ffile\u002F2025\u002F11\u002Ffeature0-GfbhEqf.png)\n\n![feature51.png](https:\u002F\u002Fb3logfile.com\u002Ffile\u002F2025\u002F11\u002Ffeature5-1-7DJSfEP.png)\n\n## 🔮 Features\n\nMost features are free, even for commercial use.\n\n* Content block\n  * Block-level reference and two-way links\n  * Custom attributes\n  * SQL query embed\n  * Protocol `siyuan:\u002F\u002F`\n* Editor\n  * Block-style\n  * Markdown WYSIWYG\n  * List outline\n  * Block zoom-in\n  * Million-word large document editing\n  * Mathematical formulas, charts, flowcharts, Gantt charts, timing charts, staffs, etc.\n  * Web clipping\n  * PDF Annotation link\n* Export\n  * Block ref and embed\n  * Standard Markdown with assets\n  * PDF, Word and HTML\n  * Copy to WeChat MP, Zhihu and Yuque\n* Database\n  * Table view\n* Flashcard spaced repetition\n* AI writing and Q\u002FA chat via OpenAI API\n* Tesseract OCR \n* Multi-tab, drag and drop to split screen\n* Template snippet\n* JavaScript\u002FCSS snippet\n* Android\u002FiOS\u002FHarmonyOS App\n* Docker deployment\n* [API](https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fsiyuan\u002Fblob\u002Fmaster\u002FAPI.md)\n* Community marketplace\n\nSome features are only available to paid members, for more details please refer to [Pricing](https:\u002F\u002Fb3log.org\u002Fsiyuan\u002Fen\u002Fpricing.html).\n\n## 🏗️ Architecture and Ecosystem\n\n![SiYuan Arch](https:\u002F\u002Fb3logfile.com\u002Ffile\u002F2023\u002F05\u002FSiYuan_Arch-Sgu8vXT.png \"SiYuan Arch\")\n\n| Project                                                  | Description           | Forks                                                                           | Stars                                                                                | \n|----------------------------------------------------------|-----------------------|---------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|\n| [lute](https:\u002F\u002Fgithub.com\u002F88250\u002Flute)                    | Editor engine         | ![GitHub forks](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fforks\u002F88250\u002Flute)                 | ![GitHub Repo stars](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fstars\u002F88250\u002Flute)                 |\n| [chrome](https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fsiyuan-chrome)   | Chrome\u002FEdge extension | ![GitHub forks](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fforks\u002Fsiyuan-note\u002Fsiyuan-chrome)  | ![GitHub Repo stars](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fstars\u002Fsiyuan-note\u002Fsiyuan-chrome)  |\n| [bazaar](https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fbazaar)          | Community marketplace | ![GitHub forks](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fforks\u002Fsiyuan-note\u002Fbazaar)         | ![GitHub Repo stars](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fstars\u002Fsiyuan-note\u002Fbazaar)         |\n| [dejavu](https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fdejavu)          | Data repo             | ![GitHub forks](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fforks\u002Fsiyuan-note\u002Fdejavu)         | ![GitHub Repo stars](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fstars\u002Fsiyuan-note\u002Fdejavu)         |\n| [petal](https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fpetal)            | Plugin API            | ![GitHub forks](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fforks\u002Fsiyuan-note\u002Fpetal)          | ![GitHub Repo stars](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fstars\u002Fsiyuan-note\u002Fpetal)          |\n| [android](https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fsiyuan-android) | Android App           | ![GitHub forks](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fforks\u002Fsiyuan-note\u002Fsiyuan-android) | ![GitHub Repo stars](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fstars\u002Fsiyuan-note\u002Fsiyuan-android) |\n| [ios](https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fsiyuan-ios)         | iOS App               | ![GitHub forks](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fforks\u002Fsiyuan-note\u002Fsiyuan-ios)     | ![GitHub Repo stars](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fstars\u002Fsiyuan-note\u002Fsiyuan-ios)     |\n| [harmony](https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fsiyuan-harmony) | HarmonyOS App         | ![GitHub forks](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fforks\u002Fsiyuan-note\u002Fsiyuan-harmony) | ![GitHub Repo stars](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fstars\u002Fsiyuan-note\u002Fsiyuan-harmony) |\n| [riff](https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Friff)              | Spaced repetition     | ![GitHub forks](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fforks\u002Fsiyuan-note\u002Friff)           | ![GitHub Repo stars](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fstars\u002Fsiyuan-note\u002Friff)           |\n\n## 🌟 Star History\n\n\u003Ca href=\"https:\u002F\u002Fstar-history.com\u002F#siyuan-note\u002Fsiyuan&Date\">\n \u003Cpicture>\n   \u003Csource media=\"(prefers-color-scheme: dark)\" srcset=\"https:\u002F\u002Fapi.star-history.com\u002Fsvg?repos=siyuan-note\u002Fsiyuan&type=Date&theme=dark\" \u002F>\n   \u003Csource media=\"(prefers-color-scheme: light)\" srcset=\"https:\u002F\u002Fapi.star-history.com\u002Fsvg?repos=siyuan-note\u002Fsiyuan&type=Date\" \u002F>\n   \u003Cimg alt=\"Star History Chart\" src=\"https:\u002F\u002Fapi.star-history.com\u002Fsvg?repos=siyuan-note\u002Fsiyuan&type=Date\" \u002F>\n \u003C\u002Fpicture>\n\u003C\u002Fa>\n\n## 🗺️ Roadmap\n\n* [SiYuan development plan and progress](https:\u002F\u002Fgithub.com\u002Forgs\u002Fsiyuan-note\u002Fprojects\u002F1)\n* [SiYuan changelog](CHANGELOG.md)\n\n## 🚀 Download Setup\n\nIt is recommended to give priority to installing through the application market on the desktop and mobile, so that you can upgrade the version with one click in the future.\n\n### App Market\n\nMobile:\n\n* [App Store](https:\u002F\u002Fapps.apple.com\u002Fus\u002Fapp\u002Fsiyuan\u002Fid1583226508)\n* [Google Play](https:\u002F\u002Fplay.google.com\u002Fstore\u002Fapps\u002Fdetails?id=org.b3log.siyuan)\n* [F-Droid](https:\u002F\u002Ff-droid.org\u002Fpackages\u002Forg.b3log.siyuan)\n\nDesktop:\n\n* [Microsoft Store](https:\u002F\u002Fapps.microsoft.com\u002Fdetail\u002F9p7hpmxp73k4)\n\n### Installation Package\n\n* [B3log](https:\u002F\u002Fb3log.org\u002Fsiyuan\u002Fen\u002Fdownload.html)\n* [GitHub](https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fsiyuan\u002Freleases)\n\n### Package Manager\n\n#### `siyuan`\n\n[![Packaging status](https:\u002F\u002Frepology.org\u002Fbadge\u002Fvertical-allrepos\u002Fsiyuan.svg)](https:\u002F\u002Frepology.org\u002Fproject\u002Fsiyuan\u002Fversions)\n\n#### `siyuan-note`\n\n[![Packaging status](https:\u002F\u002Frepology.org\u002Fbadge\u002Fvertical-allrepos\u002Fsiyuan-note.svg)](https:\u002F\u002Frepology.org\u002Fproject\u002Fsiyuan-note\u002Fversions)\n\n### Docker Hosting\n\n\u003Cdetails>\n\u003Csummary>Docker Deployment\u003C\u002Fsummary>\n\n#### Overview\n\nThe easiest way to serve SiYuan on a server is to deploy it through Docker.\n\n* Image name `b3log\u002Fsiyuan`\n* [Image URL](https:\u002F\u002Fhub.docker.com\u002Fr\u002Fb3log\u002Fsiyuan)\n\n#### File structure\n\nThe overall program is located under `\u002Fopt\u002Fsiyuan\u002F`, which is basically the structure under the resources folder of the Electron installation package:\n\n* appearance: icon, theme, languages\n* guide: user guide document\n* stage: interface and static resources\n* kernel: kernel program\n\n#### Entrypoint\n\nThe entry point is set when building the Docker image: `ENTRYPOINT [\"\u002Fopt\u002Fsiyuan\u002Fentrypoint.sh\"]`. This script allows changing the `PUID` and `PGID` of the user that will run inside the container. This is especially relevant to solve permission issues when mounting directories from the host. The `PUID` (User ID) and `PGID` (Group ID) can be passed as environment variables, making it easier to ensure correct permissions when accessing host-mounted directories.\n\nUse the following parameters when running the container with `docker run b3log\u002Fsiyuan`:\n\n* `--workspace`: Specifies the workspace folder path, mounted to the container via `-v` on the host\n* `--accessAuthCode`: Specifies the access authorization code\n\nMore parameters can be found using `--help`. Here’s an example of a startup command with the new environment variables:\n\n```bash\ndocker run -d \\\n  -v workspace_dir_host:workspace_dir_container \\\n  -p 6806:6806 \\\n  -e PUID=1001 -e PGID=1002 \\\n  b3log\u002Fsiyuan \\\n  --workspace=workspace_dir_container \\\n  --accessAuthCode=xxx\n```\n\n* `PUID`: Custom user ID (optional, defaults to `1000` if not provided)\n* `PGID`: Custom group ID (optional, defaults to `1000` if not provided)\n* `workspace_dir_host`: The workspace folder path on the host\n* `workspace_dir_container`: The path of the workspace folder in the container, as specified in `--workspace`\n  * In alternative, it's possible to set the path via the `SIYUAN_WORKSPACE_PATH` env variable. The commandline will always have the priority, if both are set\n* `accessAuthCode`: Access authorization code (please **be sure to modify**, otherwise anyone can access your data)\n  * In alternative, it's possible to set the auth code via the `SIYUAN_ACCESS_AUTH_CODE` env variable. The commandline will always have the priority, if both are set\n  * To disable the Access authorization code set the env variable `SIYUAN_ACCESS_AUTH_CODE_BYPASS=true`\n\nTo simplify things, it is recommended to configure the workspace folder path to be consistent on the host and container, such as having both `workspace_dir_host` and `workspace_dir_container` configured as `\u002Fsiyuan\u002Fworkspace`. The corresponding startup command would be:\n\n```bash\ndocker run -d \\\n  -v \u002Fsiyuan\u002Fworkspace:\u002Fsiyuan\u002Fworkspace \\\n  -p 6806:6806 \\\n  -e PUID=1001 -e PGID=1002 \\\n  b3log\u002Fsiyuan \\\n  --workspace=\u002Fsiyuan\u002Fworkspace\u002F \\\n  --accessAuthCode=xxx\n```\n\n#### Docker Compose\n\nFor users running Siyuan with Docker Compose, the environment variables `PUID` and `PGID` can be passed to customize the user and group IDs. Here's an example of a Docker Compose configuration:\n\n```yaml\nversion: \"3.9\"\nservices:\n  main:\n    image: b3log\u002Fsiyuan\n    command: ['--workspace=\u002Fsiyuan\u002Fworkspace\u002F', '--accessAuthCode=${AuthCode}']\n    ports:\n      - 6806:6806\n    volumes:\n      - \u002Fsiyuan\u002Fworkspace:\u002Fsiyuan\u002Fworkspace\n    restart: unless-stopped\n    environment:\n      # A list of time zone identifiers can be found at https:\u002F\u002Fen.wikipedia.org\u002Fwiki\u002FList_of_tz_database_time_zones\n      - TZ=${YOUR_TIME_ZONE}\n      - PUID=${YOUR_USER_PUID}  # Customize user ID\n      - PGID=${YOUR_USER_PGID}  # Customize group ID\n```\n\nIn this setup:\n\n* `PUID` and `PGID` are set dynamically and passed to the container\n* If these variables are not provided, the default `1000` will be used\n\nBy specifying `PUID` and `PGID` in the environment, you avoid the need to explicitly set the `user` directive (`user: '1000:1000'`) in the compose file. The container will dynamically adjust the user and group based on these environment variables at startup.\n\n#### User Permissions\n\nIn the image, the `entrypoint.sh` script ensures the creation of the `siyuan` user and group with the specified `PUID` and `PGID`. Therefore, when the host creates a workspace folder, pay attention to setting the user and group ownership of the folder to match the `PUID` and `PGID` you plan to use. For example:\n\n```bash\nchown -R 1001:1002 \u002Fsiyuan\u002Fworkspace\n```\n\nIf you use custom `PUID` and `PGID` values, the entrypoint script will ensure that the correct user and group are created inside the container, and ownership of mounted volumes will be adjusted accordingly. There’s no need to manually pass `-u` in `docker run` or `docker-compose` as the environment variables will handle the customization.\n\n#### Hidden port\n\nUse NGINX reverse proxy to hide port 6806, please note:\n\n* Configure WebSocket reverse proxy `\u002Fws`\n\n#### Note\n\n* Be sure to confirm the correctness of the mounted volume, otherwise the data will be lost after the container is deleted\n* Do not use URL rewriting for redirection, otherwise there may be problems with authentication, it is recommended to configure a reverse proxy\n* If you encounter permission issues, verify that the `PUID` and `PGID` environment variables match the ownership of the mounted directories on your host system\n\n#### Limitations\n\n* Does not support desktop and mobile application connections, only supports use on browsers\n* Export to PDF, HTML and Word formats is not supported\n* Import Markdown file is not supported\n\n\u003C\u002Fdetails>\n\n### Unraid Hosting\n\n\u003Cdetails>\n\u003Csummary>Unraid Deployment\u003C\u002Fsummary>\n\nNote: First run `chown -R 1000:1000 \u002Fmnt\u002Fuser\u002Fappdata\u002Fsiyuan` in the terminal\n\nTemplate reference:\n\n```\nWeb UI: 6806\nContainer Port: 6806\nContainer Path: \u002Fhome\u002Fsiyuan\nHost path: \u002Fmnt\u002Fuser\u002Fappdata\u002Fsiyuan\nPUID: 1000\nPGID: 1000\nPublish parameters: --accessAuthCode=******(Access authorization code)\n```\n\n\u003C\u002Fdetails>\n\n### TrueNAS Hosting\n\n\u003Cdetails>\n\u003Csummary>TrueNAS Deployment\u003C\u002Fsummary>\n\nNote: First run below commands in the TrueNAS Shell. please update `Pool_1\u002FApps_Data\u002Fsiyuan to match your dataset for Apps.\n\n```shell\nzfs create Pool_1\u002FApps_Data\u002Fsiyuan\nchown -R 1001:1002 \u002Fmnt\u002FPool_1\u002FApps_Data\u002Fsiyuan\nchmod 755 \u002Fmnt\u002FPool_1\u002FApps_Data\u002Fsiyuan\n```\n\nNavigate to Apps - DiscoverApps - More Options(on top right, besies Custom App) - Install via YAML\n\nTemplate reference:\n\n```yaml\nservices:\n  siyuan:\n    image: b3log\u002Fsiyuan\n    container_name: siyuan\n    command: ['--workspace=\u002Fsiyuan\u002Fworkspace\u002F', '--accessAuthCode=2222']\n    ports:\n      - 6806:6806\n    volumes:\n      - \u002Fmnt\u002FPool_1\u002FApps_Data\u002Fsiyuan:\u002Fsiyuan\u002Fworkspace  # Adjust to your dataset path \n    restart: unless-stopped\n    environment:\n      - TZ=America\u002FLos_Angeles  # Replace with your timezone if needed\n      - PUID=1001\n      - PGID=1002\n```\n\n\u003C\u002Fdetails>\n\n### Insider Preview\n\nWe release insider preview before major updates, please visit [https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Finsider](https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Finsider).\n\n## 🏘️ Community\n\n* [English Discussion Forum](https:\u002F\u002Fliuyun.io)\n* [User community summary](https:\u002F\u002Fliuyun.io\u002Farticle\u002F1687779743723)\n* [Awesome SiYuan](https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fawesome)\n\n## 🛠️ Development Guide\n\nSee [Development Guide](https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fsiyuan\u002Fblob\u002Fmaster\u002F.github\u002FCONTRIBUTING.md).\n\n## ❓ FAQ\n\n### How does SiYuan store data?\n\nThe data is saved in the workspace folder, in the workspace data folder:\n\n* `assets` is used to save all inserted assets\n* `emojis` is used to save emoji images\n* `snippets` is used to save code snippets\n* `storage` is used to save query conditions, layouts and flashcards, etc.\n* `templates` is used to save template snippets\n* `widgets` is used to save widgets\n* `plugins` is used to save plugins\n* `public` is used to save public data\n* The rest of the folders are the notebook folders created by the user, files with the suffix of `.sy` in the notebook folder are used to save the document data, and the data format is JSON\n\n### Does it support data synchronization through a third-party sync disk?\n\nData synchronization through third-party synchronization disks is not supported, otherwise data may be corrupted.\n\nAlthough it does not support third-party sync disks, it supports connect with third-party cloud storage (Member's privileges).\n\nIn addition, you can also consider manually exporting and importing data to achieve data synchronization:\n\n* Desktop: \u003Ckbd>Settings\u003C\u002Fkbd> - \u003Ckbd>Export\u003C\u002Fkbd> - \u003Ckbd>Export Data\u003C\u002Fkbd> \u002F \u003Ckbd>Import Data\u003C\u002Fkbd>\n* Mobile: \u003Ckbd>Right column\u003C\u002Fkbd> - \u003Ckbd>About\u003C\u002Fkbd> - \u003Ckbd>Export Data\u003C\u002Fkbd> \u002F \u003Ckbd>Import Data\u003C\u002Fkbd>\n\n### Is SiYuan open source?\n\nSiYuan is completely open source, and contributions are welcome:\n\n* [User Interface and Kernel](https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fsiyuan)\n* [Android](https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fsiyuan-android)\n* [iOS](https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fsiyuan-ios)\n* [HarmonyOS](https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fsiyuan-harmony)\n* [Chrome Clipping Extension](https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fsiyuan-chrome)\n\nFor more details, please refer to [Development Guide](https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fsiyuan\u002Fblob\u002Fmaster\u002F.github\u002FCONTRIBUTING.md).\n\n### How to upgrade to a new version?\n\n* If installed via app store, please update via app store\n* If it is installed through the installation package on the desktop, you can open the option of \u003Ckbd>Settings\u003C\u002Fkbd> - \u003Ckbd>About\u003C\u002Fkbd> - \u003Ckbd>Automatically download update installation package\u003C\u002Fkbd>, so that SiYuan will automatically download The latest version of the installation package and prompts to install\n* If it is installed by manual installation package, please download the installation package again to install\n\nYou can \u003Ckbd>Check update\u003C\u002Fkbd> in \u003Ckbd>Settings\u003C\u002Fkbd> - \u003Ckbd>About\u003C\u002Fkbd> - \u003Ckbd>Current Version\u003C\u002Fkbd>, or pay attention to [Official Download](https:\u002F\u002Fb3log.org\u002Fsiyuan\u002Fen\u002Fdownload.html) or [GitHub Releases](https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fsiyuan\u002Freleases) to get the new version.\n\n### What if some blocks (such as paragraph blocks in list items) cannot find the block icon?\n\nThe first sub-block under the list item is the block icon omitted. You can move the cursor into this block and trigger its block menu with \u003Ckbd>Ctrl+\u002F\u003C\u002Fkbd> .\n\n### What should I do if the data repo key is lost?\n\n* If the data repo key is correctly initialized on multiple devices before, the key is the same on all devices and can be set in \u003Ckbd>Settings\u003C\u002Fkbd> - \u003Ckbd>About\u003C\u002Fkbd> - \u003Ckbd>Data repo key\u003C\u002Fkbd> - \u003Ckbd>Copy key string\u003C\u002Fkbd> retrieve\n* If it has not been configured correctly before (for example, the keys on multiple devices are inconsistent) or all devices are unavailable and the key string cannot be obtained, you can reset the key by following the steps below:\n\n  1. Manually back up the data, you can use \u003Ckbd>Export Data\u003C\u002Fkbd> or directly copy the \u003Ckbd>workspace\u002Fdata\u002F\u003C\u002Fkbd> folder on the file system\n  2. \u003Ckbd>Settings\u003C\u002Fkbd> - \u003Ckbd>About\u003C\u002Fkbd> - \u003Ckbd>Data rep key\u003C\u002Fkbd> - \u003Ckbd>Reset data repo\u003C\u002Fkbd>\n  3. Reinitialize the data repo key. After initializing the key on one device, other devices import the key\n  4. The cloud uses the new synchronization directory, the old synchronization directory is no longer available and can be deleted\n  5. The existing cloud snapshots are no longer available and can be deleted\n\n### Do I need to pay for it?\n\nMost features are free, even for commercial use.\n\nMember's privileges can only be used after payment, please refer to [Pricing](https:\u002F\u002Fb3log.org\u002Fsiyuan\u002Fen\u002Fpricing.html).\n\n## 🙏 Acknowledgement\n\nThe birth of SiYuan is inseparable from many open source projects and contributors, please refer to the project source code kernel\u002Fgo.mod, app\u002Fpackage.json and project homepage.\n\nThe growth of SiYuan is inseparable from user feedback and promotion, thank you for everyone's help to SiYuan ❤️\n\n### Contributors\n\nWelcome to join us and contribute code to SiYuan together.\n\n\u003Ca href=\"https:\u002F\u002Fgithub.com\u002Fsiyuan-note\u002Fsiyuan\u002Fgraphs\u002Fcontributors\">\n   \u003Cimg src=\"https:\u002F\u002Fcontrib.rocks\u002Fimage?repo=siyuan-note\u002Fsiyuan\" \u002F>\n\u003C\u002Fa>\n","思源笔记是一款注重隐私保护、可自托管的全开源个人知识管理软件，采用TypeScript和Go语言编写。它支持Markdown语法，具备强大的笔记编辑与组织功能，如双向链接、块引用等，并集成了OCR识别、PDF阅读等多种实用工具。此外，该软件还提供了丰富的插件系统以扩展其功能性。适合需要构建个人知识库、进行深度学习或研究工作的用户使用，在确保数据安全的同时享受高效便捷的知识整理体验。",2,"2026-06-11 02:41:14","top_all"]