Skip to content
Snippets Groups Projects
README.md 13.1 KiB
Newer Older
Gabriel Engel's avatar
Gabriel Engel committed
![Rocket.Chat logo](https://rocket.chat/images/logo/logo-dark.svg?v3)
Gabriel Engel's avatar
Gabriel Engel committed

S. Li's avatar
S. Li committed
The Ultimate Open Source WebChat Platform
Gabriel Engel's avatar
Gabriel Engel committed

Gabriel Engel's avatar
Gabriel Engel committed

Checkout the latest version at [https://demo.rocket.chat](https://demo.rocket.chat)
Gabriel Engel's avatar
Gabriel Engel committed

S. Li's avatar
S. Li committed
Available from the AppStore:

frankenbot's avatar
frankenbot committed
[![Rocket.Chat on Apple AppStore](http://linkmaker.itunes.apple.com/images/badges/en-us/badge_appstore-lrg.svg)](https://itunes.apple.com/us/app/rocket.chat/id1028869439?mt=8)
Get the app for your Android phone:
S. Li's avatar
S. Li committed

S. Li's avatar
S. Li committed

S. Li's avatar
S. Li committed
[![Rocket.Chat on Google Play](https://developer.android.com/images/brand/en_app_rgb_wo_45.png)](https://play.google.com/store/apps/details?id=com.konecty.rocket.chat)
S. Li's avatar
S. Li committed

Now compatible with all Android devices as old as version 4.0.x - [download here](https://github.com/RocketChat/Rocket.Chat/wiki/Build-the-Android-Cordova-Web-App-and-connect-to-your-own-Rocket.Chat-Server), even on BlackBerry Passport!
Host your own Rocket.Chat server in four seconds flat:

westmakaha's avatar
westmakaha committed
[![Rocket.Chat on Sandstorm.io](https://raw.githubusercontent.com/Sing-Li/bbug/master/images/sandstorm.jpg)](https://apps.sandstorm.io/app/vfnwptfn02ty21w715snyyczw0nqxkv3jvawcah10c6z7hj1hnu0)
_*Grab*_ the latest [Sandstorm SPK](https://s3.amazonaws.com/rocketchatbuild/rocket.chat.latest.spk) for testing on your own server.

Or run solid five-nines deployment on industry workhorse FreeBSD server:

[![FreeBSD Daemon](https://raw.githubusercontent.com/Sing-Li/bbug/master/images/freebsd.png)](https://github.com/RocketChat/Rocket.Chat/wiki/FreeBSD)

SingLi's avatar
SingLi committed
Also available as FirefoxOS app:

[![Firefox OS app now available](https://raw.githubusercontent.com/Sing-Li/bbug/master/images/firefoxos.png)](https://github.com/RocketChat/Rocket.Chat/wiki/Native-Firefox-OS-app-%28hosted-webapp%29)


Try it on Ubuntu:

[Deploy on VPS or standalone server](https://github.com/RocketChat/Rocket.Chat/wiki/Deploy-Rocket.Chat-without-docker)

Mike's avatar
Mike committed
Try it with docker:

S. Li's avatar
S. Li committed
[Deploy with docker](https://github.com/RocketChat/Rocket.Chat/wiki/Deploy-with-Docker)
Mike's avatar
Mike committed


Gabriel Engel's avatar
Gabriel Engel committed
Download the Native Cross-Platform Desktop Application at [Rocket.Chat.Electron](https://github.com/RocketChat/Rocket.Chat.Electron/releases)

Gabriel Engel's avatar
Gabriel Engel committed
[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=49QX7TYCVZK8L)

Gabriel Engel's avatar
Gabriel Engel committed
## About

Gabriel Engel's avatar
Gabriel Engel committed
[![Build Status](https://img.shields.io/travis/RocketChat/Rocket.Chat/master.svg)](https://travis-ci.org/RocketChat/Rocket.Chat)
[![Coverage Status](https://coveralls.io/repos/RocketChat/Rocket.Chat/badge.svg)](https://coveralls.io/r/RocketChat/Rocket.Chat)
[![Code Climate](https://codeclimate.com/github/RocketChat/Rocket.Chat/badges/gpa.svg)](https://codeclimate.com/github/RocketChat/Rocket.Chat)
frankenbot's avatar
frankenbot committed
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/RocketChat/Rocket.Chat/raw/master/LICENSE)
Gabriel Engel's avatar
Gabriel Engel committed
[![Stories in Ready](https://badge.waffle.io/RocketChat/Rocket.Chat.png?label=ready&title=Ready)](https://waffle.io/RocketChat/Rocket.Chat)
Gabriel Engel's avatar
Gabriel Engel committed

Henry Hsiao's avatar
Henry Hsiao committed
Rocket.Chat is a Web Chat Server, developed in JavaScript, using the [Meteor](https://www.meteor.com/install) fullstack framework.
Gabriel Engel's avatar
Gabriel Engel committed

It is a great solution for communities and companies wanting to privately host their own chat service or for developers looking forward to build and evolve their own chat platforms.

Gabriel Engel's avatar
Gabriel Engel committed
### On the News
Gabriel Engel's avatar
Gabriel Engel committed

Gabriel Engel's avatar
Gabriel Engel committed
##### [Hacker News](https://news.ycombinator.com/item?id=9624737)
> Yes, we made it to the #1
Gabriel Engel's avatar
Gabriel Engel committed

frankenbot's avatar
frankenbot committed
##### [Product Hunt](https://www.producthunt.com/tech/rocket-chat)
Gabriel Engel's avatar
Gabriel Engel committed
> Your own open source Slack-like chat
Gabriel Engel's avatar
Gabriel Engel committed

Gabriel Engel's avatar
Gabriel Engel committed
##### [JavaScript Weekly](http://javascriptweekly.com/issues/234)
> An open source Web based, channel based chat system (a la Slack) built using Meteor, the full stack JavaScript development platform.
Gabriel Engel's avatar
Gabriel Engel committed

##### [Open Source China](http://www.oschina.net/p/rocket-chat)
> Rocket.Chat 是特性最丰富的 Slack 开源替代品之一。 主要功能:群组聊天,直接通信,私聊群,桌面通知,媒体嵌入,链接预览,文件上传,语音/视频 聊天,截图等等。

Gabriel Engel's avatar
Gabriel Engel committed
##### [wwwhatsnew.com](http://wwwhatsnew.com/2015/05/30/rocket-chat-para-los-programadores-que-quieran-ofrecer-un-chat-en-su-web/)
> Para los programadores que quieran ofrecer un chat en su web
Gabriel Engel's avatar
Gabriel Engel committed

Gabriel Engel's avatar
Gabriel Engel committed
##### [clasesdeperiodismo.com](http://www.clasesdeperiodismo.com/2015/05/30/un-chat-de-codigo-abierto-que-puedes-anadir-a-la-web/)
> Un chat de código abierto que puedes añadir a la web
Gabriel Engel's avatar
Gabriel Engel committed

Marcelo Schmidt's avatar
Marcelo Schmidt committed
##### [snowulf.com](https://snowulf.com/2015/09/25/why-slack-when-you-can-rocket-chat/)
> Why Slack when you can Rocket.chat?

Marcelo Schmidt's avatar
Marcelo Schmidt committed
##### [liminality.xyz](http://liminality.xyz/self-hosting/)
> Self-hosted alternatives to popular cloud services
Gabriel Engel's avatar
Gabriel Engel committed
## Features

- BYOS (bring your own server)
- Multiple Rooms
Gabriel Engel's avatar
Gabriel Engel committed
- Direct Messages
- Private Groups
- Public Channels
- Desktop Notifications
- Mentions
- Avatars
- Markdown
- Emojis
S. Li's avatar
S. Li committed
- Media Embeds
- Link Previews
S. Li's avatar
S. Li committed
- Sent Message Edit and Deletion
- Transcripts / History
Gabriel Engel's avatar
Gabriel Engel committed
- File Upload / Sharing
- Full text search
- Live chat / Messaging call center
- LDAP Authentication
- Support for Okta SSO through SAML v2
- I18n - Supports 22 Languages
S. Li's avatar
S. Li committed
- Hubot Friendly
- Face to Face Video Conferencing (aka WebRTC)
- Multi-users Video Group Chat
- Audio calls
- Multi-users Audio Conference
- Screensharing
- REST APIs
- Remote Locations Video Monitoring
S. Li's avatar
S. Li committed
- Chat-ops powered by Hubot: scalable horizontal app integration (early access)
SingLi's avatar
SingLi committed
- Massively scalable hosting and provisioning (beta testing now)
S. Li's avatar
S. Li committed
- Native Cross-Platform Desktop Application [Windows, Mac OSX, or Linux](https://rocket.chat/)
S. Li's avatar
S. Li committed
- Mobile app for iPhone, iPad, and iPod touch [Download on AppStore!](https://geo.itunes.apple.com/us/app/rocket.chat/id1028869439?mt=8)
- Mobile app for Android phone, tablet, and TV stick [Available now on Google Play!](https://play.google.com/store/apps/details?id=com.konecty.rocket.chat)
- Native Firefox OS Application (also for Desktop Firefox and Firefox for Android!) - [Check the wiki page for install instructions](https://github.com/RocketChat/Rocket.Chat/wiki/Native-Firefox-OS-app-%28hosted-webapp%29)
S. Li's avatar
S. Li committed
- Sandstorm.io instant Rocket.Chat server [Now on Sandstorm App Store](https://apps.sandstorm.io/app/vfnwptfn02ty21w715snyyczw0nqxkv3jvawcah10c6z7hj1hnu0)
Gabriel Engel's avatar
Gabriel Engel committed
### Roadmap
Gabriel Engel's avatar
Gabriel Engel committed

Gabriel Engel's avatar
Gabriel Engel committed
#### In Progress
S. Li's avatar
S. Li committed
- Support multiple teams on the same instance / same VPS infrastructure: [Issue #658](https://github.com/RocketChat/Rocket.Chat/issues/658), [Issue #630](https://github.com/RocketChat/Rocket.Chat/issues/630)
frankenbot's avatar
frankenbot committed
- Support for PostgreSQL: [Issue #533](https://github.com/RocketChat/Rocket.Chat/issues/533), [Issue #822](https://github.com/RocketChat/Rocket.Chat/pull/822)
Marcelo Schmidt's avatar
Marcelo Schmidt committed
- Native iOS Application [Issue #270](https://github.com/RocketChat/Rocket.Chat/issues/270), [Rocket.Chat.iOS - HELP WANTED](https://github.com/RocketChat/Rocket.Chat.iOS)
Gabriel Engel's avatar
Gabriel Engel committed
- Native Android Application [Issue #271 - HELP WANTED](https://github.com/RocketChat/Rocket.Chat/issues/271)
Marcelo Schmidt's avatar
Marcelo Schmidt committed
- Off-the-Record (OTR) Messaging [Issue #36](https://github.com/RocketChat/Rocket.Chat/issues/36), [Issue #268 - HELP WANTED](https://github.com/RocketChat/Rocket.Chat/issues/268)
- API-enabled methods: [Issue #202](https://github.com/RocketChat/Rocket.Chat/issues/202), [Issue #454](https://github.com/RocketChat/Rocket.Chat/issues/454), [Issue #455](https://github.com/RocketChat/Rocket.Chat/issues/455), [Issue #759](https://github.com/RocketChat/Rocket.Chat/issues/759)
S. Li's avatar
S. Li committed
- Scalable WebRTC broadcaster / media-server integration, [Issue #1118 - HELP WANTED](https://github.com/RocketChat/Rocket.Chat/issues/1118)
S. Li's avatar
S. Li committed

Gabriel Engel's avatar
Gabriel Engel committed

Gabriel Engel's avatar
Gabriel Engel committed
#### Planned
Marcelo Schmidt's avatar
Marcelo Schmidt committed
- Kerberos Authentication: [Issue #839](https://github.com/RocketChat/Rocket.Chat/issues/839)
- XMPP Multi-user chat (MUC): [Issue #404](https://github.com/RocketChat/Rocket.Chat/issues/404)
- More webhooks: GitLab, Confluence, Jira, Piwik, Wordpress: [Issue #233](https://github.com/RocketChat/Rocket.Chat/issues/233), [Issue #525](https://github.com/RocketChat/Rocket.Chat/issues/525), [Issue #637](https://github.com/RocketChat/Rocket.Chat/issues/637), [Issue #638](https://github.com/RocketChat/Rocket.Chat/issues/638), [Issue #747](https://github.com/RocketChat/Rocket.Chat/issues/747)
Rainer Eli's avatar
Rainer Eli committed
- Clusterize / Decentralize: [Issue #520](https://github.com/RocketChat/Rocket.Chat/issues/520), [Issue #601](https://github.com/RocketChat/Rocket.Chat/issues/601)
Marcelo Schmidt's avatar
Marcelo Schmidt committed
- Anonymous use of Rocket.Chat: [Issue #604](https://github.com/RocketChat/Rocket.Chat/issues/604)
- File Sharing via P2P and Scalable Multicast: [Issue #369](https://github.com/RocketChat/Rocket.Chat/issues/369), [Issue #370](https://github.com/RocketChat/Rocket.Chat/issues/370)
- Anti-virus checking on file uploads: [Issue #757](https://github.com/RocketChat/Rocket.Chat/issues/757)
Gabriel Engel's avatar
Gabriel Engel committed

### Issues

[Github Issues](https://github.com/RocketChat/Rocket.Chat/issues) are used to track todos, bugs, feature requests, and more.

Gabriel Engel's avatar
Gabriel Engel committed
### Integrations
Gabriel Engel's avatar
Gabriel Engel committed

#### Hubot

The docker image is ready.
Everyone can start hacking the adapter code, or launch his/her own bot within a few minutes now.
Please head over to the [Hubot Integration Project](https://github.com/RocketChat/hubot-rocketchat) for more information.

#### Chat-ops integrations powered by Hubot
S. Li's avatar
S. Li committed

Integrate your application with fly-in panels today!   Early access is available for developers.

S. Li's avatar
S. Li committed
![Sample integration of a Drones Fleet Management System](https://raw.githubusercontent.com/Sing-Li/bbug/master/images/dronechatops.png)
Gabriel Engel's avatar
Gabriel Engel committed
#### Many, many, many more to come!

We are developing the APIs based on the competition, so stay tuned and you will see a lot happening here.
Gabriel Engel's avatar
Gabriel Engel committed
### Documentation

Gabriel Engel's avatar
Gabriel Engel committed
Checkout [Github Wiki](https://github.com/RocketChat/Rocket.Chat/wiki)
Gabriel Engel's avatar
Gabriel Engel committed

Gabriel Engel's avatar
Gabriel Engel committed
## Production Deployment

### Ubuntu VPS or server

Follow these [deployment instructions](https://github.com/RocketChat/Rocket.Chat/wiki/Deploy-Rocket.Chat-without-docker).

### Ubuntu Software Center

Easy one click install right from your Ubuntu Desktop (coming soon)

[![Ubuntu Software Center](https://raw.githubusercontent.com/Sing-Li/bbug/master/images/ubuntusoft.png)]()


Gabriel Engel's avatar
Gabriel Engel committed
### Docker

frankenbot's avatar
frankenbot committed
Use the automated build at our [Official Docker Registry](https://hub.docker.com/r/rocketchat/rocket.chat/)
Gabriel Engel's avatar
Gabriel Engel committed

frankenbot's avatar
frankenbot committed
[![Rocket.Chat logo](https://d207aa93qlcgug.cloudfront.net/1.95.5.qa/img/nav/docker-logo-loggedout.png)](https://hub.docker.com/r/rocketchat/rocket.chat/)
Gabriel Engel's avatar
Gabriel Engel committed

```
docker pull rocketchat/rocket.chat
```

Mike's avatar
Mike committed
### sloppy.io
Mike's avatar
Mike committed
Host your docker container at [sloppy.io](http://sloppy.io). Get an account and use the [quickstarter](https://github.com/sloppyio/quickstarters/tree/master/rocketchat)
Gabriel Engel's avatar
Gabriel Engel committed
### Heroku

Host your own Rocket.Chat server for **FREE** with [One-Click Deploy](https://heroku.com/deploy?template=https://github.com/RocketChat/Rocket.Chat/tree/master)

Branch **master** (Latest stable version):
Gabriel Engel's avatar
Gabriel Engel committed
[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/RocketChat/Rocket.Chat/tree/master)
Branch **develop** (Newer but unstable):
[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/RocketChat/Rocket.Chat/tree/develop)
Gabriel Engel's avatar
Gabriel Engel committed
## Development Installation

Prerequisites:

* [Git](http://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
* [Meteor](https://www.meteor.com/install)

Now just clone and start the app:

```sh
git clone https://github.com/RocketChat/Rocket.Chat.git
cd Rocket.Chat
meteor
```

or use docker:

```
git clone https://github.com/RocketChat/Rocket.Chat.git
cd Rocket.Chat
Mike's avatar
Mike committed
docker run -it -p 3000:3000 -v "$(pwd)":/app danieldent/meteor
Gabriel Engel's avatar
Gabriel Engel committed
## Credits

Thanks to
[Aaron Ogle](https://github.com/geekgonecrazy),
Gabriel Engel's avatar
Gabriel Engel committed
[Bradley Hilton](https://github.com/Graywolf336),
[Diego Sampaio](https://github.com/sampaiodiego),
[Gabriel Engel](https://github.com/engelgabriel),
[Marcelo Schmidt](https://github.com/marceloschmidt),
[Rafael Caferati](https://github.com/rcaferati),
[Rodrigo Nascimento](https://github.com/rodrigok),
Gabriel Engel's avatar
Gabriel Engel committed
[Sing Li](https://github.com/Sing-Li),
Gabriel Engel's avatar
Gabriel Engel committed
and many others.
Gabriel Engel's avatar
Gabriel Engel committed

Gabriel Engel's avatar
Gabriel Engel committed
Emoji provided free by [Emoji One](http://emojione.com)

Performance monitoring provided by [Kadira](https://kadira.io)
Gabriel Engel's avatar
Gabriel Engel committed

### Contributions

Already a JavaScript developer?  Familiar with Meteor?  [Pick an issue](https://github.com/RocketChat/Rocket.Chat/labels/contrib%3A%20easy), push a PR and instantly become a member of Rocket.Chat's international contributors community.
Gabriel Engel's avatar
Gabriel Engel committed

Filipe Alvarenga's avatar
Filipe Alvarenga committed
A lot of work has already gone into Rocket.Chat, but we have much bigger plans for it!
Gabriel Engel's avatar
Gabriel Engel committed

### Branching Model

The [Gitflow Workflow](http://nvie.com/posts/a-successful-git-branching-model/) section below is derived from Vincent Driessen at nvie.

See also this [Git Workflows Comparison](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) for more details.

Gabriel Engel's avatar
Gabriel Engel committed
### Translations

Gabriel Engel's avatar
Gabriel Engel committed
We are experimenting [Lingohub](https://translate.lingohub.com/engelgabriel/rocket-dot-chat/dashboard).
If you want to help, send an email to support at rocket.chat to be invited to the translation project.
Gabriel Engel's avatar
Gabriel Engel committed

Gabriel Engel's avatar
Gabriel Engel committed
### Community

frankenbot's avatar
frankenbot committed
Join the conversation at [Twitter](https://twitter.com/RocketChatApp), [Facebook](https://www.facebook.com/RocketChatApp) or [Google Plus](https://plus.google.com/+RocketChatApp)
Gabriel Engel's avatar
Gabriel Engel committed

### License

Note that Rocket.Chat is distributed under the [MIT License](http://opensource.org/licenses/MIT).
Gabriel Engel's avatar
Gabriel Engel committed

Gabriel Engel's avatar
Gabriel Engel committed
### Donate

Rocket.Chat will be free forever, but you can help us speed-up the development!

[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=49QX7TYCVZK8L)
Gabriel Engel's avatar
Gabriel Engel committed

[BountySource](https://www.bountysource.com/teams/rocketchat)