Sharkey/docs/setup.en.md

139 lines
4.6 KiB
Markdown
Raw Normal View History

2017-05-18 08:56:23 +03:00
Misskey Setup and Installation Guide
================================================================
2017-11-12 13:25:18 +02:00
We thank you for your interest in setting up your Misskey server!
2017-05-18 09:05:48 +03:00
This guide describes how to install and setup Misskey.
2017-05-18 08:56:23 +03:00
2017-05-18 18:55:06 +03:00
[Japanese version also available - 日本語版もあります](./setup.ja.md)
2017-05-18 08:56:23 +03:00
2017-05-18 18:52:50 +03:00
----------------------------------------------------------------
2017-05-18 08:56:23 +03:00
2018-07-15 02:26:23 +03:00
*1.* Create Misskey user
2017-05-18 08:56:23 +03:00
----------------------------------------------------------------
2018-07-15 02:26:23 +03:00
Running misskey on root is not a good idea so we create a user for that.
In debian for exemple :
2017-05-18 08:56:23 +03:00
2018-07-15 03:43:16 +03:00
```
2018-07-15 02:26:23 +03:00
adduser --disabled-password --disabled-login misskey
```
2018-03-27 06:55:58 +03:00
*2.* Install dependencies
2017-05-18 08:56:23 +03:00
----------------------------------------------------------------
2017-05-18 18:52:50 +03:00
Please install and setup these softwares:
2017-05-18 08:56:23 +03:00
2017-05-18 18:52:50 +03:00
#### Dependencies :package:
2018-07-24 22:10:56 +03:00
* **[Node.js](https://nodejs.org/en/)**
2018-07-15 02:26:23 +03:00
* **[MongoDB](https://www.mongodb.com/)** >= 3.6
2017-05-18 18:52:50 +03:00
##### Optional
2018-10-11 09:50:27 +03:00
* [Redis](https://redis.io/)
* Redis is optional, but we strongly recommended to install it
* [Elasticsearch](https://www.elastic.co/) - required to enable the search feature
2017-05-18 18:52:50 +03:00
2018-07-23 14:48:55 +03:00
*3.* Setup MongoDB
2018-04-02 05:32:27 +03:00
----------------------------------------------------------------
2018-07-15 02:26:23 +03:00
In 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.
4. `db.createUser( { user: "misskey", pwd: "<password>", roles: [ { role: "readWrite", db: "misskey" } ] } )` Create the misskey user.
5. `exit` You're done !
*4.* Install Misskey
----------------------------------------------------------------
1. `su - misskey` Connect to misskey user.
2. `git clone -b master git://github.com/syuilo/misskey.git` Clone the misskey repo from master branch.
3. `cd misskey` Navigate to misskey directory
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.
2018-04-02 05:32:27 +03:00
2018-07-18 18:04:09 +03:00
*(optional)* reCAPTCHA tokens
2018-03-25 14:19:32 +03:00
----------------------------------------------------------------
2018-07-18 18:04:09 +03:00
If you want to enable reCAPTCHA, you need to generate reCAPTCHA tokens:
2018-07-15 02:26:23 +03:00
Please visit https://www.google.com/recaptcha/intro/ and generate keys.
*(optional)* Generating VAPID keys
----------------------------------------------------------------
2018-09-03 12:58:26 +03:00
If you want to enable ServiceWorker, you need to generate VAPID keys:
2018-07-15 02:26:23 +03:00
Unless you have set your global node_modules location elsewhere, you need to run this in root.
``` shell
npm install web-push -g
web-push generate-vapid-keys
```
2018-08-14 16:41:55 +03:00
*(optional)* Create a twitter application
----------------------------------------------------------------
2018-08-15 17:55:30 +03:00
If you want to enable the twitter integration, you need to create a twitter app at [https://developer.twitter.com/en/apply/user](https://developer.twitter.com/en/apply/user).
2018-08-14 16:41:55 +03:00
In the app you need to set the oauth callback url as : https://misskey-instance/api/tw/cb
2018-07-18 18:04:09 +03:00
*5.* Make configuration file
2018-07-15 02:26:23 +03:00
----------------------------------------------------------------
1. `cp .config/example.yml .config/default.yml` Copy the `.config/example.yml` and rename it to `default.yml`.
2018-07-15 03:43:16 +03:00
2. Edit `default.yml`
2017-05-18 08:56:23 +03:00
2018-07-18 18:04:09 +03:00
*6.* Build Misskey
2018-04-02 05:32:27 +03:00
----------------------------------------------------------------
2018-06-01 21:52:47 +03:00
Build misskey with the following:
`npm run build`
2018-06-01 21:24:30 +03:00
If you're on Debian, you will need to install the `build-essential` package.
2018-06-01 21:52:47 +03:00
If you're still encountering errors about some modules, use node-gyp:
2018-06-01 21:24:30 +03:00
2018-06-01 21:52:47 +03:00
1. `npm install -g node-gyp`
2. `node-gyp configure`
3. `node-gyp build`
4. `npm run build`
2017-05-18 08:56:23 +03:00
2018-07-18 18:04:09 +03:00
*7.* That is it.
2017-05-18 08:56:23 +03:00
----------------------------------------------------------------
2017-05-19 01:49:16 +03:00
Well done! Now, you have an environment that run to Misskey.
2017-05-18 08:56:23 +03:00
2018-07-15 02:26:23 +03:00
### Launch normally
Just `npm start`. GLHF!
### Launch with systemd
1. Create a systemd service here: `/etc/systemd/system/misskey.service`
2. Edit it, and paste this and save:
```
[Unit]
Description=Misskey daemon
[Service]
Type=simple
User=misskey
ExecStart=/usr/bin/npm start
WorkingDirectory=/home/misskey/misskey
TimeoutSec=60
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=misskey
Restart=always
[Install]
WantedBy=multi-user.target
```
3. `systemctl daemon-reload ; systemctl enable misskey` Reload systemd and enable the misskey service.
4. `systemctl start misskey` Start the misskey service.
You can check if the service is running with `systemctl status misskey`.
2017-05-18 08:56:23 +03:00
2018-04-02 05:34:35 +03:00
### Way to Update to latest version of your Misskey
2018-07-15 02:26:23 +03:00
1. `git fetch`
2. `git checkout $(git tag -l | grep -v 'rc[0-9]*$' | sort -V | tail -n 1)`
3. `npm install`
4. `npm run build`
2018-09-01 12:42:46 +03:00
5. Check [ChangeLog](../CHANGELOG.md) for migration information
2018-07-24 22:15:22 +03:00
----------------------------------------------------------------
If you have any questions or troubles, feel free to contact us!