2018-10-09 08:09:50 +02:00
|
|
|
Docker Guide
|
|
|
|
|
================================================================
|
|
|
|
|
|
|
|
|
|
This guide describes how to install and setup Misskey with Docker.
|
|
|
|
|
|
|
|
|
|
[Japanese version also available - 日本語版もあります](./docker.ja.md)
|
|
|
|
|
|
|
|
|
|
----------------------------------------------------------------
|
|
|
|
|
|
2018-10-24 07:36:42 +02: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.
|
|
|
|
|
|
2018-11-16 14:47:10 +01:00
|
|
|
*2.* Configure Misskey
|
2018-10-09 08:09:50 +02: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`.
|
2019-01-10 02:24:04 +01:00
|
|
|
3. Edit `default.yml` and `mongo_initdb.js`.
|
2018-10-09 08:09:50 +02:00
|
|
|
|
2018-10-24 07:36:42 +02:00
|
|
|
*3.* Configure Docker
|
2018-10-09 08:09:50 +02:00
|
|
|
----------------------------------------------------------------
|
|
|
|
|
Edit `docker-compose.yml`.
|
|
|
|
|
|
2018-10-24 07:36:42 +02:00
|
|
|
*4.* Build Misskey
|
2018-10-09 08:09:50 +02:00
|
|
|
----------------------------------------------------------------
|
|
|
|
|
Build misskey with the following:
|
|
|
|
|
|
|
|
|
|
`docker-compose build`
|
|
|
|
|
|
2018-10-24 07:36:42 +02:00
|
|
|
*5.* That is it.
|
2018-10-09 08:09:50 +02:00
|
|
|
----------------------------------------------------------------
|
2018-11-16 14:47:10 +01:00
|
|
|
Well done! Now you have an environment to run Misskey.
|
2018-10-09 08:09:50 +02:00
|
|
|
|
|
|
|
|
### Launch normally
|
|
|
|
|
Just `docker-compose up -d`. GLHF!
|
|
|
|
|
|
2018-11-16 14:47:10 +01:00
|
|
|
### How to update your Misskey server to the latest version
|
2018-10-09 08:09:50 +02: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`
|
|
|
|
|
|
2018-11-16 14:47:10 +01:00
|
|
|
### How to execute [cli commands](manage.en.md):
|
2018-10-09 08:09:50 +02:00
|
|
|
`docker-compose run --rm web node cli/mark-admin @example`
|
|
|
|
|
|
|
|
|
|
----------------------------------------------------------------
|
|
|
|
|
|
2018-11-16 14:47:10 +01:00
|
|
|
If you have any questions or trouble, feel free to contact us!
|
