paricafe/docs/docker.en.md

Docker Guide
================================================================

This guide describes how to install and setup Misskey with Docker.

[Japanese version also available - 日本語版もあります](./docker.ja.md)

----------------------------------------------------------------

*1.* Download Misskey
----------------------------------------------------------------
1. `git clone -b master git://github.com/syuilo/misskey.git` Clone Misskey repository's master branch.
2. `cd misskey` Move to misskey directory.
3. `git checkout $(git tag -l | grep -v 'rc[0-9]*$' | sort -V | tail -n 1)` Checkout to the [latest release](https://github.com/syuilo/misskey/releases/latest) tag.

*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`.

*3.* Configure Docker
----------------------------------------------------------------
Edit `docker-compose.yml`.

*4.* Build Misskey
----------------------------------------------------------------
Build misskey with the following:

`docker-compose build`

*5.* That is it.
----------------------------------------------------------------
Well done! Now you have an environment to run Misskey.

### Launch normally
Just `docker-compose up -d`. GLHF!

### How to update your Misskey server to the latest version
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`

### How to execute [cli commands](manage.en.md):
`docker-compose run --rm web node cli/mark-admin @example`

----------------------------------------------------------------

If you have any questions or trouble, feel free to contact us!
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 2018-10-09 01:09:50 -05:00			`Docker Guide`
			`================================================================`

			`This guide describes how to install and setup Misskey with Docker.`

			`[Japanese version also available - 日本語版もあります](./docker.ja.md)`

			`----------------------------------------------------------------`

Docker関連の修正 (#2997) * Modify Dockerfile and docker-compose.yml * Fix MongoDB connection error * Use alpine-3.8 instead of alpine-edge as base image * Modify install packages * Modify Mongodb image tag name * Update Docker documents * Add 'Download misskey' paragraph * Make redis optional for Docker 2018-10-24 00:36:42 -05:00			`1. Download Misskey`
			`----------------------------------------------------------------`
			1. `git clone -b master git://github.com/syuilo/misskey.git` Clone Misskey repository's master branch.
			2. `cd misskey` Move to misskey directory.
			3. `git checkout $(git tag -l \| grep -v 'rc[0-9]*$' \| sort -V \| tail -n 1)` Checkout to the [latest release](https://github.com/syuilo/misskey/releases/latest) tag.

Update docker.en.md (#3272) 2018-11-16 07:47:10 -06:00			`2. Configure Misskey`
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 2018-10-09 01:09:50 -05:00			`----------------------------------------------------------------`
			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`.
Add manage and docker docs in french and correct mistake in english (#3863) 2019-01-09 19:24:04 -06:00			3. Edit `default.yml` and `mongo_initdb.js`.
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 2018-10-09 01:09:50 -05:00
Docker関連の修正 (#2997) * Modify Dockerfile and docker-compose.yml * Fix MongoDB connection error * Use alpine-3.8 instead of alpine-edge as base image * Modify install packages * Modify Mongodb image tag name * Update Docker documents * Add 'Download misskey' paragraph * Make redis optional for Docker 2018-10-24 00:36:42 -05:00			`3. Configure Docker`
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 2018-10-09 01:09:50 -05:00			`----------------------------------------------------------------`
			Edit `docker-compose.yml`.

Docker関連の修正 (#2997) * Modify Dockerfile and docker-compose.yml * Fix MongoDB connection error * Use alpine-3.8 instead of alpine-edge as base image * Modify install packages * Modify Mongodb image tag name * Update Docker documents * Add 'Download misskey' paragraph * Make redis optional for Docker 2018-10-24 00:36:42 -05:00			`4. Build Misskey`
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 2018-10-09 01:09:50 -05:00			`----------------------------------------------------------------`
			`Build misskey with the following:`

			`docker-compose build`

Docker関連の修正 (#2997) * Modify Dockerfile and docker-compose.yml * Fix MongoDB connection error * Use alpine-3.8 instead of alpine-edge as base image * Modify install packages * Modify Mongodb image tag name * Update Docker documents * Add 'Download misskey' paragraph * Make redis optional for Docker 2018-10-24 00:36:42 -05:00			`5. That is it.`
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 2018-10-09 01:09:50 -05:00			`----------------------------------------------------------------`
Update docker.en.md (#3272) 2018-11-16 07:47:10 -06:00			`Well done! Now you have an environment to run Misskey.`
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 2018-10-09 01:09:50 -05:00
			`### Launch normally`
			Just `docker-compose up -d`. GLHF!

Update docker.en.md (#3272) 2018-11-16 07:47:10 -06:00			`### How to update your Misskey server to the latest version`
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 2018-10-09 01:09:50 -05:00			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`

Update docker.en.md (#3272) 2018-11-16 07:47:10 -06:00			`### How to execute [cli commands](manage.en.md):`
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 2018-10-09 01:09:50 -05:00			`docker-compose run --rm web node cli/mark-admin @example`

			`----------------------------------------------------------------`

Update docker.en.md (#3272) 2018-11-16 07:47:10 -06:00			`If you have any questions or trouble, feel free to contact us!`