summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorかひわし4(バージョン1) <khws4v1@gmail.com>2018-10-09 15:09:50 +0900
committersyuilo <Syuilotan@yahoo.co.jp>2018-10-09 15:09:50 +0900
commit7a406c1f135bd1020528cf46870b70360342d244 (patch)
tree2c8b16207dc820d6388685e9bdd21a9047fa869b /docs
parent10.3.0 (diff)
downloadmisskey-7a406c1f135bd1020528cf46870b70360342d244.tar.gz
misskey-7a406c1f135bd1020528cf46870b70360342d244.tar.bz2
misskey-7a406c1f135bd1020528cf46870b70360342d244.zip
Docker (#2867)
* Dockerize Misskey * Add a new line at EOF * Add support Elasticsearch * / * Add setup document for docker * Add english document * Edit docs * docker -> Docker * Arrange format * Update docker.en.md * Modify title
Diffstat (limited to 'docs')
-rw-r--r--docs/docker.en.md47
-rw-r--r--docs/docker.ja.md48
2 files changed, 95 insertions, 0 deletions
diff --git a/docs/docker.en.md b/docs/docker.en.md
new file mode 100644
index 0000000000..d0546c0a2a
--- /dev/null
+++ b/docs/docker.en.md
@@ -0,0 +1,47 @@
+Docker Guide
+================================================================
+
+This guide describes how to install and setup Misskey with Docker.
+
+[Japanese version also available - 日本語版もあります](./docker.ja.md)
+
+----------------------------------------------------------------
+
+*1.* Make configuration files
+----------------------------------------------------------------
+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`.
+2. Edit `default.yml` and `mongo_initdb.js`.
+
+*2.* Configure Docker
+----------------------------------------------------------------
+Edit `docker-compose.yml`.
+
+*3.* Build Misskey
+----------------------------------------------------------------
+Build misskey with the following:
+
+`docker-compose build`
+
+*4.* That is it.
+----------------------------------------------------------------
+Well done! Now, you have an environment that run to Misskey.
+
+### Launch normally
+Just `docker-compose up -d`. GLHF!
+
+### Way to Update to latest version of your Misskey
+1. `git fetch`
+2. `git stash`
+3. `git checkout $(git tag -l | grep -v 'rc[0-9]*$' | sort -V | tail -n 1)`
+4. `git stash pop`
+5. `docker-compose build`
+6. Check [ChangeLog](../CHANGELOG.md) for migration information
+7. `docker-compose stop && docker-compose up -d`
+
+### Way to execute cli command:
+`docker-compose run --rm web node cli/mark-admin @example`
+
+----------------------------------------------------------------
+
+If you have any questions or troubles, feel free to contact us!
diff --git a/docs/docker.ja.md b/docs/docker.ja.md
new file mode 100644
index 0000000000..e38f3e91a6
--- /dev/null
+++ b/docs/docker.ja.md
@@ -0,0 +1,48 @@
+Dockerを使ったMisskey構築方法
+================================================================
+
+このガイドはDockerを使ったMisskeyセットアップ方法について解説します。
+
+[英語版もあります - English version also available](./docker.en.md)
+
+----------------------------------------------------------------
+
+*1.* 設定ファイルを作成する
+----------------------------------------------------------------
+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`を編集する
+
+*2.* Dockerの設定
+----------------------------------------------------------------
+`docker-compose.yml`を編集してください。
+
+*3.* Misskeyのビルド
+----------------------------------------------------------------
+次のコマンドでMisskeyをビルドしてください:
+
+`docker-compose build`
+
+*4.* 以上です!
+----------------------------------------------------------------
+お疲れ様でした。これでMisskeyを動かす準備は整いました。
+
+### 通常起動
+`docker-compose up -d`するだけです。GLHF!
+
+### Misskeyを最新バージョンにアップデートする方法:
+1. `git fetch`
+2. `git stash`
+3. `git checkout $(git tag -l | grep -v 'rc[0-9]*$' | sort -V | tail -n 1)`
+4. `git stash pop`
+5. `docker-compose build`
+6. [ChangeLog](../CHANGELOG.md)でマイグレーション情報を確認する
+7. `docker-compose stop && docker-compose up -d`
+
+### cliコマンドを実行する方法:
+
+`docker-compose run --rm web node cli/mark-admin @example`
+
+----------------------------------------------------------------
+
+なにかお困りのことがありましたらお気軽にご連絡ください。 \ No newline at end of file