下一代的个人知识管理系统，你的数字花园。
Refactor your thinking
SiYuan is a privacy-first personal knowledge management system, support fine-grained block-level reference and Markdown WYSIWYG.
Welcome to SiYuan English Discussion Forum to learn more.
Most features are free, even for commercial use.
siyuan://
Some features are only available to paid members, for more details please refer to Pricing.
| Project | Description | Forks | Stars |
|---|---|---|---|
| lute | Editor engine |  |
 |
| chrome | Chrome/Edge extension |  |
 |
| bazaar | Community marketplace |  |
 |
| dejavu | Data repo |  |
 |
| petal | Plugin API |  |
 |
| android | Android App |  |
 |
| ios | iOS App |  |
 |
| riff | Spaced repetition |  |
 |
It 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.
Mobile:
Desktop:
The easiest way to serve SiYuan on a server is to deploy it through Docker.
b3log/siyuan
The overall program is located under /opt/siyuan/, which is basically the structure under the resources folder of the Electron installation package:
The entry point is set when building the Docker image: ENTRYPOINT ["/opt/siyuan/kernel" ], use docker run b3log/siyuan with parameters to start:
--workspace: Specifies the workspace folder path, mounted to the container via -v on the host--accessAuthCode: Specifies the access authorization codeMore parameters can refer to --help. The following is an example of a startup command:
docker run -d -v workspace_dir_host:workspace_dir_container -p 6806:6806 b3log/siyuan --workspace=workspace_dir_container --accessAuthCode=xxx
workspace_dir_host: The workspace folder path on the hostworkspace_dir_container: The path of the workspace folder in the container, which is the same as specified in --workspace
accessAuthCode: Access authorization code, please be sure to modify, otherwise anyone can read and write your dataTo simplify, it is recommended to configure the workspace folder path to be consistent on the host and container, such as: workspace_dir_host and workspace_dir_container are configured as /siyuan/workspace, the corresponding startup commands is:
docker run -d -v /siyuan/workspace:/siyuan/workspace -p 6806:6806 -u 1000:1000 b3log/siyuan --workspace=/siyuan/workspace/ --accessAuthCode=xxx
Alternatively, see below for an example Docker Compose file:
version: "3.9"
services:
main:
image: b3log/siyuan
command: ['--workspace=/siyuan/workspace/', '--accessAuthCode=${AuthCode}']
user: '1000:1000'
ports:
- 6806:6806
volumes:
- /siyuan/workspace:/siyuan/workspace
restart: unless-stopped
environment:
# A list of time zone identifiers can be found at https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
- TZ=${TimeZone}
In the image, the normal user siyuan (uid 1000/gid 1000) created by default is used to start the kernel process. Therefore, when the host creates a workspace folder, please pay attention to setting the user group of the folder: chown -R 1000:1000 /siyuan/workspace. The parameter -u 1000:1000 is required when starting the container.
Use NGINX reverse proxy to hide port 6806, please note:
/ws
Note: First run chown -R 1000:1000 /mnt/user/appdata/siyuan in the terminal
Template reference:
Web UI: 6806
Container Port: 6806
Container Path: /home/siyuan
Host path: /mnt/user/appdata/siyuan
PUID: 1000
PGID: 1000
Publish parameters: --accessAuthCode=******(Access authorization code)
We release insider preview before major updates, please visit https://github.com/siyuan-note/insider.
See Development Guide.
The data is saved in the workspace folder, in the workspace data folder:
assets is used to save all inserted assetsemojis is used to save emoji imagessnippets is used to save code snippetsstorage is used to save query conditions, layouts and flashcards, etc.templates is used to save template snippetswidgets is used to save widgetsplugins is used to save pluginspublic is used to save public data.sy in the notebook folder are used to save the document data, and the data format is JSONData synchronization through third-party synchronization disks is not supported, otherwise data may be corrupted.
Although it does not support third-party sync disks, it supports connect with third-party cloud storage (Member's privileges).
In addition, you can also consider manually exporting and importing data to achieve data synchronization:
SiYuan is completely open source, and contributions are welcome:
For more details, please refer to Development Guide.
You can Check update in Settings - About - Current Version, or pay attention to Official Download or GitHub Releases to get the new version.
The 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 Ctrl+/ .
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 Settings - About - Data repo key - Copy key string retrieve
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:
Most features are free, even for commercial use.
Member's privileges can only be used after payment, please refer to Pricing.
The birth of SiYuan is inseparable from many open source projects and contributors, please refer to the project source code kernel/go.mod, app/package.json and project homepage.
The growth of SiYuan is inseparable from user feedback and promotion, thank you for everyone's help to SiYuan ❤️
Welcome to join us and contribute code to SiYuan together.
