Repolode
michaelstaake

michaelstaake/LibreKB

PHPとMySQLで構築された、リッチな記事エディターと任意で利用できる読み取り専用JSON APIを備えた、無料のセルフホスト型ナレッジベースWebアプリ。

代替できる製品:ConfluenceZendesk Guide

スター
63
フォーク
10
未解決の Issue
0
最終コミット
3 日前

これは何?

LibreKBは、PHPで書かれ、MySQLまたはMariaDBをバックエンドに使用するセルフホスト型のナレッジベースWebアプリです。チームや組織で、階層化されたカテゴリに整理したヘルプ記事やドキュメントを公開できます。ユーザーアカウント、あらかじめ定義されたユーザーグループ、TinyMCEベースの記事エディターも備えています。

ほとんどの共用ホスティングやVPS、Docker上で動作します。セットアップでは、サンプルの設定ファイルをコピーし、データベースを作成して、ブラウザー上のインストーラーを実行します。ブランディング、外観、公開用のカスタムCSS、エディターのツールバーは、管理設定から変更できます。記事にはダウンロード可能なファイルを添付でき、パスワードのリセットメールも送信できます。

必要に応じて、記事、カテゴリ、検索を対象とする読み取り専用のJSON APIを公開できます。APIはデフォルトで無効になっており、APIキーに対応しています。また、公開サイトと同じ表示ルールに従うため、非公開コンテンツが表示されることはありません。

主な機能

  • 01深さに制限のない階層型カテゴリ。
  • 02TinyMCEを使った記事編集と、設定可能なツールバー。
  • 03あらかじめ定義されたユーザーグループと、メールによるパスワードリセット。
  • 04記事から読者がダウンロードできるファイル添付機能。
  • 05APIキーに対応した、任意で利用できる読み取り専用JSON API。
  • 06カスタムCSSやブランディング設定に対応した、Bootstrapベースのレスポンシブデザイン。

ユースケース

  • 社内ドキュメントや社員向けハンドブックを公開する。
  • 製品やサービスの顧客向けヘルプセンター記事を公開する。
  • 基本的なPHP/MySQLホスティング環境で、セルフホスト型のFAQやサポートサイトを運営する。
  • 読み取り専用APIを通じて、ナレッジベースのコンテンツを他のアプリケーションに取り込む。

クイックスタート

  1. 1

    PHP 8.4以降、MySQLまたはMariaDB、および.htaccessに対応したWebサーバーを確認します

  2. 2

    config.example.phpをconfig.phpにコピーし、データベース情報とsystemURLを設定します

    cp config.example.php config.php
  3. 3

    空のデータベースを作成してから/installを開き、管理者ユーザーを作成します

  4. 4

    /loginからログインし、install.phpまたはupdate.phpがあれば削除します

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

  • pdo_mysql、curl、mbstring、fileinfo拡張機能を備えたPHP 8.4以降と、MySQLまたはMariaDBが必要です。
  • セットアップは手動です。configの編集、データベースの作成、ファイルへの書き込み権限の設定が必要です。

収録されている特集

トピック

よくある質問

LibreKB とは?
PHPとMySQLで構築された、リッチな記事エディターと任意で利用できる読み取り専用JSON APIを備えた、無料のセルフホスト型ナレッジベースWebアプリ。 LibreKBは、PHPで書かれ、MySQLまたはMariaDBをバックエンドに使用するセルフホスト型のナレッジベースWebアプリです。チームや組織で、階層化されたカテゴリに整理したヘルプ記事やドキュメントを公開できます。ユーザーアカウント、あらかじめ定義されたユーザーグループ、TinyMCEベースの記事エディターも備えています。
LibreKB は無料で使えますか?ライセンスは?
LibreKB は GPL-3.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
LibreKB は今もメンテナンスされていますか?
活発にメンテナンス中。LibreKB の最終コミットは 2026年11月3日 です。
LibreKB は何に使えますか?
社内ドキュメントや社員向けハンドブックを公開する。 製品やサービスの顧客向けヘルプセンター記事を公開する。 基本的なPHP/MySQLホスティング環境で、セルフホスト型のFAQやサポートサイトを運営する。 読み取り専用APIを通じて、ナレッジベースのコンテンツを他のアプリケーションに取り込む。
LibreKB のインストール方法は?
PHP 8.4以降、MySQLまたはMariaDB、および.htaccessに対応したWebサーバーを確認します config.example.phpをconfig.phpにコピーし、データベース情報とsystemURLを設定します: cp config.example.php config.php 空のデータベースを作成してから/installを開き、管理者ユーザーを作成します /loginからログインし、install.phpまたはupdate.phpがあれば削除します
LibreKB はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/michaelstaake/LibreKB

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

関連プロジェクト