summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorsyuilo <Syuilotan@yahoo.co.jp>2019-04-07 21:50:36 +0900
committerGitHub <noreply@github.com>2019-04-07 21:50:36 +0900
commitf0a29721c9fb10f97faf386bc9d6b1b2fad97895 (patch)
treeb5c1d38d698589bb444c0881a431391db91eb5bc /docs
parentUpdate README.md [AUTOGEN] (#4639) (diff)
downloadsharkey-f0a29721c9fb10f97faf386bc9d6b1b2fad97895.tar.gz
sharkey-f0a29721c9fb10f97faf386bc9d6b1b2fad97895.tar.bz2
sharkey-f0a29721c9fb10f97faf386bc9d6b1b2fad97895.zip
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 * :v: * wip * Update note.ts * Update postgre.ts * wip * wip * wip * wip * Update add-file.ts * wip * wip * wip * Clean up * Update logs.ts * wip * :pizza: * 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 * :v: * clean up * docs * Update push.ts * wip * Update api.ts * wip * :v: * Update make-pagination-query.ts * :v: * 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 * :art: * 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 * :v: * 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 * :art: * 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 * :v: * Refactoring #1540 * test * test * test * test * test * test * test * Fix bug * Fix test * :sushi: * wip * #4471 * Add test for #4335 * Refactor * Fix test * Add tests * :clock4: * Fix bug * Add test * Add test * rename * Fix bug
Diffstat (limited to 'docs')
-rw-r--r--docs/backup.fr.md22
-rw-r--r--docs/backup.md22
-rw-r--r--docs/docker.en.md34
-rw-r--r--docs/docker.ja.md36
-rw-r--r--docs/setup.en.md20
-rw-r--r--docs/setup.fr.md12
-rw-r--r--docs/setup.ja.md20
7 files changed, 89 insertions, 77 deletions
diff --git a/docs/backup.fr.md b/docs/backup.fr.md
deleted file mode 100644
index 19e99068ce..0000000000
--- a/docs/backup.fr.md
+++ /dev/null
@@ -1,22 +0,0 @@
-Comment faire une sauvegarde de votre Misskey ?
-==========================
-
-Assurez-vous d'avoir installé **mongodb-tools**.
-
----
-
-Dans votre terminal :
-``` shell
-$ mongodump --archive=db-backup -u <VotreNomdUtilisateur> -p <VotreMotDePasse>
-```
-
-Pour plus de détails, merci de consulter [la documentation de mongodump](https://docs.mongodb.com/manual/reference/program/mongodump/).
-
-Restauration
--------
-
-``` shell
-$ mongorestore --archive=db-backup
-```
-
-Pour plus de détails, merci de consulter [la documentation de mongorestore](https://docs.mongodb.com/manual/reference/program/mongorestore/).
diff --git a/docs/backup.md b/docs/backup.md
deleted file mode 100644
index a69af0255b..0000000000
--- a/docs/backup.md
+++ /dev/null
@@ -1,22 +0,0 @@
-How to backup your Misskey
-==========================
-
-Make sure **mongodb-tools** installed.
-
----
-
-In your shell:
-``` shell
-$ mongodump --archive=db-backup -u <YourUserName> -p <YourPassword>
-```
-
-For details, please see [mongodump docs](https://docs.mongodb.com/manual/reference/program/mongodump/).
-
-Restore
--------
-
-``` shell
-$ mongorestore --archive=db-backup
-```
-
-For details, please see [mongorestore docs](https://docs.mongodb.com/manual/reference/program/mongorestore/).
diff --git a/docs/docker.en.md b/docs/docker.en.md
index f0fcdb66d5..ee69b6d7ae 100644
--- a/docs/docker.en.md
+++ b/docs/docker.en.md
@@ -15,9 +15,37 @@ This guide describes how to install and setup Misskey with Docker.
*2.* Configure Misskey
----------------------------------------------------------------
-1. `cp .config/example.yml .config/default.yml` Copy the `.config/example.yml` and rename it to `default.yml`.
-2. `cp .config/mongo_initdb_example.js .config/mongo_initdb.js` Copy the `.config/mongo_initdb_example.js` and rename it to `mongo_initdb.js`.
-3. Edit `default.yml` and `mongo_initdb.js`.
+
+Create configuration files with following:
+
+```bash
+cd .config
+cp example.yml default.yml
+cp docker_example.env docker.env
+```
+
+### `default.yml`
+
+Edit this file the same as non-Docker environment.
+However hostname of Postgresql, Redis and Elasticsearch are not `localhost`, they are set in `docker-compose.yml`.
+The following is default hostname:
+
+| Service | Hostname |
+|---------------|----------|
+| Postgresql | `db` |
+| Redis | `redis` |
+| Elasticsearch | `es` |
+
+### `docker.env`
+
+Configure Postgresql in this file.
+The minimum required settings are:
+
+| name | Description |
+|---------------------|---------------|
+| `POSTGRES_PASSWORD` | Password |
+| `POSTGRES_USER` | Username |
+| `POSTGRES_DB` | Database name |
*3.* Configure Docker
----------------------------------------------------------------
diff --git a/docs/docker.ja.md b/docs/docker.ja.md
index 0baf285728..060d4e7bda 100644
--- a/docs/docker.ja.md
+++ b/docs/docker.ja.md
@@ -13,11 +13,39 @@ Dockerを使ったMisskey構築方法
2. `cd misskey` misskeyディレクトリに移動
3. `git checkout $(git tag -l | grep -v 'rc[0-9]*$' | sort -V | tail -n 1)` [最新のリリース](https://github.com/syuilo/misskey/releases/latest)を確認
-*2.* 設定ファイルを作成する
+*2.* 設定ファイルの作成と編集
----------------------------------------------------------------
-1. `cp .config/example.yml .config/default.yml` `.config/example.yml`をコピーし名前を`default.yml`にする
-2. `cp .config/mongo_initdb_example.js .config/mongo_initdb.js` `.config/mongo_initdb_example.js`をコピーし名前を`mongo_initdb.js`にする
-3. `default.yml`と`mongo_initdb.js`を編集する
+
+下記コマンドで設定ファイルを作成してください。
+
+```bash
+cd .config
+cp example.yml default.yml
+cp docker_example.env docker.env
+```
+
+### `default.yml`の編集
+
+非Docker環境と同じ様に編集してください。
+ただし、Postgresql、RedisとElasticsearchのホストは`localhost`ではなく、`docker-compose.yml`で設定されたサービス名になっています。
+標準設定では次の通りです。
+
+| サービス | ホスト名 |
+|---------------|---------|
+| Postgresql |`db` |
+| Redis |`redis` |
+| Elasticsearch |`es` |
+
+### `docker.env`の編集
+
+このファイルはPostgresqlの設定を記述します。
+最低限記述する必要がある設定は次の通りです。
+
+| 設定 | 内容 |
+|---------------------|--------------|
+| `POSTGRES_PASSWORD` | パスワード |
+| `POSTGRES_USER` | ユーザー名 |
+| `POSTGRES_DB` | データベース名 |
*3.* Dockerの設定
----------------------------------------------------------------
diff --git a/docs/setup.en.md b/docs/setup.en.md
index 1125081445..28de1f32f3 100644
--- a/docs/setup.en.md
+++ b/docs/setup.en.md
@@ -22,8 +22,8 @@ adduser --disabled-password --disabled-login misskey
Please install and setup these softwares:
#### Dependencies :package:
-* **[Node.js](https://nodejs.org/en/)** >= 10.0.0
-* **[MongoDB](https://www.mongodb.com/)** >= 3.6
+* **[Node.js](https://nodejs.org/en/)** >= 11.7.0
+* **[PostgreSQL](https://www.postgresql.org/)** >= 10
##### Optional
* [Redis](https://redis.io/)
@@ -31,13 +31,9 @@ Please install and setup these softwares:
* [Elasticsearch](https://www.elastic.co/) - required to enable the search feature
* [FFmpeg](https://www.ffmpeg.org/)
-*3.* Setup MongoDB
+*3.* Setup PostgreSQL
----------------------------------------------------------------
-As root:
-1. `mongo` Go to the mongo shell
-2. `use misskey` Use the misskey database
-3. `db.createUser( { user: "misskey", pwd: "<password>", roles: [ { role: "readWrite", db: "misskey" } ] } )` Create the misskey user.
-4. `exit` You're done!
+:)
*4.* Install Misskey
----------------------------------------------------------------
@@ -68,7 +64,13 @@ If you're still encountering errors about some modules, use node-gyp:
3. `node-gyp build`
4. `NODE_ENV=production npm run build`
-*7.* That is it.
+*7.* Init DB
+----------------------------------------------------------------
+``` shell
+npm run init
+```
+
+*8.* That is it.
----------------------------------------------------------------
Well done! Now, you have an environment that run to Misskey.
diff --git a/docs/setup.fr.md b/docs/setup.fr.md
index 959ec3392f..217a4c6a5b 100644
--- a/docs/setup.fr.md
+++ b/docs/setup.fr.md
@@ -22,8 +22,8 @@ adduser --disabled-password --disabled-login misskey
Installez les paquets suivants :
#### Dépendences :package:
-* **[Node.js](https://nodejs.org/en/)** >= 10.0.0
-* **[MongoDB](https://www.mongodb.com/)** >= 3.6
+* **[Node.js](https://nodejs.org/en/)** >= 11.7.0
+* **[PostgreSQL](https://www.postgresql.org/)** >= 10
##### Optionnels
* [Redis](https://redis.io/)
@@ -31,13 +31,9 @@ Installez les paquets suivants :
* [Elasticsearch](https://www.elastic.co/) - requis pour pouvoir activer la fonctionnalité de recherche
* [FFmpeg](https://www.ffmpeg.org/)
-*3.* Paramètrage de MongoDB
+*3.* Paramètrage de PostgreSQL
----------------------------------------------------------------
-En root :
-1. `mongo` Ouvrez le shell mongo
-2. `use misskey` Utilisez la base de données misskey
-3. `db.createUser( { user: "misskey", pwd: "<password>", roles: [ { role: "readWrite", db: "misskey" } ] } )` Créez l'utilisateur misskey.
-4. `exit` Vous avez terminé !
+:)
*4.* Installation de Misskey
----------------------------------------------------------------
diff --git a/docs/setup.ja.md b/docs/setup.ja.md
index 8a21e104d6..1543541eee 100644
--- a/docs/setup.ja.md
+++ b/docs/setup.ja.md
@@ -22,8 +22,8 @@ adduser --disabled-password --disabled-login misskey
これらのソフトウェアをインストール・設定してください:
#### 依存関係 :package:
-* **[Node.js](https://nodejs.org/en/)** (10.0.0以上)
-* **[MongoDB](https://www.mongodb.com/)** (3.6以上)
+* **[Node.js](https://nodejs.org/en/)** (11.7.0以上)
+* **[PostgreSQL](https://www.postgresql.org/)** (10以上)
##### オプション
* [Redis](https://redis.io/)
@@ -38,13 +38,9 @@ adduser --disabled-password --disabled-login misskey
* 検索機能を有効にするためにはインストールが必要です。
* [FFmpeg](https://www.ffmpeg.org/)
-*3.* MongoDBの設定
+*3.* PostgreSQLの設定
----------------------------------------------------------------
-ルートで:
-1. `mongo` mongoシェルを起動
-2. `use misskey` misskeyデータベースを使用
-3. `db.createUser( { user: "misskey", pwd: "<password>", roles: [ { role: "readWrite", db: "misskey" } ] } )` misskeyユーザーを作成
-4. `exit` mongoシェルを終了
+:)
*4.* Misskeyのインストール
----------------------------------------------------------------
@@ -74,7 +70,13 @@ Debianをお使いであれば、`build-essential`パッケージをインスト
3. `node-gyp build`
4. `NODE_ENV=production npm run build`
-*7.* 以上です!
+*7.* データベースを初期化
+----------------------------------------------------------------
+``` shell
+npm run init
+```
+
+*8.* 以上です!
----------------------------------------------------------------
お疲れ様でした。これでMisskeyを動かす準備は整いました。