summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2016-12-31 06:38:14 +0900
committersyuilo <syuilotan@yahoo.co.jp>2016-12-31 06:38:14 +0900
commitc3d5ed19b890ff6c4f3d2d21bf7cbab8d58bf913 (patch)
treeb41c8405d59cf448270eafd126e9e17e50c73902 /README.md
parentDesktop: Fix bug (diff)
downloadmisskey-c3d5ed19b890ff6c4f3d2d21bf7cbab8d58bf913.tar.gz
misskey-c3d5ed19b890ff6c4f3d2d21bf7cbab8d58bf913.tar.bz2
misskey-c3d5ed19b890ff6c4f3d2d21bf7cbab8d58bf913.zip
:v:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 83d6d93126..0ebd03d262 100644
--- a/README.md
+++ b/README.md
@@ -39,6 +39,22 @@ Misskey requires two domains called the primary domain and the secondary domain.
### reCAPTCHA
Please visit https://www.google.com/recaptcha/intro/ and generate keys.
+## Setup with Docker
+Ensure that the working directory is the repository root directory.
+
+To create misskey image:
+`sudo docker build -t misskey`
+
+To run misskey:
+`sudo docker run --rm -i -t -p $PORT:80 -v $(pwd):/root/misskey -v $DBPATH:/data/db misskey`
+
+where $PORT is the port used to access Misskey Web from host browser
+and $DBPATH is the path of MongoDB database on the host for data persistence.
+
+ex: `sudo docker run --rm -i -t -p 80:80 -v $(pwd):/root/misskey -v /data/db:/data/db misskey`
+
+Note that $(pwd) is the working directory.
+
## Launch
`sudo npm start`