Update setup docs
This commit is contained in:
		
							parent
							
								
									e063ac10c5
								
							
						
					
					
						commit
						7276ec185b
					
				
					 2 changed files with 83 additions and 25 deletions
				
			
		|  | @ -13,7 +13,7 @@ This guide describes how to install and setup Misskey. | ||||||
| Running misskey on root is not a good idea so we create a user for that. | Running misskey on root is not a good idea so we create a user for that. | ||||||
| In debian for exemple : | In debian for exemple : | ||||||
| 
 | 
 | ||||||
| ```  | ``` | ||||||
| adduser --disabled-password --disabled-login misskey | adduser --disabled-password --disabled-login misskey | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
|  | @ -67,7 +67,7 @@ web-push generate-vapid-keys | ||||||
| *6.* Make configuration file | *6.* Make configuration file | ||||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ||||||
| 1. `cp .config/example.yml .config/default.yml` Copy the `.config/example.yml` and rename it to `default.yml`. | 1. `cp .config/example.yml .config/default.yml` Copy the `.config/example.yml` and rename it to `default.yml`. | ||||||
| 2. Edit it | 2. Edit `default.yml` | ||||||
| 
 | 
 | ||||||
| *7.* Build Misskey | *7.* Build Misskey | ||||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ||||||
|  |  | ||||||
							
								
								
									
										104
									
								
								docs/setup.ja.md
									
										
									
									
									
								
							
							
						
						
									
										104
									
								
								docs/setup.ja.md
									
										
									
									
									
								
							|  | @ -8,18 +8,13 @@ Misskeyサーバーの構築にご関心をお寄せいただきありがとう | ||||||
| 
 | 
 | ||||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ||||||
| 
 | 
 | ||||||
| *1.* reCAPTCHAトークンの用意 | *1.* Misskeyユーザーの作成 | ||||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ||||||
| MisskeyはreCAPTCHAトークンを必要とします。 | Misskeyのrootで実行しない方がよいため、代わりにユーザーを作成します。 | ||||||
| https://www.google.com/recaptcha/intro/ にアクセスしてトークンを生成してください。 | Debianの例: | ||||||
| 
 | 
 | ||||||
