amechama/sharkey
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update setup.en.md (#3270)

Browse Source 
* [doc] run as root

* [doc] update setup guide headings
This commit is contained in:
Zero King 2018-11-16 13:31:53 +00:00 committed by Aya Morisawa
parent 831e8f8583
commit ba3e2a9371
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/setup.en.md
View File

@ -10,7 +10,7 @@ This guide describes how to install and setup Misskey.
*1.* Create Misskey user *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 : In debian for exemple :
``` ```
@ -32,7 +32,7 @@ Please install and setup these softwares:
*3.* Setup MongoDB *3.* Setup MongoDB
---------------------------------------------------------------- ----------------------------------------------------------------
In root : As root:
1. `mongo` Go to the mongo shell 1. `mongo` Go to the mongo shell
2. `use misskey` Use the misskey database 2. `use misskey` Use the misskey database
3. `db.users.save( {dummy:"dummy"} )` Write dummy data to initialize the db. 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) 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. 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: 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 ``` shell
npm install web-push -g npm install web-push -g
web-push generate-vapid-keys 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`. 1. `cp .config/example.yml .config/default.yml` Copy the `.config/example.yml` and rename it to `default.yml`.
2. Edit `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`. 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` 1. `git fetch`
2. `git checkout $(git tag -l | grep -v 'rc[0-9]*$' | sort -V | tail -n 1)` 2. `git checkout $(git tag -l | grep -v 'rc[0-9]*$' | sort -V | tail -n 1)`
3. `npm install` 3. `npm install`