mirror of
https://git.joinsharkey.org/Sharkey/Sharkey.git
synced 2024-12-23 14:33:12 +02:00
Update setup docs
This commit is contained in:
parent
85134b513d
commit
c8a4d62e66
2 changed files with 39 additions and 26 deletions
|
@ -35,32 +35,38 @@ Please install and setup these softwares:
|
||||||
##### Optional
|
##### Optional
|
||||||
* [Elasticsearch](https://www.elastic.co/) - used to provide searching feature instead of MongoDB
|
* [Elasticsearch](https://www.elastic.co/) - used to provide searching feature instead of MongoDB
|
||||||
|
|
||||||
*3.* Prepare configuration
|
*3.* Install Misskey
|
||||||
|
----------------------------------------------------------------
|
||||||
|
1. `git clone -b master git://github.com/syuilo/misskey.git`
|
||||||
|
2. `cd misskey`
|
||||||
|
3. `npm install`
|
||||||
|
|
||||||
|
*4.* Prepare configuration
|
||||||
----------------------------------------------------------------
|
----------------------------------------------------------------
|
||||||
1. Copy `example.yml` of `.config` directory
|
1. Copy `example.yml` of `.config` directory
|
||||||
2. Rename it to `default.yml`
|
2. Rename it to `default.yml`
|
||||||
3. Edit it
|
3. Edit it
|
||||||
|
|
||||||
*4.* Install and build Misskey
|
---
|
||||||
|
|
||||||
|
Or you can generate config file via `npm run config` command.
|
||||||
|
|
||||||
|
*5.* Build Misskey
|
||||||
----------------------------------------------------------------
|
----------------------------------------------------------------
|
||||||
|
1. `npm run build`
|
||||||
|
|
||||||
1. `git clone -b master git://github.com/syuilo/misskey.git`
|
*6.* That is it.
|
||||||
2. `cd misskey`
|
|
||||||
3. `npm install`
|
|
||||||
4. `npm run build`
|
|
||||||
|
|
||||||
#### Update
|
|
||||||
1. `git reset --hard && git pull origin master`
|
|
||||||
2. `npm install`
|
|
||||||
3. `npm run build`
|
|
||||||
|
|
||||||
*5.* That is it.
|
|
||||||
----------------------------------------------------------------
|
----------------------------------------------------------------
|
||||||
Well done! Now, you have an environment that run to Misskey.
|
Well done! Now, you have an environment that run to Misskey.
|
||||||
|
|
||||||
### Launch
|
### Launch
|
||||||
Just `sudo npm start`. GLHF!
|
Just `sudo npm start`. GLHF!
|
||||||
|
|
||||||
|
#### Way to Update to latest version of your Misskey
|
||||||
|
1. `git reset --hard && git pull origin master`
|
||||||
|
2. `npm install`
|
||||||
|
3. `npm run build`
|
||||||
|
|
||||||
### Testing
|
### Testing
|
||||||
Run `npm test` after building
|
Run `npm test` after building
|
||||||
|
|
||||||
|
|
|
@ -35,32 +35,39 @@ web-push generate-vapid-keys
|
||||||
##### オプション
|
##### オプション
|
||||||
* [Elasticsearch](https://www.elastic.co/) - 検索機能を向上させるために用います。
|
* [Elasticsearch](https://www.elastic.co/) - 検索機能を向上させるために用います。
|
||||||
|
|
||||||
*3.* 設定ファイルを用意する
|
*3.* Misskeyのインストール
|
||||||
|
----------------------------------------------------------------
|
||||||
|
1. `git clone -b master git://github.com/syuilo/misskey.git`
|
||||||
|
2. `cd misskey`
|
||||||
|
3. `npm install`
|
||||||
|
|
||||||
|
*4.* 設定ファイルを用意する
|
||||||
----------------------------------------------------------------
|
----------------------------------------------------------------
|
||||||
1. `.config`ディレクトリ内の`example.yml`をコピー
|
1. `.config`ディレクトリ内の`example.yml`をコピー
|
||||||
2. `default.yml`にリネーム
|
2. `default.yml`にリネーム
|
||||||
3. 編集する
|
3. 編集する
|
||||||
|
|
||||||
*4.* Misskeyのインストール(とビルド)
|
---
|
||||||
|
|
||||||
|
または、`npm run config`コマンドを利用して、ガイドに従って情報を
|
||||||
|
入力して設定ファイルを生成することもできます。
|
||||||
|
|
||||||
|
*5.* Misskeyのビルド
|
||||||
----------------------------------------------------------------
|
----------------------------------------------------------------
|
||||||
|
1. `npm run build`
|
||||||
|
|
||||||
1. `git clone -b master git://github.com/syuilo/misskey.git`
|
*6.* 以上です!
|
||||||
2. `cd misskey`
|
|
||||||
3. `npm install`
|
|
||||||
4. `npm run build`
|
|
||||||
|
|
||||||
#### アップデートするには:
|
|
||||||
1. `git reset --hard && git pull origin master`
|
|
||||||
2. `npm install`
|
|
||||||
3. `npm run build`
|
|
||||||
|
|
||||||
*5.* 以上です!
|
|
||||||
----------------------------------------------------------------
|
----------------------------------------------------------------
|
||||||
お疲れ様でした。これでMisskeyを動かす準備は整いました。
|
お疲れ様でした。これでMisskeyを動かす準備は整いました。
|
||||||
|
|
||||||
### 起動
|
### 起動
|
||||||
`sudo npm start`するだけです。GLHF!
|
`sudo npm start`するだけです。GLHF!
|
||||||
|
|
||||||
|
#### Misskeyを最新バージョンにアップデートする方法:
|
||||||
|
1. `git reset --hard && git pull origin master`
|
||||||
|
2. `npm install`
|
||||||
|
3. `npm run build`
|
||||||
|
|
||||||
### テスト
|
### テスト
|
||||||
(ビルドされている状態で)`npm test`
|
(ビルドされている状態で)`npm test`
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue