Repolode
perber

perber/leafwiki

SQLiteとディスク上のMarkdownファイルを使い、外部データベースなしで動く、単一のGoバイナリで構築できるセルフホスト型Wiki。

代替できる製品:ConfluenceNotion

スター
1,218
フォーク
102
未解決の Issue
48
最終コミット
5 時間前

これは何?

LeafWikiは、ランブック、エンジニアリングノート、ホームラボのドキュメントなど、構造化して長期保存する文書向けのセルフホスト型Wikiです。単一のGoバイナリとして提供され、メタデータにはSQLite、ページ本文にはデータディレクトリ内のMarkdownファイルを使うため、Node.js、Redis、Postgresの運用は不要です。ページは明示的なツリー構造で整理でき、順序は手動で設定します。バックアップはアプリを停止してデータディレクトリをコピーするだけです。

エディターにはライブプレビュー、キーボードショートカット、内部リンクのオートコンプリートが備わっています。ページではタグ、全文検索、バックリンク、リンク切れの監査を利用できます。Markdownの拡張機能として、テーブル、タスクリスト、コールアウト、折りたたみブロック、Mermaid図、KaTeX数式、PDFの埋め込みに対応しています。アクセス設定は、完全な内部限定、ログインユーザーのみ編集可能な公開閲覧、ログイン不要の公開から選べます。ロールはadmin、editor、viewerの3種類です。

リビジョン履歴、ページ名変更時のリンク書き換え、SMTPメール、Gitバックアップ、リバースプロキシのヘッダー認証などのオプション機能は、フラグで有効化できます。UIは英語、ドイツ語、スペイン語に対応しています。

主な機能

  • 01SQLiteを組み込んだ単一のGoバイナリとして提供され、ページ本文はディスク上にプレーンなMarkdownで保存されます。
  • 02手動でページの順序を設定できるツリーナビゲーション、タグ、全文検索、バックリンクに対応しています。
  • 03ライブプレビューと内部リンクのオートコンプリートを備えたMarkdownエディターを内蔵しています。
  • 04完全な内部限定、公開閲覧、編集も公開の3つのアクセスモードがあり、admin、editor、viewerのロールを設定できます。
  • 05リビジョン履歴、ページ名変更時のリンク書き換え、SMTPメール、Gitバックアップをオプションで利用できます。
  • 06Linux、macOS、Windows、Raspberry Piで動作し、Dockerとsystemdのインストーラーも用意されています。

ユースケース

  • チームのランブックやエンジニアリングノートを、構造化されたツリーで管理する。
  • データベースサーバーを使わずに、社内ドキュメントやホームラボのナレッジベースをホストする。
  • 既存のMarkdownやObsidian vaultに、構造化されたWiki UIを提供する。
  • 閲覧者には自由に公開し、ページを編集できるのは編集者だけの公開ドキュメントサイトを運営する。

クイックスタート

  1. 1

    DockerでLeafWikiを実行する

    docker run -p 8080:8080 -v ~/leafwiki-data:/app/data ghcr.io/perber/leafwiki:latest --jwt-secret=yoursecret --admin-password=yourpassword --allow-insecure=true
  2. 2

    ブラウザーでhttp://localhost:8080を開き、adminとしてログインする

使う前に知っておきたいこと

  • APIキーは現在開発中で、まだ利用できません。
  • Gitバックアップは実験的な機能です。
  • リアルタイムの共同編集には対応していません。

収録されている特集

トピック

よくある質問

leafwiki とは?
SQLiteとディスク上のMarkdownファイルを使い、外部データベースなしで動く、単一のGoバイナリで構築できるセルフホスト型Wiki。 LeafWikiは、ランブック、エンジニアリングノート、ホームラボのドキュメントなど、構造化して長期保存する文書向けのセルフホスト型Wikiです。単一のGoバイナリとして提供され、メタデータにはSQLite、ページ本文にはデータディレクトリ内のMarkdownファイルを使うため、Node.js、Redis、Postgresの運用は不要です。ページは明示的なツリー構造で整理でき、順序は手動で設定します。バックアップはアプリを停止してデータディレクトリをコピーするだけです。
leafwiki は無料で使えますか?ライセンスは?
leafwiki は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
leafwiki は今もメンテナンスされていますか?
活発にメンテナンス中。leafwiki の最終コミットは 2026年11月7日 です。
leafwiki は何に使えますか?
チームのランブックやエンジニアリングノートを、構造化されたツリーで管理する。 データベースサーバーを使わずに、社内ドキュメントやホームラボのナレッジベースをホストする。 既存のMarkdownやObsidian vaultに、構造化されたWiki UIを提供する。 閲覧者には自由に公開し、ページを編集できるのは編集者だけの公開ドキュメントサイトを運営する。
leafwiki のインストール方法は?
DockerでLeafWikiを実行する: docker run -p 8080:8080 -v ~/leafwiki-data:/app/data ghcr.io/perber/leafwiki:latest --jwt-secret=yoursecret --admin-password=yourpassword --allow-insecure=true ブラウザーでhttp://localhost:8080を開き、adminとしてログインする
leafwiki はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/perber/leafwiki

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト