summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorZero King <l2dy@icloud.com>2018-11-16 13:31:53 +0000
committerAya Morisawa <AyaMorisawa4869@gmail.com>2018-11-16 22:31:53 +0900
commitba3e2a9371fd6e2d8c0aae0b4b84ab3fe0f42f15 (patch)
tree90f005e872074135ee90e08531031088d7b90710 /docs
parentRefactoring (diff)
downloadsharkey-ba3e2a9371fd6e2d8c0aae0b4b84ab3fe0f42f15.tar.gz
sharkey-ba3e2a9371fd6e2d8c0aae0b4b84ab3fe0f42f15.tar.bz2
sharkey-ba3e2a9371fd6e2d8c0aae0b4b84ab3fe0f42f15.zip
Update setup.en.md (#3270)
* [doc] run as root * [doc] update setup guide headings
Diffstat (limited to 'docs')
-rw-r--r--docs/setup.en.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/setup.en.md b/docs/setup.en.md
index adb07032e3..4b8ea45e94 100644
--- a/docs/setup.en.md
+++ b/docs/setup.en.md
@@ -10,7 +10,7 @@ This guide describes how to install and setup Misskey.
*1.* Create Misskey user
----------------------------------------------------------------
-Running misskey on root is not a good idea so we create a user for that.
+Running misskey as root is not a good idea so we create a user for that.
In debian for exemple :
```
@@ -32,7 +32,7 @@ Please install and setup these softwares:
*3.* Setup MongoDB
----------------------------------------------------------------
-In root :
+As root:
1. `mongo` Go to the mongo shell
2. `use misskey` Use the misskey database
3. `db.users.save( {dummy:"dummy"} )` Write dummy data to initialize the db.
@@ -47,17 +47,17 @@ In root :
4. `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)
5. `npm install` Install misskey dependencies.
-*(optional)* Generating VAPID keys
+*(optional)* Generate VAPID keys
----------------------------------------------------------------
If you want to enable ServiceWorker, you need to generate VAPID keys:
-Unless you have set your global node_modules location elsewhere, you need to run this in root.
+Unless you have set your global node_modules location elsewhere, you need to run this as root.
``` shell
npm install web-push -g
web-push generate-vapid-keys
```
-*5.* Make configuration file
+*5.* Configure Misskey
----------------------------------------------------------------
1. `cp .config/example.yml .config/default.yml` Copy the `.config/example.yml` and rename it to `default.yml`.
2. Edit `default.yml`
@@ -114,7 +114,7 @@ WantedBy=multi-user.target
You can check if the service is running with `systemctl status misskey`.
-### Way to Update to latest version of your Misskey
+### How to update your Misskey server to the latest version
1. `git fetch`
2. `git checkout $(git tag -l | grep -v 'rc[0-9]*$' | sort -V | tail -n 1)`
3. `npm install`