siyuan-note/siyuan：README に基づく導入ガイド

siyuan-note/siyuan の README はプロジェクトを「A privacy-first, self-hosted, fully open source personal knowledge management software, written in typescript and golang.」と説明しています。ここではリポジトリで確認できる事実だけを整理します。star 数やバッジは注目度の手掛かりであり、品質の証明ではありません。「💡 Introduction」には次の説明があります。SiYuan is a privacy-first personal knowledge management system, supporting fine-grained block-level reference and Markdown WYSIWYG.。これは範囲の説明であり、本番検証の結果ではありません。

README の「Table of Contents」にある内容から、用途が合うかを先に判断できます。What if some blocks (such as paragraph blocks in list items) cannot find the block icon?。目的が違うなら、人気だけで採用する理由にはなりません。プロジェクト名やコマンドは原文のまま残し、一次資料へ戻って用語を確認できるようにしています。 README には次の確認可能な項目もあります。Does it support data synchronization through a third-party sync disk?。初回テストの材料にはなりますが、実際の環境での確認を省略する理由にはなりません。

動作の説明は「Do I need to pay for it?」など複数の箇所に分かれています。確認できる情報は次の通りです。Most features are free, even for commercial use.。書かれていない構成、性能、セキュリティを推測で補いません。導入時はディレクトリ、設定ファイル、release 履歴を確認してください。

初回導入は README の入口から始めます。確認できるコマンドは次の通りです。 docker run -d \ -v workspace_dir_host:workspace_dir_container \ -p 6806:6806 \ -e PUID=1001 -e PGID=1002 \ b3log/siyuan \ serve \ --workspace=workspace_dir_container \ --accessAuthCode=xxx 実行可能なコマンドがない場合は手順を作らず、「💡 Introduction」で依存関係、待受ポート、初回設定を確認します。

日常運用は公式文書の範囲に限ります。「🔮 Features」にはSome features are only available to paid members, for more details please refer to Pricing.とあります。設定、環境変数、権限、データ保存先は明記されたものだけを扱います。未記載の既定値は隔離環境で確認し、戻せる設定を保存してください。 同じ資料にはWhat should I do if the data repo key is lost?ともあります。