| *(オプション)* VAPIDキーペアの生成 | ``` | ||||||
| ---------------------------------------------------------------- | adduser --disabled-password --disabled-login misskey | ||||||
| ServiceWorkerを有効にする場合、VAPIDキーペアを生成する必要があります: |  | ||||||
| 
 |  | ||||||
| ``` shell |  | ||||||
| npm install web-push -g |  | ||||||
| web-push generate-vapid-keys |  | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| *2.* 依存関係をインストールする | *2.* 依存関係をインストールする | ||||||
|  | @ -35,34 +30,98 @@ web-push generate-vapid-keys | ||||||
| ##### オプション | ##### オプション | ||||||
| * [Elasticsearch](https://www.elastic.co/) - 検索機能を向上させるために用います。 | * [Elasticsearch](https://www.elastic.co/) - 検索機能を向上させるために用います。 | ||||||
| 
 | 
 | ||||||
| *3.* Misskeyのインストール | *3.* Mongodbの設定 | ||||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ||||||
| 1. `git clone -b master git://github.com/syuilo/misskey.git` | ルートで: | ||||||
| 2. `cd misskey` | 1. `mongo` mongoシェルを起動 | ||||||
| 3. `npm install` | 2. `use misskey` misskeyデータベースを使用 | ||||||
|  | 3. `db.users.save( {dummy:"dummy"} )` ダミーデータを書き込みDBを初期化 | ||||||
|  | 4. `db.createUser( { user: "misskey", pwd: "<password>", roles: [ { role: "readWrite", db: "misskey" } ] } )` misskeyユーザーを作成 | ||||||
|  | 5. `exit` mongoシェルを終了 | ||||||
| 
 | 
 | ||||||
| *4.* 設定ファイルを作成する | *4.* Misskeyのインストール | ||||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ||||||
| `.config/example.yml`をコピーしたのち`default.yml`にリネームして編集してください。 | 1. `su - misskey` misskeyユーザーを使用 | ||||||
|  | 2. `git clone -b master git://github.com/syuilo/misskey.git` masterブランチからMisskeyレポジトリをクローン | ||||||
|  | 3. `cd misskey` misskeyディレクトリに移動 | ||||||
|  | 4. `git checkout $(git tag -l | grep -v 'rc[0-9]*$' | sort -V | tail -n 1)` [最新のリリース](https://github.com/syuilo/misskey/releases/latest)を確認 | ||||||
|  | 5. `npm install` Misskeyの依存パッケージをインストール | ||||||
| 
 | 
 | ||||||
| *5.* Misskeyのビルド | *5.* reCAPTCHAトークン | ||||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ||||||
|  | MisskeyはreCAPTCHAトークンを必要とします。 | ||||||
|  | https://www.google.com/recaptcha/intro/ にアクセスしてトークンを生成してください。 | ||||||
|  | 
 | ||||||
|  | *(オプション)* VAPIDキーペアの生成 | ||||||
|  | ---------------------------------------------------------------- | ||||||
|  | ServiceWorkerを有効にする場合、VAPIDキーペアを生成する必要があります: | ||||||
|  | 
 | ||||||
|  | ``` shell | ||||||
|  | npm install web-push -g | ||||||
|  | web-push generate-vapid-keys | ||||||
|  | ``` | ||||||
|  | 
 | ||||||
|  | *6.* Make configuration file | ||||||
|  | ---------------------------------------------------------------- | ||||||
|  | 1. `cp .config/example.yml .config/default.yml` `.config/example.yml`をコピーし名前を`default.yml`にする。 | ||||||
|  | 2. `default.yml` を編集する。 | ||||||
|  | 
 | ||||||
|  | *7.* Misskeyのビルド | ||||||
|  | ---------------------------------------------------------------- | ||||||
|  | 
 | ||||||
|  | 次のコマンドでMisskeyをビルドしてください: | ||||||
|  | 
 | ||||||
|  | `npm run build` | ||||||
|  | 
 | ||||||
|  | Debianをお使いであれば、`build-essential`パッケージをインストールする必要があります。 | ||||||
|  | 
 | ||||||
|  | 何らかのモジュールでエラーが発生する場合はnode-gypを使ってください: | ||||||
| 1. `npm install -g node-gyp` | 1. `npm install -g node-gyp` | ||||||
| 2. `node-gyp configure` | 2. `node-gyp configure` | ||||||
| 3. `node-gyp build` | 3. `node-gyp build` | ||||||
| 4. `npm run build` | 4. `npm run build` | ||||||
| 
 | 
 | ||||||
|  | 
 | ||||||
| *6.* 以上です! | *6.* 以上です! | ||||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ||||||
| お疲れ様でした。これでMisskeyを動かす準備は整いました。 | お疲れ様でした。これでMisskeyを動かす準備は整いました。 | ||||||
| 
 | 
 | ||||||
| ### 起動 | ### 通常起動 | ||||||
| `sudo npm start`するだけです。GLHF! | `npm start`するだけです。GLHF! | ||||||
|  | 
 | ||||||
|  | ### systemdを用いた起動 | ||||||
|  | 1. systemdサービスのファイルを作成: `/etc/systemd/system/misskey.service` | ||||||
|  | 2. エディタで開き、以下のコードを貼り付けて保存: | ||||||
|  | 
 | ||||||
|  | ``` | ||||||
|  | [Unit] | ||||||
|  | Description=Misskey daemon | ||||||
|  | 
 | ||||||
|  | [Service] | ||||||
|  | Type=simple | ||||||
|  | User=misskey | ||||||
|  | ExecStart=/usr/bin/npm start | ||||||
|  | WorkingDirectory=/home/misskey/misskey | ||||||
|  | TimeoutSec=60 | ||||||
|  | StandardOutput=syslog | ||||||
|  | StandardError=syslog | ||||||
|  | SyslogIdentifier=misskey | ||||||
|  | Restart=always | ||||||
|  | 
 | ||||||
|  | [Install] | ||||||
|  | WantedBy=multi-user.target | ||||||
|  | ``` | ||||||
|  | 
 | ||||||
|  | 3. `systemctl daemon-reload ; systemctl enable misskey` systemdを再読み込みしmisskeyサービスを有効化 | ||||||
|  | 4. `systemctl start misskey` misskeyサービスの起動 | ||||||
|  | 
 | ||||||
|  | `systemctl status misskey`と入力すると、サービスの状態を調べることができます。 | ||||||
| 
 | 
 | ||||||
| ### Misskeyを最新バージョンにアップデートする方法: | ### Misskeyを最新バージョンにアップデートする方法: | ||||||
| 1. `git reset --hard && git pull origin master` | 1. `git fetch` | ||||||
| 2. `npm install` | 2. `git checkout $(git tag -l | grep -v 'rc[0-9]*$' | sort -V | tail -n 1)` | ||||||
| 3. `npm run build` | 3. `npm install` | ||||||
|  | 4. `npm run build` | ||||||
| 
 | 
 | ||||||
| ## メモリが足りなくてビルドできない場合 | ## メモリが足りなくてビルドできない場合 | ||||||
| Misskeyの(クライアントの)ビルドには、目安として8GBくらいのメモリを必要とします。 | Misskeyの(クライアントの)ビルドには、目安として8GBくらいのメモリを必要とします。 | ||||||
|  | @ -74,4 +133,3 @@ VPSなどでビルドする時は、もしかしたらメモリが足りなく | ||||||
| 3. npm run webpack | 3. npm run webpack | ||||||
| 4. built/client をサーバーにアップロードする | 4. built/client をサーバーにアップロードする | ||||||
| 5. サーバー上で、npm run gulp | 5. サーバー上で、npm run gulp | ||||||
| 6. 完了 |  | ||||||
|  |  | ||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue