summaryrefslogtreecommitdiff
path: root/docs/docker.en.md
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/docker.en.md
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/docker.en.md')
-rw-r--r--docs/docker.en.md47
1 files changed, 47 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!