misskey/README.md

165 lines
5.2 KiB
Markdown
Raw Normal View History

2017-02-22 12:19:34 +01:00
Misskey
================================
2016-12-28 23:49:51 +01:00
[![][travis-badge]][travis-link]
[![][dependencies-badge]][dependencies-link]
2017-01-24 10:41:07 +01:00
[![][himawari-badge]][himasaku]
[![][sakurako-badge]][himasaku]
2017-02-26 20:02:24 +01:00
[![][mit-badge]][mit]
2017-01-24 10:41:07 +01:00
2016-12-31 05:37:21 +01:00
Welcome!
2017-02-22 12:19:34 +01:00
[Misskey](https://misskey.xyz) is a completely open source,
ultimately sophisticated new type of mini-blog based SNS.
2016-12-28 23:49:51 +01:00
2016-12-29 12:43:33 +01:00
![ss](./resources/ss.jpg)
2017-02-22 12:19:34 +01:00
Key features
--------------------------------
2016-12-31 06:15:37 +01:00
* Automatically updated timeline
2017-02-27 10:16:01 +01:00
* Private messages
2016-12-31 06:15:49 +01:00
* Free 1GB storage
2016-12-31 06:11:31 +01:00
* Mobile device support (smartphone, tablet, etc)
2017-02-28 14:27:26 +01:00
* Web API for Third-party applications
2017-02-27 06:31:38 +01:00
* Twitter integration
2016-12-31 06:11:31 +01:00
2017-01-02 21:28:54 +01:00
and more! You can touch with your own eyes at https://misskey.xyz/.
2016-12-31 06:11:31 +01:00
2017-02-22 12:19:34 +01:00
Setup
--------------------------------
2016-12-30 23:06:38 +01:00
### Dependencies :package:
2016-12-30 18:47:45 +01:00
Please install these softwares.
2017-02-22 12:19:34 +01:00
* *Node.js* and *npm*
2016-12-30 21:25:26 +01:00
* **[MongoDB](https://www.mongodb.com/)**
* **[Redis](https://redis.io/)**
* **[GraphicsMagick](http://www.graphicsmagick.org/)**
2016-12-30 23:06:38 +01:00
#### Optional
2016-12-31 05:05:15 +01:00
* [Elasticsearch](https://www.elastic.co/) - used to provide searching feature instead of MongoDB
2016-12-28 23:49:51 +01:00
2016-12-29 16:23:25 +01:00
### Domains
2016-12-28 23:49:51 +01:00
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.**
2017-02-20 23:34:14 +01:00
#### Subdomains
2017-02-22 12:19:34 +01:00
Note that Misskey uses following subdomains:
2017-02-20 23:34:14 +01:00
* **api**.*{primary domain}*
* **auth**.*{primary domain}*
* **about**.*{primary domain}*
* **dev**.*{primary domain}*
* **file**.*{secondary domain}*
2017-02-14 16:44:07 +01:00
2017-02-22 12:19:34 +01:00
### reCAPTCHA tokens
2016-12-30 18:39:46 +01:00
Please visit https://www.google.com/recaptcha/intro/ and generate keys.
2016-12-29 16:23:25 +01:00
2017-02-22 12:19:34 +01:00
Setup with Docker :whale:
--------------------------------
2016-12-30 22:38:14 +01:00
Ensure that the working directory is the repository root directory.
To create misskey image:
2016-12-31 09:33:53 +01:00
2016-12-31 05:00:11 +01:00
`sudo docker build -t misskey ./docker`
2016-12-30 22:38:14 +01:00
To run misskey:
2016-12-31 09:33:53 +01:00
2016-12-30 22:38:14 +01:00
`sudo docker run --rm -i -t -p $PORT:80 -v $(pwd):/root/misskey -v $DBPATH:/data/db misskey`
2016-12-31 09:36:11 +01:00
where `$PORT` is the port used to access Misskey Web from host browser
and `$DBPATH` is the path of MongoDB database on the host for data persistence.
2016-12-30 22:38:14 +01:00
ex: `sudo docker run --rm -i -t -p 80:80 -v $(pwd):/root/misskey -v /data/db:/data/db misskey`
2016-12-31 09:33:53 +01:00
If you want to run misskey in production mode, add `--env NODE_ENV=production` like this:
2016-12-31 09:35:07 +01:00
`sudo docker run --rm -i -t -p 80:80 -v $(pwd):/root/misskey -v /data/db:/data/db --env NODE_ENV=production misskey`
2016-12-31 09:33:53 +01:00
2016-12-31 09:36:11 +01:00
Note that `$(pwd)` is the working directory.
2016-12-30 22:38:14 +01:00
2017-02-28 12:18:51 +01:00
Install
2017-02-22 12:19:34 +01:00
--------------------------------
2017-02-28 12:59:01 +01:00
### Using built code
1. `git clone -b release git://github.com/syuilo/misskey.git`
2017-02-28 13:23:57 +01:00
2. `cd misskey`
3. `npm install`
2017-02-28 12:18:51 +01:00
2017-02-28 12:59:01 +01:00
#### Update
2017-03-01 09:47:22 +01:00
1. `git fetch`
2. `git reset --hard origin/release`
3. `npm install`
2017-02-28 12:59:01 +01:00
### Using source code
1. `git clone -b master git://github.com/syuilo/misskey.git`
2017-02-28 13:23:57 +01:00
2. `cd misskey`
3. `npm install`
4. `npm run build`
2017-02-22 12:19:34 +01:00
2017-02-28 12:59:01 +01:00
#### Update
2017-03-01 09:47:22 +01:00
1. `git pull origin master`
2. `npm install`
3. `npm run build`
2017-02-28 12:59:01 +01:00
2017-02-22 12:19:34 +01:00
Launch
--------------------------------
2017-03-01 09:47:22 +01:00
1. `sudo npm start`
2016-12-28 23:49:51 +01:00
2017-02-28 12:18:51 +01:00
GLHF!
2017-02-22 12:19:34 +01:00
Testing
--------------------------------
Run `npm test` after building
Debugging :bug:
--------------------------------
2017-02-28 13:01:01 +01:00
### Show debug messages
2017-02-28 12:59:15 +01:00
Misskey uses [debug](https://github.com/visionmedia/debug) and the namespace is `misskey:*`.
2017-01-23 10:25:52 +01:00
2017-02-22 12:19:34 +01:00
Contribute
--------------------------------
2016-12-30 19:50:21 +01:00
Do you have feature request or problem with Misskey?
2016-12-31 10:16:27 +01:00
Please create issue to report it if it is about the Misskey implementation itself.
2016-12-30 19:50:21 +01:00
Currently Misskey is missing documents so writing documents would be appreciated.
Pull requests are always welcome.
2017-01-24 06:52:59 +01:00
*We love contributions from anybody.*
2016-12-30 20:02:01 +01:00
2016-12-30 23:09:29 +01:00
[Contribution guide](./CONTRIBUTING.md)
2016-12-30 21:35:23 +01:00
### TODO
2016-12-30 23:15:48 +01:00
* More [tests](./test)!
* More [docs](./docs)!
2017-02-28 12:59:38 +01:00
* More sophisticated code!
2016-12-30 21:35:23 +01:00
2017-02-22 12:19:34 +01:00
Collaborators
------------------------------
2017-03-01 09:02:07 +01:00
| ![syuilo][syuilo-icon] | ![Morisawa Aya][ayamorisawa-icon] | ![otofune][otofune-icon] |
|------------------------|-----------------------------------|---------------------------------|
| [syuilo][syuilo-link] | [Aya Morisawa][ayamorisawa-link] | [Otoha Funabashi][otofune-link] |
2017-01-18 11:40:18 +01:00
2017-02-22 12:19:34 +01:00
Copyright
------------------------------
2017-01-19 12:44:19 +01:00
Misskey is an open-source software licensed under [The MIT License](LICENSE).
2016-12-28 23:49:51 +01:00
[mit]: http://opensource.org/licenses/MIT
[mit-badge]: https://img.shields.io/badge/license-MIT-444444.svg?style=flat-square
[travis-link]: https://travis-ci.org/syuilo/misskey
2017-02-26 17:46:43 +01:00
[travis-badge]: http://img.shields.io/travis/syuilo/misskey/master.svg?style=flat-square
2016-12-28 23:49:51 +01:00
[dependencies-link]: https://gemnasium.com/syuilo/misskey
[dependencies-badge]: https://img.shields.io/gemnasium/syuilo/misskey.svg?style=flat-square
2017-01-24 10:41:07 +01:00
[himasaku]: https://himasaku.net
[himawari-badge]: https://img.shields.io/badge/%E5%8F%A4%E8%B0%B7-%E5%90%91%E6%97%A5%E8%91%B5-1684c5.svg?style=flat-square
[sakurako-badge]: https://img.shields.io/badge/%E5%A4%A7%E5%AE%A4-%E6%AB%BB%E5%AD%90-efb02a.svg?style=flat-square
2017-03-01 09:02:07 +01:00
<!-- Collaborators Info -->
[syuilo-link]: https://syuilo.com
[syuilo-icon]: https://avatars2.githubusercontent.com/u/4439005?v=3&s=70
[ayamorisawa-link]: https://github.com/ayamorisawa
[ayamorisawa-icon]: https://avatars0.githubusercontent.com/u/10798641?v=3&s=70
[otofune-link]: https://github.com/otofune
[otofune-icon]: https://avatars0.githubusercontent.com/u/15062473?v=3&s=70