egirlskey/docs/setup.ja.md
syuilo f0a29721c9
Use PostgreSQL instead of MongoDB (#4572)
* wip

* Update note.ts

* Update timeline.ts

* Update core.ts

* wip

* Update generate-visibility-query.ts

* wip

* wip

* wip

* wip

* wip

* Update global-timeline.ts

* wip

* wip

* wip

* Update vote.ts

* wip

* wip

* Update create.ts

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* Update files.ts

* wip

* wip

* Update CONTRIBUTING.md

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* Update read-notification.ts

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* Update cancel.ts

* wip

* wip

* wip

* Update show.ts

* wip

* wip

* Update gen-id.ts

* Update create.ts

* Update id.ts

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* Docker: Update files about Docker (#4599)

* Docker: Use cache if files used by `yarn install` was not updated

This patch reduces the number of times to installing node_modules.
For example, `yarn install` step will be skipped when only ".config/default.yml" is updated.

* Docker: Migrate MongoDB to Postgresql

Misskey uses Postgresql as a database instead of Mongodb since version 11.

* Docker: Uncomment about data persistence

This patch will save a lot of databases.

* wip

* wip

* wip

* Update activitypub.ts

* wip

* wip

* wip

* Update logs.ts

* wip

* Update drive-file.ts

* Update register.ts

* wip

* wip

* Update mentions.ts

* wip

* wip

* wip

* Update recommendation.ts

* wip

* Update index.ts

* wip

* Update recommendation.ts

* Doc: Update docker.ja.md and docker.en.md (#1) (#4608)

Update how to set up misskey.

* wip

* ✌️

* wip

* Update note.ts

* Update postgre.ts

* wip

* wip

* wip

* wip

* Update add-file.ts

* wip

* wip

* wip

* Clean up

* Update logs.ts

* wip

* 🍕

* wip

* Ad notes

* wip

* Update api-visibility.ts

* Update note.ts

* Update add-file.ts

* tests

* tests

* Update postgre.ts

* Update utils.ts

* wip

* wip

* Refactor

* wip

* Refactor

* wip

* wip

* Update show-users.ts

* Update update-instance.ts

* wip

* Update feed.ts

* Update outbox.ts

* Update outbox.ts

* Update user.ts

* wip

* Update list.ts

* Update update-hashtag.ts

* wip

* Update update-hashtag.ts

* Refactor

* Update update.ts

* wip

* wip

* ✌️

* clean up

* docs

* Update push.ts

* wip

* Update api.ts

* wip

* ✌️

* Update make-pagination-query.ts

* ✌️

* Delete hashtags.ts

* Update instances.ts

* Update instances.ts

* Update create.ts

* Update search.ts

* Update reversi-game.ts

* Update signup.ts

* Update user.ts

* id

* Update example.yml

* 🎨

* objectid

* fix

* reversi

* reversi

* Fix bug of chart engine

* Add test of chart engine

* Improve test

* Better testing

* Improve chart engine

* Refactor

* Add test of chart engine

* Refactor

* Add chart test

* Fix bug

* コミットし忘れ

* Refactoring

* ✌️

* Add tests

* Add test

* Extarct note tests

* Refactor

* 存在しないユーザーにメンションできなくなっていた問題を修正

* Fix bug

* Update update-meta.ts

* Fix bug

* Update mention.vue

* Fix bug

* Update meta.ts

* Update CONTRIBUTING.md

* Fix bug

* Fix bug

* Fix bug

* Clean up

* Clean up

* Update notification.ts

* Clean up

* Add mute tests

* Add test

* Refactor

* Add test

* Fix test

* Refactor

* Refactor

* Add tests

* Update utils.ts

* Update utils.ts

* Fix test

* Update package.json

* Update update.ts

* Update manifest.ts

* Fix bug

* Fix bug

* Add test

* 🎨

* Update endpoint permissions

* Updaye permisison

* Update person.ts

#4299

* データベースと同期しないように

* Fix bug

* Fix bug

* Update reversi-game.ts

* Use a feature of Node v11.7.0 to extract a public key (#4644)

* wip

* wip

* ✌️

* Refactoring

#1540

* test

* test

* test

* test

* test

* test

* test

* Fix bug

* Fix test

* 🍣

* wip

* #4471

* Add test for #4335

* Refactor

* Fix test

* Add tests

* 🕓

* Fix bug

* Add test

* Add test

* rename

* Fix bug
2019-04-07 21:50:36 +09:00

4.9 KiB
Raw Blame History

Misskey構築の手引き

Misskeyサーバーの構築にご関心をお寄せいただきありがとうございます このガイドではMisskeyのインストール・セットアップ方法について解説します。

英語版もあります - English version also available


1. Misskeyユーザーの作成

Misskeyはrootユーザーで実行しない方がよいため、代わりにユーザーを作成します。 Debianの例:

adduser --disabled-password --disabled-login misskey

2. 依存関係をインストールする

これらのソフトウェアをインストール・設定してください:

依存関係 📦

オプション
  • Redis
    • Redisはオプションですが、インストールすることを強く推奨します。
    • インストールしなくていいのは、あなたのインスタンスが自分専用のときだけとお考えください。
    • 具体的には、Redisをインストールしないと、次の事が出来なくなります:
      • Misskeyプロセスを複数起動しての負荷分散
      • レートリミット
      • ジョブキュー
      • Twitter連携
  • Elasticsearch
    • 検索機能を有効にするためにはインストールが必要です。
  • FFmpeg

3. PostgreSQLの設定

:)

4. Misskeyのインストール

  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) 最新のリリースを確認
  5. npm install Misskeyの依存パッケージをインストール

5. 設定ファイルを作成する

  1. cp .config/example.yml .config/default.yml .config/example.ymlをコピーし名前をdefault.ymlにする。
  2. default.yml を編集する。

6. Misskeyのビルド

次のコマンドでMisskeyをビルドしてください:

NODE_ENV=production npm run build

Debianをお使いであれば、build-essentialパッケージをインストールする必要があります。

何らかのモジュールでエラーが発生する場合はnode-gypを使ってください:

  1. npm install -g node-gyp
  2. node-gyp configure
  3. node-gyp build
  4. NODE_ENV=production npm run build

7. データベースを初期化

npm run init

8. 以上です!

お疲れ様でした。これでMisskeyを動かす準備は整いました。

通常起動

NODE_ENV=production 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
Environment="NODE_ENV=production"
TimeoutSec=60
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=misskey
Restart=always

[Install]
WantedBy=multi-user.target

CentOSで1024以下のポートを使用してMisskeyを使用する場合はExecStart=/usr/bin/sudo /usr/bin/npm startに変更する必要があります。

  1. systemctl daemon-reload ; systemctl enable misskey systemdを再読み込みしmisskeyサービスを有効化
  2. systemctl start misskey misskeyサービスの起動

systemctl status misskeyと入力すると、サービスの状態を調べることができます。

Misskeyを最新バージョンにアップデートする方法:

  1. git fetch
  2. git checkout $(git tag -l | grep -v 'rc[0-9]*$' | sort -V | tail -n 1)
  3. npm install
  4. NODE_ENV=production npm run build
  5. ChangeLogでマイグレーション情報を確認する

なにか問題が発生した場合は、npm run cleanまたはnpm run cleanallすると直る場合があります。


なにかお困りのことがありましたらお気軽にご連絡ください。