forked from mirror/misskey
eb14acbe0c
Replace the "Checkout to Latest Release" command. Current setup document will checkout latest alpha version. Because grep command in the document does not exclude alpha version tags.
122 lines
3.7 KiB
Markdown
122 lines
3.7 KiB
Markdown
Misskey Setup and Installation Guide
|
|
================================================================
|
|
|
|
We thank you for your interest in setting up your Misskey server!
|
|
This guide describes how to install and setup Misskey.
|
|
|
|
[Japanese version also available - 日本語版もあります](./setup.ja.md)
|
|
|
|
----------------------------------------------------------------
|
|
|
|
*1.* Create Misskey user
|
|
----------------------------------------------------------------
|
|
Running misskey as root is not a good idea so we create a user for that.
|
|
In debian for exemple :
|
|
|
|
```
|
|
adduser --disabled-password --disabled-login misskey
|
|
```
|
|
|
|
*2.* Install dependencies
|
|
----------------------------------------------------------------
|
|
Please install and setup these softwares:
|
|
|
|
#### Dependencies :package:
|
|
* **[Node.js](https://nodejs.org/en/)** >= 11.7.0
|
|
* **[PostgreSQL](https://www.postgresql.org/)** >= 10
|
|
|
|
##### Optional
|
|
* [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
|
|
* [FFmpeg](https://www.ffmpeg.org/)
|
|
|
|
*3.* Setup PostgreSQL
|
|
----------------------------------------------------------------
|
|
:)
|
|
|
|
*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 -Ev -- '-(rc|alpha)\.[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.* 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`
|
|
|
|
*6.* Build Misskey
|
|
----------------------------------------------------------------
|
|
|
|
Build misskey with the following:
|
|
|
|
`NODE_ENV=production npm run build`
|
|
|
|
If you're on Debian, you will need to install the `build-essential`, `python` package.
|
|
|
|
If you're still encountering errors about some modules, use node-gyp:
|
|
|
|
1. `npm install -g node-gyp`
|
|
2. `node-gyp configure`
|
|
3. `node-gyp build`
|
|
4. `NODE_ENV=production npm run build`
|
|
|
|
*7.* Init DB
|
|
----------------------------------------------------------------
|
|
``` shell
|
|
npm run init
|
|
```
|
|
|
|
*8.* That is it.
|
|
----------------------------------------------------------------
|
|
Well done! Now, you have an environment that run to Misskey.
|
|
|
|
### Launch normally
|
|
Just `NODE_ENV=production 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
|
|
Environment="NODE_ENV=production"
|
|
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`.
|
|
|
|
### How to update your Misskey server to the latest version
|
|
1. `git fetch`
|
|
2. `git checkout $(git tag -l | grep -Ev -- '-(rc|alpha)\.[0-9]+$' | sort -V | tail -n 1)`
|
|
3. `npm install`
|
|
4. `NODE_ENV=production npm run build`
|
|
5. Check [ChangeLog](../CHANGELOG.md) for migration information
|
|
6. Restart your Misskey process to apply changes
|
|
7. Enjoy
|
|
|
|
----------------------------------------------------------------
|
|
|
|
If you have any questions or troubles, feel free to contact us!
|