• Stars
    star
    323
  • Rank 125,269 (Top 3 %)
  • Language
    Shell
  • License
    MIT License
  • Created over 8 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Run a private social network on your Pi for iPhone and Android devices !

Rocket.Chat on Pi Logo

Run your own private Social Network on a Pi

  • Raspberry Pi is the tiny $35 quad-core computer that revolutionalized affordable servers
  • Rocket.Chat is the popular high performance, large capacity, open source team communications platform that rocked the server world

You can now run a private chat server on your Pi for:

  • family
  • social or hobby group
  • sports team
  • school
  • office

Picture of Rocket.Chat in action

Enjoy Rocket.Chat features including:

  • Video and audio chat
  • Share photos and voice messages
  • Share streaming music and video links
  • iOS app for iPhones and iPads
  • App for Android phones and tablets
  • Desktop app for Windows, MacOSX and Linux
  • Operate in 22 different languages
  • Multiple Rooms
  • Direct Messages
  • Private Groups
  • Off the record encrypted messages
  • Avatars
  • Emojis
  • Media Embeds
  • Link Previews
  • Many more ...

Background

This project adapts the Rocket.Chat server to run on a Raspberry Pi 4

Learn about Rocket.Chat.

Prerequisites

  • Raspberry Pi 4 or newer (4 GB or 8 GB version recommended)
  • the fastest and largest capacity microSD you can get, we recommend 128GB Class 10 or higher
  • Proper stable power supply for USB-C (5V 3A or more)
  • Internet connection

Up and running in minutes

You can get a Rocket.Chat server and a mongoDB instance working on your Raspiberry Pi 4 Model B (either 2GB, 4GB, and 8GB) in a few minutes. Here's how:

  1. Prepare your SD-Card: download Ubuntu 18.04 LTS image. Make sure you use 18.04LTS and NOT 20.04LTS as snap on 20.04LTS currently has problem with Arm64 version of mongoDB. If you want to use Raspbian, make sure you use the 64bit image and perform apt-get install snapd to install the snap daemon before proceeding to step 2.

If you really want to use 20.04lts and are already familiar with docker technology, then follow these instructuions to install the latest Rocket.Chat on the latest ubuntu distribution. The rest of this section assumes you are using 18.04lts.

  1. Log in to your Pi with the standard username "ubuntu" and password "ubuntu". If you want to log in remotely via SSH you have will have to enable SSH.

  2. It is a good idea to bring the system up to date after installation. You can issue the commands apt-get update followed by apt-get dist-upgrade to make sure the system is caught up with all the fixes and sub-releases.

  3. Perform sudo snap install rocketchat-server. This will take at least a couple of mintues. PLEASE BE PATIENT! I know how difficult it may be waiting for your own private social network to be birthed. BUT please wait a few minutes until everything has been completed.

That's it, your private chat server should now be LIVE!

Point a PC/Laptop browser on the same network as your Pi to http://<server ip>:3000 and\ access your Rocket.Chat server! Create the first user, which will become the server's adminsitrator. Have fun!

Read about the thousands of configuration / customization options available to you.

Put your chat server on the Internet for global access

With your Rocket.Chat server up and running, start another shell - typically (Ctrl-Alt-F2) or (Ctl-Alt-F3).

Login, download and start ngrok (see ngrok.com if you need more information):

$ curl https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-linux-arm.zip -o ngrok.zip
$ unzip ngrok.zip
$ cd ngrok
$ ./ngrok http 3000

Now follow the instruction and give the ngrok link to your friends and family anywhere in the world.

They can access your server via the ngrok link.

