Wiki.js を使ってわずか数分で独自の Wiki をセットアップするためのクイックガイド

Wiki.jsは、Node.jsフレームワークをベースに設計された、機能豊富なオープンソースのWikiアプリケーションです。MarkdownとWYSIWYGインターフェースの両方をサポートし、多様な編集エクスペリエンスを提供します。さらに、リアルタイムコラボレーション、バージョン管理、GoogleやLDAPとの連携を含む多様な認証方法をサポートします。この包括的なガイドでは、Dockerを使ってWiki.jsを設定するために必要な手順を詳しく説明し、わずか数分で独自のWikiをデプロイできるようにします。

Docker Compose 経由で Wiki.js をセットアップする

DockerとDocker Composeを使ったWiki.jsのセットアップは簡単です。まず、新しいディレクトリを作成しwikijs-docker、そこに移動します。

mkdir wikijs-docker && cd wikijs-docker

docker-compose.yml次に、好みのテキストエディターを使用して、次の名前のファイルを作成します。

nano docker-compose.yml

次に、次の構成をファイルに挿入します。

services: db: image: postgres:16 environment: POSTGRES_DB: wiki POSTGRES_PASSWORD: wikijsrocks POSTGRES_USER: wikijs restart: unless-stopped volumes: - db-data:/var/lib/postgresql/data wiki: image: ghcr.io/requarks/wiki:2 depends_on: - db environment: DB_TYPE: postgres DB_HOST: db DB_PORT: 5432 DB_USER: wikijs DB_PASS: wikijsrocks DB_NAME: wiki restart: unless-stopped ports: - "80:3000" volumes: db-data:

ファイルを保存して閉じた後、次のコマンドを実行してコンテナを初期化します。

docker compose up -d

セットアッププロセスが完了したら、 Webブラウザでhttp://localhostにアクセスします。ここで管理者アカウントの詳細を入力し、「インストール」ボタンを選択してインストールを開始します。

インストールが完了したら、資格情報を使用してログインします。

Wiki.js でのページの作成と管理

初期設定が完了したら、ホームページを設定してコンテンツの作成を開始したり、管理パネルにアクセスして設定、ユーザー、利用可能な機能を管理したりできます。

[ホームページの作成]オプションをクリックすると、好みに合わせてカスタマイズされたエディターを選択するように求められます。

次に、ページのプロパティを定義し、「OK」ボタンを押して新しいページの作成を続行します。

希望するコンテンツを入力し、「作成」ボタンをクリックしてページの作成を完了します。

コンテンツの管理と整理

ダッシュボードでは、既存のページを閲覧・編集したり、選択したエディターを使って新しいページを作成したりできます。ページの名前変更、移動、削除など、コンテンツを整理したり、タグを使って効果的に分類したりできます。さらに、サイドバーと検索機能を使えば、Wiki内の特定のページへの移動がスムーズになります。

Wiki.js サイト設定の構成

Wiki.js 管理パネルでは、ロケール、ナビゲーション構造、テーマ、タグなどのサイト設定を柔軟に構成できます。これらの設定は、Wiki.js インスタンスの全体的な構成を定義する上で重要な役割を果たします。

[全般]タブでは、サイトのタイトル、説明、デフォルトのホームページ、表示設定 (公開または非公開) などの基本的なサイト設定を調整できます。

ロケールタブに切り替えて、サイトのデフォルトの言語、タイムゾーン、日付/時刻の形式を指定します。

Wiki のメニュー構造を管理し、ユーザーナビゲーションを強化するには、ナビゲーションバーセクションにアクセスしてください。

ページタブでは、すべての Wiki ページを監視、編集、整理したり、新しいページを作成したり、コンテンツの階層を管理したりできます。

さらに、「タグ」タブでは、コンテンツタグを作成・管理してページの検索性を高めることができます。また、「テーマ」タブでは、サイトのロゴ、色、フォント、レイアウトスタイルを変更して、Wikiの美的要素をカスタマイズできます。

Wiki でのグループの管理

グループセクションでは、ユーザーグループを作成し、メンバーを指定し、グループレベルの権限を設定してアクセスを制御できます。この管理方法により、ユーザーの役割を効率化し、Wiki全体で一貫したアクセス管理を維持できます。

特定のグループをクリックすると、そのグループの設定、権限、ページルール、ユーザー管理を更新できます。「設定」タブでは、ログインリダイレクトURLなどのオプションを調整できます。

また、「権限」、「ページルール」、「ユーザー」のセクションを移動して、グループがアクセスできる内容を絞り込み、それに応じてユーザーを割り当てることもできます。

Wiki.js でのユーザー管理

新しいユーザーを追加するには、「ユーザー」セクションに移動し、「新しいユーザー」ボタンをクリックして、必須フィールドに入力します。

完了したら、「作成」または「作成して閉じる」を選択して、新しいユーザーの設定を確定します。

特定のユーザーを選択すると、そのユーザーのプロファイルの表示と編集、ユーザーグループの割り当て、認証方法 (パスワードや 2 要素認証など) の定義、およびDeactivate、Verify、Deleteなどのアクションによるステータスの管理を行うことができます。

さらに、基本情報、拡張メタデータ（場所や役職など）を更新したり、アクティビティ履歴を表示したりすることもできます。

Wikiモジュールの管理

モジュールはWiki.jsの機能を拡張する拡張機能です。例えば、Analyticsモジュールを使用すると、Google Analyticsなどのツールを統合して、ユーザーエンゲージメントやトラフィック指標を追跡できます。

認証タブを使用して、認証プロバイダー (ローカルログイン、LDAP、OAuth) を確立および管理し、さまざまなログインオプションを構成します。

コメントシステムのオン/オフを切り替えたり、ユーザーがページのディスカッションに参加する方法を指定したりすることもできます。

システム構成

レンダリングエンジン、検索インデックス、ストレージ設定を構成することで、コンテンツのレンダリング方法、検索用インデックス作成方法、保存方法を管理できます。例えば、「レンダリング」タブでは、Markdownエンジンの設定を調整したり、図や数式のサポートを有効にしたりするなど、コンテンツのレンダリングをカスタマイズできます。