summaryrefslogtreecommitdiff
path: root/docs/src/guide/admin/cache.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/src/guide/admin/cache.md')
-rw-r--r--docs/src/guide/admin/cache.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/docs/src/guide/admin/cache.md b/docs/src/guide/admin/cache.md
new file mode 100644
index 0000000..ec00455
--- /dev/null
+++ b/docs/src/guide/admin/cache.md
@@ -0,0 +1,41 @@
+# キャッシュシステム
+
+LunaticChat では,かな・ローマ字変換時のフレーズを自動でメモリ・ディスクにキャッシュするシステムが搭載されています.
+
+かな・ローマ字変換に関する情報は [こちら](../player/japanese-romanization.md) をご覧ください.
+
+## メモリキャッシュ
+
+LunaticChat は変換済みのフレーズをメモリ上にキャッシュし,再度同じフレーズが要求された際に高速に応答できるようにしています.
+
+このキャッシュは一時的であり,サーバー再起動時や設定した秒数毎にディスクキャッシュへ保存されます.
+
+## ディスクキャッシュ
+
+LunaticChat はメモリキャッシュの内容を定期的にディスクに保存します. これにより,サーバー再起動後もキャッシュ内容を保持できるようになっています.
+
+ディスクキャッシュとして使用されるファイルは [設定で変更できます](../admin/configuration.md#cachefilepath).
+
+## キャッシュの解放
+
+メモリキャッシュは,ディスクにキャッシュしたのち自動的に JVM のガベージコレクションにより解放されます.
+
+ディスクキャッシュは,手動でファイルを削除することで解放できます. 再起動時に LunaticChat は再度キャッシュファイルを作成します.
+
+::: warning パージ機能について
+
+LunaticChat では,キャッシュのパージ 機能は実装されていません.
+
+これはプレイヤー側にホストのファイルシステムを操作させることがセキュリティ上好ましくないためです.
+
+:::
+
+## キャッシュバージョン
+
+ディスクキャッシュに使用されるファイルには `version` フィールドが含まれており,LunaticChat のバージョンアップに伴うキャッシュフォーマットの変更に対応しています.
+
+バージョンが不一致の場合,LunaticChat はキャッシュファイルを **古い形式のキャッシュ** として認識し,内容を無視して新しい形式で再作成します.
+
+```json
+{"version":"1","entries":{}}
+```