summaryrefslogtreecommitdiff
path: root/docs/docker.en.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/docker.en.md')
-rw-r--r--docs/docker.en.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/docker.en.md b/docs/docker.en.md
new file mode 100644
index 0000000000..fc5f348bfb
--- /dev/null
+++ b/docs/docker.en.md
@@ -0,0 +1,23 @@
+Setup with Docker :whale:
+================================================================
+
+Ensure that the working directory is the repository root directory.
+
+To create misskey image:
+
+`sudo docker build -t misskey ./docker`
+
+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`
+
+If you want to run misskey in production mode, add `--env NODE_ENV=production` like this:
+
+`sudo docker run --rm -i -t -p 80:80 -v $(pwd):/root/misskey -v /data/db:/data/db --env NODE_ENV=production misskey`
+
+Note that `$(pwd)` is the working directory.