# Rocket.Chat
**Repository Path**: ScuPaul/Rocket.Chat
## Basic Information
- **Project Name**: Rocket.Chat
- **Description**: 聊天项目
- **Primary Language**: Go
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-06-08
- **Last Updated**: 2024-11-22
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
开源的网络聊天平台
[](https://open.rocket.chat/)
[](https://travis-ci.org/RocketChat/Rocket.Chat)
[](https://david-dm.org/RocketChat/Rocket.Chat)
[](https://david-dm.org/RocketChat/Rocket.Chat?type=dev)
[](https://www.codacy.com/app/RocketChat/Rocket-chat)
[](https://coveralls.io/r/RocketChat/Rocket.Chat)
[](https://codeclimate.com/github/RocketChat/Rocket.Chat)
[](https://github.com/RocketChat/Rocket.Chat/raw/master/LICENSE)
* [**NEW!** Rocket.Chat Moving to a Single Codebase](#moving-to-a-single-codebase)
* [Community](#community)
* [Mobile Apps](#mobile-apps)
* [Desktop Apps](#desktop-apps)
* [Deployment](#deployment)
* [Snaps](#instant-server-installation-with-snaps)
* [DigitalOcean](#digitalocean-droplet)
* [RocketChatLauncher](#rocketchatlauncher)
* [Layershift](#layershift)
* [Yunohost.org](#yunohostorg)
* [IndieHosters](#indiehosters)
* [Ubuntu 16.04](#ubuntu-1604)
* [Cloudron.io](#cloudronio)
* [Helm Kubernetes](#helm-kubernetes)
* [Scalingo](#scalingo)
* [Sloppy.io](#sloppyio)
* [Docker](#docker)
* [Ansible](#ansible)
* [Raspberry Pi 4](#raspberry-pi-4)
* [Koozali SME](#koozali-sme)
* [Ubuntu VPS](#ubuntu-vps)
* [D2C.io](#d2cio)
* [Syncloud.org](#syncloudorg)
* [About Rocket.Chat](#about-rocketchat)
* [In the News](#in-the-news)
* [Features](#features)
* [Roadmap](#roadmap)
* [How it all started](#how-it-all-started)
* [Awards](#awards)
* [Issues](#issues)
* [Stack Overflow](#stack-overflow)
* [Integrations](#integrations)
* [Documentation](#documentation)
* [License](#license)
* [Development](#development)
* [Quick Start](#quick-start-for-code-developers)
* [Branching Model](#branching-model)
* [Translations](#translations)
* [How to Contribute](#how-to-contribute)
* [Credits](#credits)
* [Help Wanted](#help-wanted)
* [Donate](#donate)
# clone到你的代码库
Rocket.Chat is moving to a single codebase. Get to know the reasons and how the community will benefit from it. Read the [details](https://rocket.chat/rocket-chat-is-moving-to-a-single-codebase-get-to-know-the-reasons-and-how-the-community-will-benefit-from-it/).
# Help Wanted
在 Rocket.Chat，我们的社区推动了我们所做的*一切*。 Rocket.Chat 团队正在扩大，我们知道没有比*就在这里* - 在我们的 GitHub 社区中找到合格的新团队成员更好的地方了。
如果您对我们的项目充满热情，想与世界领先的开源团队合作，并喜欢在您选择的地点远程工作，那么我们想与您交谈！
了解更多关于我们并探索当前的空缺职位 https://jobs.rocket.chat/"
# 交流
Join thousands of members worldwide 24/7 in our [community server](https://open.rocket.chat).
[](https://open.rocket.chat/channel/support) for help from our community with general Rocket.Chat questions.
[](https://open.rocket.chat/channel/dev) for developers needing help from the community to developing new features.
You can also join the conversation on [Twitter](https://twitter.com/RocketChat) and [Facebook](https://www.facebook.com/RocketChatApp).
## 分享你的故事
We’d love to hear about [your experience](https://survey.zohopublic.com/zs/e4BUFG) and potentially feature it on our [Blog](https://rocket.chat/case-studies/?utm_source=github&utm_medium=readme&utm_campaign=community).
## 订阅更新
Once a month our marketing team releases an email update with news about product releases, company related topics, events and use cases. [Sign Up!](https://rocket.chat/newsletter/?utm_source=github&utm_medium=readme&utm_campaign=community)
# 桌面App
Download the Native Cross-Platform Desktop Application at [Rocket.Chat.Electron](https://github.com/RocketChat/Rocket.Chat.Electron/releases)
# 手机App
[](https://itunes.apple.com/us/app/rocket-chat/id1148741252?mt=8) [](https://play.google.com/store/apps/details?id=chat.rocket.android) [](https://f-droid.org/en/packages/chat.rocket.android/)
# 部署
## 使用 Snaps 进行即时服务器安装
Install Rocket.Chat in seconds on Linux (Ubuntu and others) with:
```
sudo snap install rocketchat-server
```
[](https://snapcraft.io/rocketchat-server)
安装 snap 非常快。 通过运行该命令，您可以启动并运行完整的 Rocket.Chat 服务器。 快照是安全的。 它们与所有依赖项隔离。 当我们发布新版本时，快照也会自动更新。
我们的 snap 具有内置反向代理，可以请求和维护免费的 Let's Encrypt SSL 证书。 您可以在不到 5 分钟的时间内从零迁移到受 SSL 保护的面向公众的 Rocket.Chat 服务器。
了解有关我们快照的更多信息 [here](https://docs.rocket.chat/installation/snaps).
## 数字海洋水滴
使用我们来自 DigitalOcean 市场的一键安装列表部署到 DigitalOcean Droplet。
[](https://marketplace.digitalocean.com/apps/rocket-chat?action=deploy&refcode=1940fe28bd31)
## 层移
立即在下一代自动扩展 PaaS 上免费部署您的 Rocket.Chat 服务器。
[](http://jps.layershift.com/rocketchat/deploy.html)
无痛 SSL。 根据使用需求自动扩展您的服务器集群。
## Yunohost.org
在几秒钟内托管您自己的 Rocket.Chat 服务器。
[](https://install-app.yunohost.org/?app=rocketchat)
## 独立主机商
以“即服务”风格托管您的 Rocket.Chat 实例。 您注册，我们为您管理！ （更新，备份...）.
## Cloudron.io
Install Rocket.Chat on [Cloudron](https://cloudron.io) Smartserver:
[](https://cloudron.io/button.html?app=chat.rocket.cloudronapp)
## 掌舵 Kubernetes
使用官方在 Kubernetes 上部署 [helm chart](https://github.com/helm/charts/tree/master/stable/rocketchat).
## Scalingo
立即部署您自己的 Rocket.Chat 服务器 [Scalingo](https://scalingo.com).
[](https://my.scalingo.com/deploy?source=https://github.com/RocketChat/Rocket.Chat#master)
## Sloppy.io
Host your docker container at [sloppy.io](http://sloppy.io). 获取帐户并使用 [快速入门]
(https://github.com/sloppyio/quickstarters/tree/master/rocketchat).
## Docker
[Deploy with docker compose](https://docs.rocket.chat/installation/docker-containers#3-installing-docker-and-docker-compose)
[](https://hub.docker.com/r/rocketchat/rocket.chat/)
OR Use the automated build image of our [most recent release](https://hub.docker.com/r/rocketchat/rocket.chat/)
```
docker pull registry.rocket.chat/rocketchat/rocket.chat:latest
```
OR select a specific release ([details of releases available](https://github.com/RocketChat/Rocket.Chat/releases)):
```
docker pull registry.rocket.chat/rocketchat/rocket.chat:vX.X.X
```
OR our [official docker registry image](https://hub.docker.com/_/rocket.chat/), containing recent stable release build approved by Docker:
```
docker pull rocket.chat
```
## Ansible
Automated production-grade deployment in minutes, for RHEL / CentOS 7 or Ubuntu 14.04 LTS / 15.04.
[](https://rocket.chat/docs/installation/automation-tools/ansible/)
## Raspberry Pi 4
Run Rocket.Chat on this world famous $35 quad-core server.
[](https://github.com/RocketChat/Rocket.Chat.RaspberryPi)
## Koozali SME
Add Rocket.Chat to this world famous time tested small enterprise server today.
[](https://wiki.contribs.org/Rocket_Chat)
## Ubuntu VPS
Follow these [deployment instructions](https://docs.rocket.chat/installation/manual-installation/ubuntu).
## D2C.io
Deploy Rocket.Chat stack to your server with [D2C](https://d2c.io/). Scale with a single click, check live logs and metrics:
[](https://panel.d2c.io/?import=https://github.com/d2cio/rocketchat-stack/archive/master.zip/)
## Syncloud.org
Run Rocket.Chat on your easy to use personal device.
[](https://syncloud.org)
# About Rocket.Chat
Rocket.Chat is a Web Chat Server, developed in JavaScript, using the [Meteor](https://www.meteor.com/install) full stack framework.
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.
## In the News
##### [Wired](http://www.wired.com/2016/03/open-source-devs-racing-build-better-versions-slack/)
> Open Sourcers Race to Build Better Versions of Slack
##### [Hacker News](https://news.ycombinator.com/item?id=9624737)
> Yes, we made it to the #1
##### [Product Hunt](https://www.producthunt.com/tech/rocket-chat)
> Your own open source Slack-like chat
##### [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.
##### [Open Source China](http://www.oschina.net/p/rocket-chat)
> Rocket.Chat 是特性最丰富的 Slack 开源替代品之一。 主要功能：群组聊天，直接通信，私聊群，桌面通知，媒体嵌入，链接预览，文件上传，语音/视频 聊天，截图等等。
##### [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
##### [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
##### [snowulf.com](https://snowulf.com/2015/09/25/why-slack-when-you-can-rocket-chat/)
> Why Slack when you can Rocket.chat?
##### [liminality.xyz](http://liminality.xyz/self-hosting/)
> Self-hosted alternatives to popular cloud services
## Features
- BYOS (Bring Your Own Server)
- Multiple Rooms
- Direct Messages
- Private Groups
- Public Channels
- Desktop Notifications
- Mentions
- Avatars
- Markdown
- Emojis
- Custom Emojis
- Reactions
- One touch Geolocation
- TeX Math Rendering - inline math typesetting
- Media Embeds
- Link Previews
- Sent Message Edit and Deletion
- Transcripts / History
- File Upload / Sharing
- Scalable file sharing - S3 uploads with CDN downloads
- Full text search
- Global search (from all channels/rooms at once)
- Live chat / Messaging call center
- LDAP Authentication
- CAS 1.0, 2.0 support for educational institutions and hosting providers worldwide
- Support for Okta SSO through SAML v2
- I18n - Supports 22 Languages
- Hubot Friendly
- (Beta) Face to Face Video Conferencing (aka WebRTC )
- (Beta) Multi-users Video Group Chat
- (Beta) Jitsi integration
- Audio calls
- Multi-users Audio Conference
- Screen sharing
- Drupal 7.x and 8.x Plug-in (both stable and development flavours) ([download](https://www.drupal.org/project/rocket_chat) and [source code](https://git.drupal.org/project/rocket_chat.git) )
- XMPP bridge ([try it](https://open.rocket.chat/channel/general))
- REST APIs
- Remote Video Monitoring
- Native real-time APIs for Microsoft C#, Visual Basic, F# and other .NET supported languages ([Get it!](https://www.nuget.org/packages/Rocket.Chat.Net/0.0.12-pre))
- API access from [Perl](https://metacpan.org/pod/Net::RocketChat) and [Java](https://github.com/baloise/rocket-chat-rest-client) (community contributions)
- Chat-ops powered by Hubot: scalable horizontal app integration (early access)
- Massively scalable hosting and provisioning (beta testing now)
- Native Cross-Platform Desktop Application [Windows, macOS, or Linux](https://rocket.chat/)
- Mobile app for iPhone, iPad, and iPod touch [Download on App Store](https://geo.itunes.apple.com/us/app/rocket-chat/id1148741252?mt=8)
- Mobile app for Android phone, tablet, and TV stick [Available now on Google Play](https://play.google.com/store/apps/details?id=chat.rocket.android)
- Available on [Cloudron Store](https://cloudron.io/appstore.html#chat.rocket.cloudronapp)
## Roadmap
To see an up to date view of what we have planned, view our [milestones](https://github.com/RocketChat/Rocket.Chat/milestones).
## How it all started
Read about [how it all started](https://www.synopsys.com/blogs/software-security/rocket-chat-privately-hosted-chat-services/).
## Awards
[](http://www.infoworld.com/article/3122000/open-source-tools/bossie-awards-2016-the-best-open-source-applications.html#slide4)
[](https://info.blackducksoftware.com/OpenSourceRookies2015)
[](http://www.softpedia.com/get/Internet/Chat/Other-Chat-Tools/Rocket-Chat.shtml#status)
## Issues
[GitHub Issues](https://github.com/RocketChat/Rocket.Chat/issues) are used to track bugs and tasks on the roadmap.
## Feature Requests
[RocketChat/feature-requests](https://github.com/RocketChat/feature-requests) is used to track Rocket.Chat feature requests and discussions. Click [here](https://github.com/RocketChat/feature-requests/issues/new?template=feature_request.md) to open a new feature request.
[Feature Request Forums](https://forums.rocket.chat/c/feature-requests) stores the historical archives of old feature requests (up to 2018).
### Stack Overflow
Please use the [Stack Overflow TAG](http://stackoverflow.com/questions/tagged/rocket.chat)
## Integrations
#### 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
Integrate your application with fly-in panels today! Early access is available for developers.
#### 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.
## Documentation
Check out [Rocket.Chat documentation](https://docs.rocket.chat/).
## License
Note that Rocket.Chat is distributed under the [MIT License](http://opensource.org/licenses/MIT).
# Development
## Quick start for code developers
Prerequisites:
* [Git](http://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
* [Meteor](https://www.meteor.com/install)
> Meteor automatically installs a hidden [NodeJS v12](https://nodejs.org/download/release/v12.18.4/) and [MongoDB v4.2](https://docs.mongodb.com/manual/introduction/) to be used when you run your app in development mode using the `meteor` command.
Now just clone and start the app:
```sh
git clone https://github.com/RocketChat/Rocket.Chat.git
cd Rocket.Chat
meteor npm install
meteor npm start
```
For more detailed step-by-step, see our [quick start for developers](https://docs.rocket.chat/guides/developer/quick-start) docs.
To debug the server part, use [meteor debugging](https://docs.meteor.com/commandline.html#meteordebug). You should use Chrome for best debugging experience:
```sh
meteor debug
```
You'll find a nodejs icon in the developer console.
If you are not a developer and just want to run the server - see [deployment methods](https://docs.rocket.chat/installation/paas-deployments).
## Branching Model
See [Branches and Releases](https://docs.rocket.chat/guides/developer/branches-and-releases).
It is based on [Gitflow Workflow](http://nvie.com/posts/a-successful-git-branching-model/), reference 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.
## Translations
We are experimenting with [Lingohub](https://translate.lingohub.com/rocketchat/dashboard).
If you want to help, send an email to support at rocket.chat to be invited to the translation project.
## How to Contribute
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. For more information, check out our [Contributing Guide](.github/CONTRIBUTING.md) and our [Official Documentation for Contributors](https://docs.rocket.chat/contributors/contributing).
A lot of work has already gone into Rocket.Chat, but we have much bigger plans for it!
### Contributor License Agreement
Please review and sign our CLA at https://cla-assistant.io/RocketChat/Rocket.Chat
# Credits
Thanks to our core team
[Aaron Ogle](https://github.com/geekgonecrazy),
[Bradley Hilton](https://github.com/Graywolf336),
[Diego Sampaio](https://github.com/sampaiodiego),
[Gabriel Engel](https://github.com/engelgabriel),
[Marcelo Schmidt](https://github.com/marceloschmidt),
[Rodrigo Nascimento](https://github.com/rodrigok),
[Sing Li](https://github.com/Sing-Li),
and hundreds of awesome [contributors](https://github.com/RocketChat/Rocket.Chat/graphs/contributors).
Emoji provided graciously by [JoyPixels](https://www.joypixels.com/)
Testing with [BrowserStack](https://www.browserstack.com)
Translations done with [LingoHub](https://www.lingohub.com)
# Donate
Rocket.Chat will be free forever, but you can help us speed up the development!
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9MT88JJ9X4A6U&source=url)
[BountySource](https://www.bountysource.com/teams/rocketchat)