If you connect and disconnect your Pi server from the Internet all the time (that's usually not a good idea if you are serious about operating a server), you will discover that the ngrok link changes every time you restart. A possible solution is to use one of the Dynamic DNS services.

Enable https:// support for your domain name

If you have a registered domain name and a static IP address and want to easily put your Pi on a domain, you can use either:

  1. use the built-in caddy server -- see all the related instructions on our snap auto SSL with Lets Encrypt and Caddy documentation
  2. install Nginx NGINX reverse proxy for Rocket.Chat

HINTS:

  • Don't forget to configure your router to forward ports 80 and 443 to the pi
  • If you want to use the voice and video chat features, make sure you give them the link starting with https://
Mobile messaging on phones and tablets

Ask your friends to download the Rocket.Chat mobile app on Android PlayStore or the Apple Appstore for their phone and tablets!

Google Play

iOS App Store

Add your server's ngrok link to the app, and start mobile messaging one another!

Invite tons of friends

The power of the Pi4 as a social network server is amazing, estimated capacity:

Models Users Notes
Raspberry Pi 4 Model B with 2GB of RAM 50 you should comfortably host 50 users with moderate file share activity. Use a 128GB SD card and clean uploads once a month or so.
Raspberry Pi 4 Model B with 4GB of RAM 100s (we hope to bring this up to 1000 users by end of 2020, wish us luck) as of June 2020, on release 3.3.3+ 1000 registered users should be possible Recommend addition of a USB3 based 1TB SSD for object storage when used for file sharing communities (ideally object storage handled off the Pi via S3 interface).
Raspberry Pi 4 Model B with 8GB of RAM as of June 2020, on release 3.3.3+ 2000 registered users should be possible Recommend addition of a USB3 based 4TB SSD for object storage when used for file sharing communities (ideally object storage handled off the Pi via S3 interface).

There are many other pocket-sized ARM servers that Rocket.Chat can run on. See for example, on how to run high capacity Rocket.Chat server on Odroid XU4.

Ubuntu 18.04 lts and 64bit Arm support

If you have a Pi 4 with 2GB, 4GB, or 8GB RAM and want a more robust and common server setup. Download the 64bit Arm version of the operating system from this page.

Then you can install the 64bit server using snap, or docker. Explore this repository for docker deployment information on arm64.

Successful Installation on Rpi 3B+

(May work on RPi 2 as well : test needed) Running snap or manual install of Rocket.Chat under a Raspian ArmH or Ubuntu server 18.04 AmrH cause dependencies issues and does not succeed (2020 April,1st). Snap installation do work under Ubuntu server 18.04 64ARM (without the "H"). You can have access to the port 3000 once it is open in your firewall sudo ufw allow 3000

More fun with community contributions

RockOnPi community member @rdagger has contributed this excellent YouTube video on manual installation - just click on picture to watch:

From your phone, controll anything connected to your Pi

Try the following optional enchacements for your RocketOnPi, contributed by your friendly fellow community members:

Auto re-start Rocket.Chat if Pi Reboots or Crashes, by @elpatron68 and @j8r

Hubot

Monitor or control anything connected to your Pi, from anywhere - hubot style!, by @sing-li

Stuck? Need help?

First, check our list of Frequently Asked Questions to see if your question is already included.

If not, create an issue here: https://github.com/RocketChat/Rocket.Chat.RaspberryPi/issues/new

OR

Come join us at https://open.rocket.chat/ to get help from friendly RockOnPi community members and Rocket.Chat dev team.

RockOnPi Community meetup 24 x 7

The RockOnPi community gathers at https://open.rocket.chat/channel/raspberrypi - and talk Pi !!

Makers Ahoy!

Your imagination is your only limit.

Both Raspberry Pi and Rocket.Chat are open source, 100% programmable, 100% Makers-ready!

  • get the Raspberry Pi Camera into a Rocket.Chat room
  • hook up your home control project to Rocket.Chat
  • manage your fleet of drones remotely on the web via RC on Pi

Tell us about your innovative project, or find other collaborators at:

https://open.rocket.chat/channel/raspberrypi

Support this project

Help us spread the word about this project!

Tell all your Pi and Maker friends! Show off Rocket.Chat at your next meetup!

Tweet about us, or show off Pi with Rocket.Chat on Facebook!

Order a Rocket.Chat sticker for your Mac, tablet, or Pi case!

Where to get the Raspberry Pi server

Where to get Rocket.Chat

Apps for iPhone, iPad, Android, Windows, MacOSX:

https://Rocket.Chat/

Server source code (open source MIT Licensed):

https://github.com/rocketchat/Rocket.Chat

More Repositories

1

Rocket.Chat

The communications platform that puts data protection first.
TypeScript
38,542
star
2

Rocket.Chat.ReactNative

Rocket.Chat mobile clients
TypeScript
1,851
star
3

Rocket.Chat.Electron

Official OSX, Windows, and Linux Desktop Clients for Rocket.Chat
TypeScript
1,557
star
4

Rocket.Chat.iOS

Legacy mobile Rocket.Chat client in Swift for iOS
Swift
1,031
star
5

Rocket.Chat.Android

Legacy mobile Rocket.Chat client in Kotlin for Android
Kotlin
875
star
6

hubot-rocketchat

Rocket.Chat Hubot adapter
JavaScript
541
star
7

docs-old

Rocket.Chat's user documentation.
TypeScript
338
star
8

Docker.Official.Image

Docker hub - community managed image
Dockerfile
256
star
9

Rocket.Chat.Livechat

New Livechat client written in Preact
JavaScript
247
star
10

hubot-natural

Natural Language Processing Chatbot for RocketChat
CoffeeScript
144
star
11

Rocket.Chat.js.SDK

Utility for apps and bots to interact with Rocket.Chat via DDP and/or API
TypeScript
132
star
12

Rocket.Chat.Ops

Integrate your apps to Rocket.Chat ! Powered by Hubot.
JavaScript
123
star
13

Rocket.Chat.Cordova

Rocket.Chat Cross-Platform Mobile Application via Cordova (DEPRECATED)
JavaScript
104
star
14

fuselage

React port of Rocket.Chat's design system, Fuselage
TypeScript
103
star
15

EmbeddedChat

An easy to use full-stack component (ReactJS) embedding Rocket.Chat into your webapp
JavaScript
101
star
16

Rocket.Chat.Apps-engine

The Rocket.Chat Apps engine and definitions.
TypeScript
99
star
17

Rocket.Chat.Ansible

Deploy Rocket.Chat with Ansible!
Jinja
93
star
18

meteor-streamer

2 way communication over DDP with better performance.
JavaScript
83
star
19

Rocket.Chat.PWA

Bandwidth efficient, simplified client built with Angular.
TypeScript
78
star
20

Rocket.Chat.Kotlin.SDK

Rocket.Chat's Kotlin SDK (REST & WebSocket abstractions)
Kotlin
63
star
21

Rocket.Chat.Go.SDK

Go SDK for REST API and Realtime api
Go
55
star
22

Rocket.Chat.Federation

Chat servers. United.
Shell
54
star
23

Rocket.Chat.Apps-cli

The CLI for interacting with Rocket.Chat Apps
TypeScript
43
star
24

Rocket.Chat.OpenAI.Completions.App

Rocket.Chat OpenAI ChatGPT Integration App
TypeScript
42
star
25

RC4Community

Full-stack components for building, engaging, and growing your massive on-line community
JavaScript
41
star
26

Rocket.Chat.PWA.React

React Implementation of Rocket.Chat.PWA
JavaScript
37
star
27

Opensource-Contribution-Leaderboard

Open Source project contributors tracking leaderboard built with ❀️ in NodeJS πŸ˜‰
JavaScript
34
star
28

WordPressPlugin

Rocket.Chat.Livechat plug-in for WordPress
PHP
34
star
29

hubot-rocketchat-boilerplate

An example Hubot demonstrating usage of the Rocket.Chat adaptor.
JavaScript
33
star
30

helm-charts

Repository for RocketChat helm charts
Smarty
32
star
31

install.sh

command line tool to help you install and configure a RocketChat server in a Linux host
Shell
32
star
32

Apps.Github22

The ultimate AI-powered app extending Rocket.Chat for global developers collaborating on Github (2024 and beyond)
TypeScript
31
star
33

rocketchat-oauth2-server

OAuth 2 Server package
CoffeeScript
31
star
34

rocketchat_nextcloud

App that allows Rocket Chat to live inside NextCloud and become seamless for the NextCloud Users
PHP
29
star
35

botpress-channel-rocketchat

Botpress module channel for Rocket.Chat
JavaScript
28
star
36

Rocket.Chat.Java.SDK

[DEPRECATED, NOT MAINTAINED] Java/Android SDK for Rocket.Chat
Java
28
star
37

Rocket.Chat.Metrics

Monitoring setup for Rocket.Chat servers
26
star
38

RC4Conferences

A set of scalable components for communities to build, manage, and run virtual conferences of any size.
JavaScript
24
star
39

handbook

The Rocket.Chat team handbook is the central repository for how we run the company.
TypeScript
24
star
40

iframe-auth-example

iFrame auth example app
JavaScript
22
star
41

Rocket.Chat.Hubot

The hubot-rocketchat sample implementation used on our demo.
CoffeeScript
22
star
42

feature-requests

This repository is used to track Rocket.Chat feature requests and discussions. Click here to open a new feature request.
21
star
43

Rocket.Chat.ScreenShare.Extensions

JavaScript
20
star
44

developer-docs

These developer guides and APIs help you start developing on Rocket.Chat quickly.
TypeScript
19
star
45

Rocket.Chat.Artwork

Rocket.Chat Artwork
HTML
19
star
46

alexa-rocketchat

Innovating incredible new user experiences in the Alexa ecosystem - powered by Rocket.Chat
JavaScript
18
star
47

Rocket.Chat.GitHub.Action.Notification

Rocket.Chat Notification for GitHub Actions πŸ”” πŸš€
TypeScript
18
star
48

google-summer-of-code

Rocket.Chat as mentoring organization for Google Summer of Code
18
star
49

Rocket.Chat.Embedded.arm64

An open source journey bringing the latest Rocket.Chat releases to the arm64 universe
Shell
18
star
50

server-snap

Rocket.Chat server snap
Shell
17
star
51

Apps.Rasa

Integration between Rocket.Chat and the RASA Chatbot platform
TypeScript
17
star
52

Apps.Whiteboard

Whiteboard Integration App for Rocket.Chat
TypeScript
17
star
53

Apps.Google.Calendar

Rocket.Chat app to integrate Google Calendar into your chat
TypeScript
15
star
54

Rocket.Chat.Integrations

Rocket.Chat Integrations
JavaScript
14
star
55

Chat.Code.Ship

docker-compose file to start a full chatops stack, with gitlab, rocketchat and hubot
CoffeeScript
14
star
56

Apps.Jitsi

Rocket.Chat App for Jitsi
TypeScript
14
star
57

filestore-migrator

Go
13
star
58

koko

Rocket.Chat App Koko
TypeScript
13
star
59

rn-user-defaults

Use UserDefaults (iOS) and SharedPreferences (AndroidOS) with React Native, this can help you to share credentials between apps or between app and extensions on iOS.
Java
13
star
60

RocketChatViewController

RocketChatViewController Messages Library
Swift
13
star
61

docs

Rocket.Chat's user documentation.
JavaScript
13
star
62

Rocket.Chat.Flutter.SDK

Easily integrate Rocket.Chat into all your Flutter projects
C++
12
star
63

hubot-freddie

hubot bridge between Rocket.Chat and synapse (home) server from matrix.org
JavaScript
11
star
64

Rocket.Chat.PCL

Portable Class Libraries - Xamarin implementation of the Rocket.Chat Real-Time API
C#
10
star
65

Android-DDP

Java
10
star
66

Rocket.Chat.Apps-ts-definition

Deprecated, please use the Apps Engine.
TypeScript
10
star
67

Rocket.Chat.Demo.App

The best Rocket.Chat Apps Engine Demo out there.
TypeScript
10
star
68

contributors-program

This repository contains comprehensive information about the Rocket.Chat annual contributors program.
10
star
69

GSoC-Community-Hub

Ready-to-run hub to engage and extend your Google Summer of Code Community
JavaScript
10
star
70

botkit-starter-rocketchat

A starter kit for building a custom Rocket.Chat bot with Botkit Studio
JavaScript
10
star
71

Apps.Dialogflow

Integration between Rocket.Chat and the Dialogflow Chatbot platform
TypeScript
9
star
72

Rocket.Chat.Android.SDK

Rocket.Chat's Android Native SDK - DEPRECATED
Java
9
star
73

botkit-rocketchat-connector

A Botkit platform connector for Rocket.Chat
JavaScript
9
star
74

rocketchat-tui

Go
9
star
75

rocket.chat.load.tester

TypeScript
9
star
76

rocketchat-botpress-lab-bot

A bot that integrates RocketChat and Botpress
JavaScript
9
star
77

Tauri.Desktop.App

TypeScript
8
star
78

hubot-rocketchat-gitlab

JavaScript
8
star
79

Apps.Figma

[GSoC Project] Rocket.Chat App that connects with Figma
TypeScript
8
star
80

Apps.ClickUp

This Repository is for the GSOC 2022 ClickUp app integration for Rocket.Chat
TypeScript
8
star
81

rasa-kick-starter

Rocket.Chat connector kick starter for Rasa.AI
Python
8
star
82

RCMarkdownParser

Markdown parser for Rocket.Chat.iOS (a modified version of @LyokoTech/LTMarkdownParser)
Swift
8
star
83

TenableAgent-Daemonset

This repository contains Kubernetes resource files for deploying the Tenable agent as a DaemonSet in a Kubernetes cluster. The Tenable agent runs on all nodes in the cluster and provides visibility into the security posture of your cluster.
Dockerfile
8
star
84

botpress-kick-starter

Simple bot using botpress
JavaScript
8
star
85

Apps.teams.bridge

Connecting collaborators across Rocket.Chat and Microsoft Teams
TypeScript
7
star
86

Docker.Base.Image

Dockerfile
7
star
87

Rocket.Chat.Embedded.armhf

Sustaining 32 bit ARMHF snap and docker for Raspberry Pi until EOL
Shell
6
star
88

Rocket.Chat.Houston

Rocket.Chat internal command line tools for releases
JavaScript
6
star
89

hubot-gitsy

Gitlab BOT for Rocket.Chat built on Hubot v3
JavaScript
6
star
90

botswana-snap

BOTSwana : The Kalahari of bots. Run any bot on any chat, painlessly!
Shell
5
star
91

Apps.RocketChat.Tester

An app that provides endpoints to test Apps integration to Rocket.Chat
TypeScript
5
star
92

eslint-config-rocketchat

Rocket.Chat Style Guide
JavaScript
5
star
93

puppet-rocketchat

Puppet module that install Rocket.Chat
Ruby
5
star
94

tsmatrixserverlib

federation support module : low level common methods
TypeScript
5
star
95

Apps.Cloudflare

TypeScript
5
star
96

slack-compatibility-for-apps

Initialize your Rocket.Chat App with bindings that makes it compatible your Slack implementation
TypeScript
5
star
97

google-action-rocketchat

Innovating incredible new voice based user experiences - powered by Rocket.Chat
JavaScript
5
star
98

Apps.GitHub

Integrates GitHub with your Rocket.Chat Server
TypeScript
5
star
99

airlock

Kubernetes operator that manages access and secrets for MongoDB clusters
Go
5
star
100

Rocket.UI

ELM + Node.js + Webpack Frontend for Rocket.Platform
JavaScript
4
star