siyuan
1.0.0
重建你的思維
中文 | 日本語
siyuan是一個隱私優先的個人知識管理系統，支援細粒度的區塊級引用和Markdown所見即所得。
歡迎來到siyuan英語討論論壇以了解更多資訊。
大多數功能都是免費的，即使用於商業用途也是如此。
siyuan ://部分功能僅供付費會員使用，更多詳情請參閱定價。
| 專案 | 描述 | 叉子 | 星星 |
|---|---|---|---|
| 琵琶 | 編輯器引擎 | ||
| 鉻合金 | Chrome/Edge 擴充 | ||
| 市場 | 社區市場 | ||
| 似曾相識 | 資料倉儲 | ||
| 花瓣 | 插件API | ||
| 安卓 | 安卓應用程式 | ||
| IOS | iOS應用程式 | ||
| 即興演奏 | 間隔重複 |
建議桌面端和行動端優先透過應用程式市場安裝，方便日後一鍵升級版本。
移動的：
桌面：
在伺服器上提供siyuan最簡單的方法是透過 Docker 進行部署。
b3log/ siyuan整體程式位於/opt/ siyuan /下，基本上就是Electron安裝包的resources資料夾下的結構：
入口點在建置 Docker 映像時設定： ENTRYPOINT ["/opt/ siyuan /entrypoint.sh"] 。此腳本允許更改將在容器內執行的使用者的PUID和PGID 。這對於解決從主機掛載目錄時的權限問題尤其重要。 PUID （使用者ID）和PGID （群組ID）可以作為環境變數傳遞，從而在存取主機安裝的目錄時更容易確保正確的權限。
使用docker run b3log/ siyuan運行容器時使用下列參數：
--workspace ：指定工作空間資料夾路徑，透過主機上的-v掛載到容器--accessAuthCode : 指定存取授權碼可以使用--help找到更多參數。以下是使用新環境變數的啟動命令的範例：
docker run -d
-v workspace_dir_host:workspace_dir_container
-p 6806:6806
-e PUID=1001 -e PGID=1002
b3log/ siyuan
--workspace=workspace_dir_container
--accessAuthCode=xxxPUID ：自訂使用者 ID（可選，如果未提供則預設為1000 ）PGID ：自訂群組ID（可選，如果不提供則預設為1000 ）workspace_dir_host ：主機上的工作區資料夾路徑workspace_dir_container ：容器中工作空間資料夾的路徑，如--workspace指定accessAuthCode ：存取授權碼（請務必修改，否則任何人都可以存取您的資料）為了簡化，建議將工作空間資料夾路徑配置為在主機和容器上保持一致，例如將workspace_dir_host和workspace_dir_container都配置為/ siyuan /workspace 。相應的啟動命令為：
docker run -d
-v / siyuan /workspace:/ siyuan /workspace
-p 6806:6806
-e PUID=1001 -e PGID=1002
b3log/ siyuan
--workspace=/ siyuan /workspace/
--accessAuthCode=xxx對於使用 Docker Compose 運行siyuan的用戶，可以傳遞環境變數PUID和PGID來自訂用戶和群組 ID。以下是 Docker Compose 配置的範例：
version : " 3.9 "
services :
main :
image : b3log/ siyuan
command : ['--workspace=/ siyuan /workspace/', '--accessAuthCode=${AuthCode}']
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=${YOUR_TIME_ZONE}
- PUID=${YOUR_USER_PUID} # Customize user ID
- PGID=${YOUR_USER_PGID} # Customize group ID在此設定中：
PUID和PGID動態設定並傳遞給容器1000透過在環境中指定PUID和PGID ，您無需在 compose 檔案中明確設定user指令 ( user: '1000:1000' )。容器在啟動時會根據這些環境變數動態調整使用者和群組。
在該映像中， entrypoint.sh腳本確保使用指定的PUID和PGID來建立siyuan使用者和群組。因此，當主機建立工作區資料夾時，請注意設定該資料夾的使用者和群組擁有權，以符合您計劃使用的PUID和PGID 。例如：
chown -R 1001:1002 / siyuan /workspace如果您使用自訂PUID和PGID值，入口點腳本將確保在容器內建立正確的使用者和群組，並且已安裝磁碟區的所有權將相應調整。無需在docker run或docker-compose中手動傳遞-u ，因為環境變數將處理自訂。
使用NGINX反向代理隱藏6806端口，請注意：
/ws PUID和PGID環境變數是否與主機系統上已安裝目錄的擁有權相符注意：首先在終端機執行chown -R 1000:1000 /mnt/user/appdata/ siyuan
模板參考：
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)
我們在重大更新之前發布了 Insider 預覽版，請造訪 https://github.com/siyuan-note/insider。
請參閱開髮指南。
資料保存在工作區資料夾中，在工作區資料資料夾中：
assets用於保存所有插入的資源emojis用於保存表情符號圖像snippets用於保存程式碼片段storage用於保存查詢條件、佈局和抽認卡等。templates用於保存模板片段widgets用於保存小部件plugins用於保存插件public用於保存公共數據.sy的檔案用於保存文件數據，資料格式為JSON不支援透過第三方同步磁碟進行資料同步，否則可能導致資料損壞。
雖然不支援第三方同步盤，但支援連接第三方雲端儲存（會員特權）。
另外，還可以考慮手動匯出和匯入數據，實現數據同步：
siyuan完全開源，歡迎貢獻：
更多詳情請參考開髮指南。
您可以在設定-關於-當前版本中查看更新，或追蹤官方下載或 GitHub Releases 以取得新版本。
列表項目下的第一個子區塊是省略的區塊圖示。您可以將遊標移到該區塊並使用Ctrl+/觸發其區塊選單。
如果先前在多個裝置上正確初始化了資料儲存庫金鑰，則該金鑰在所有裝置上都是相同的，可以在「設定」 - 「關於」 - 「資料儲存庫金鑰」 -「複製密鑰字串檢索”中設定
如果之前沒有正確配置（例如多台裝置上的金鑰不一致）或所有裝置都不可用而無法取得金鑰串，您可以按照下列步驟重設金鑰：
大多數功能都是免費的，即使用於商業用途也是如此。
會員權益需付款後才能使用，請參閱定價。
siyuan的誕生離不開眾多開源專案與貢獻者，請參考專案原始碼kernel/go.mod、app/package.json以及專案首頁。
siyuan的成長離不開用戶的回饋與推廣，感謝大家對siyuan的幫助❤️
歡迎加入我們，共同為siyuan貢獻程式碼。
