オリジナルのドキュメント
最終同期リビジョン: aafe48ec
ドキュメントはAGPLv3でライセンスされています。
Wiki.js は Node.js がサポートされるほぼ全てのシステムで動作します
つまり、 Linux、macOS、Windows、あるいは Docker / Kubernets のようなコンテナソリューション、 そしてHeroku などのあらゆる環境で動作します。
Wiki.js はシングルCPUコアでも完璧に動作します。しかし、バックグラウンドワーカーの動作のために2コア以上を推奨します。
Linux システムで Wiki.js を実行するには 最小 1GB のRAM が必要です。
Windows や macOS ではもう少しRAMが必要になります。
必要なストレージ容量はコンテンツによります。ほとんどテキストだけで構成されるWikiは数MBを越えることはありません。一方で画像や動画、その他ファイルをアップロードする場合はそれに応じたストレージを計画してください。
最低 1GB のストレージをWiki.js用に用意するのが推奨されます。
Wiki.jsは時々、自動的に新しい更新、言語、テーマなどを確認します。ダウンロードするデータについてはこちら。
環境をインターネットから切断する場合、ファイルのサイドロードが代替手段として利用できます。
Wiki.jsには固有のドメインやサブドメイン (例: wiki.example.com) を割り当てる必要があります。サブフォルダにマップすることはできません。
Wiki.js は以下のデータベースシステムと互換性があります:
最高のパフォーマンスと機能のために PostgreSQL を使用することを強く推奨します。 Wiki.jsの開発はPostgreSQLで行なわれているため、よりよいサポートが提供できます。
SQLite は中~大規模なWiki.jsデプロイには 非推奨です。
Node.js 10.12 以降 が必要です。
Wiki.js は8.xや6.xのような10.12より古いバージョンでは実行できません
Dockerを使用しますか?
この要件はスキップしてください。マシンにNode.jsをインストールする必要はありません。Dockerイメージに含まれています。
Web サーバー
Wiki.js は webサーバー (nginxやapacheなど)を必要としません。高度なネットワークやDNS設定が必要な場合、Wiki.jsの前にリバースプロクシを置く必要があるかもしれません。
以下のブラウザがサポートされています:
これらのブラウザの最新安定版のみがサポートされます。全てのブラウザはバックグラウンドで自動的に更新されます。