mirror/misskey
1
0
Fork 0
mirror of https://github.com/misskey-dev/misskey synced 2024-12-15 07:09:01 +09:00
Code
7d70126072
misskey/docs/docker.en.md
かひわし4（バージョン1） 2e55aea584 Doc: Update setup documents (#4680) 
* Doc: Update setup documents

Use GitHub api to checkout latest release instead of "git tag" command
which cannot accurately determine prerelease tag.
Also, Changed numbered list format because
the shell command is too long to fit on one line.

* Doc: Use tab instead of spaces

* Doc: Use master branch as latest release tag

master branch and latest release is the same.
master branch merges develop branch with each latest release.
2019-04-17 02:15:27 +09:00

2.6 KiB
Raw Blame History

Docker Guide

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

Japanese version also available - 日本語版もあります

1. Download Misskey

  1. Clone Misskey repository's master branch.

    git clone -b master git://github.com/syuilo/misskey.git

  2. Move to misskey directory.

    cd misskey

  3. Checkout to the latest release tag.

    git checkout master

2. Configure Misskey

Create configuration files with following:

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

Edit docker-compose.yml.

4. Build Misskey

Build misskey with the following:

docker-compose build

5. Init DB

docker-compose run --rm web npm run init

6. 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 stash
  2. git checkout master
  3. git pull
  4. git stash pop
  5. docker-compose build
  6. Check ChangeLog for migration information
  7. docker-compose stop && docker-compose up -d

How to execute cli commands:

docker-compose run --rm web node cli/mark-admin @example

If you have any questions or trouble, feel free to contact us!