misskey/README.md

Misskey

A miniblog-based SNS.

Dependencies

• Node.js
• MongoDB
• Redis
• GraphicsMagick

Optional

• Elasticsearch

Get started

Domains

Misskey requires two domains called the primary domain and the secondary domain.

• The primary domain is used to provide main service of Misskey.
• The secondary domain is used to avoid vulnerabilities such as XSS.

Ensure that the secondary domain is not a subdomain of the primary domain.

reCAPTCHA

Please visit https://www.google.com/recaptcha/intro/ and generate keys.

Build

1. git clone git://github.com/syuilo/misskey.git
2. cd misskey
3. npm install
4. npm run config
5. npm run build

Test

npm test

Launch

sudo npm start

License

MIT