Inital commit

2026-08-19 13:55:59 +09:00
commit d61554d8b9
735 changed files with 86553 additions and 0 deletions
@@ -0,0 +1,69 @@
+Misskey構築の手引き
+================================================================
+
+Misskeyサーバーの構築にご関心をお寄せいただきありがとうございます！
+このガイドではMisskeyのインストール・セットアップ方法について解説します。
+
+[英語版もあります - English version also available](./setup.en.md)
+
+----------------------------------------------------------------
+
+*1.* reCAPTCHAトークンの用意
+----------------------------------------------------------------
+MisskeyはreCAPTCHAトークンを必要とします。
+https://www.google.com/recaptcha/intro/ にアクセスしてトークンを生成してください。
+
+*(オプション)* VAPIDキーペアの生成
+----------------------------------------------------------------
+ServiceWorkerを有効にする場合、VAPIDキーペアを生成する必要があります:
+
+``` shell
+npm install web-push -g
+web-push generate-vapid-keys
+```
+
+*2.* 依存関係をインストールする
+----------------------------------------------------------------
+これらのソフトウェアをインストール・設定してください:
+
+#### 依存関係 :package:
+* **Node.js 22.x** と同梱のnpm
+* **[MongoDB](https://www.mongodb.com/)**
+* **[Redis](https://redis.io/)**
+* **[ImageMagick](http://www.imagemagick.org/script/index.php)**
+
+##### オプション
+* [Elasticsearch](https://www.elastic.co/) - 検索機能を向上させるために用います。
+
+*3.* Misskeyのインストール
+----------------------------------------------------------------
+1. `git clone -b master git://github.com/syuilo/misskey.git`
+2. `cd misskey`
+3. `npm ci`
+
+*4.* 設定ファイルを用意する
+----------------------------------------------------------------
+1. `.config`ディレクトリ内の`example.yml`をコピー
+2. `default.yml`にリネーム
+3. 編集する
+
+---
+
+または、`npm run config`コマンドを利用して、ガイドに従って情報を
+入力して設定ファイルを生成することもできます。
+
+*5.* Misskeyのビルド
+----------------------------------------------------------------
+1. `npm run build`
+
+*6.* 以上です！
+----------------------------------------------------------------
+お疲れ様でした。これでMisskeyを動かす準備は整いました。
+
+### 起動
+`npm start`するだけです。GLHF!
+
+### Misskeyを最新バージョンにアップデートする方法:
+1. `git reset --hard && git pull origin master`
+2. `npm ci`
+3. `npm run build`