mirror of
https://github.com/misskey-dev/misskey
synced 2024-09-12 20:11:10 +02:00
3.8 KiB
3.8 KiB
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 - 日本語版もあります
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 📦
Optional
- Redis
- Redis is optional, but we strongly recommended to install it
- Elasticsearch - required to enable the search feature
3. Setup MongoDB
As root:
mongo
Go to the mongo shelluse misskey
Use the misskey databasedb.users.save( {dummy:"dummy"} )
Write dummy data to initialize the db.db.createUser( { user: "misskey", pwd: "<password>", roles: [ { role: "readWrite", db: "misskey" } ] } )
Create the misskey user.exit
You're done !
4. Install Misskey
su - misskey
Connect to misskey user.git clone -b master git://github.com/syuilo/misskey.git
Clone the misskey repo from master branch.cd misskey
Navigate to misskey directorygit checkout $(git tag -l | grep -v 'rc[0-9]*$' | sort -V | tail -n 1)
Checkout to the latest releasenpm install
Install misskey dependencies.
5. Configure Misskey
cp .config/example.yml .config/default.yml
Copy the.config/example.yml
and rename it todefault.yml
.- Edit
default.yml
6. Build Misskey
Build misskey with the following:
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:
npm install -g node-gyp
node-gyp configure
node-gyp build
npm run build
7. That is it.
Well done! Now, you have an environment that run to Misskey.
Launch normally
Just npm start
. GLHF!
Launch with systemd
- Create a systemd service here:
/etc/systemd/system/misskey.service
- 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
systemctl daemon-reload ; systemctl enable misskey
Reload systemd and enable the misskey service.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
git fetch
git checkout $(git tag -l | grep -v 'rc[0-9]*$' | sort -V | tail -n 1)
npm install
npm run build
- Check ChangeLog for migration information
- Restart your Misskey process to apply changes
- Enjoy
If you have any questions or troubles, feel free to contact us!