Giter Site home page Giter Site logo

docs-old's Introduction

Rocket.Chat

Rocket.Chat’s mission is to empower organizations to own their conversations by developing the world’s most flexible and secure open-source communications platform.\

Rocket.Chat is a customizable open-source communications platform for organizations with high standards of data protection. It enables real-time conversations between colleagues, with other companies, or with your customers, across devices on the web, desktop, or mobile.\

Rocket.Chat integrates with multiple conversation channels like website Live Chat, email, Facebook page, Twitter, WhatsApp, Instagram, etc. It shows discussion from various channels, thereby constructing a single view of the customer and helping diminish the time needed to switch between the tools. Mobile app for Rocket.Chat (available for Android and iOS) enables you to browse conversations, reply to messages and collaborate with the team. Using our self-managed offerings, you can deploy Rocket.Chat on your own server, or you can use SaaS Rocket.Chat. We offer support and professional services for our enterprise plan.

Product Offerings

Rocket.Chat has four key product offerings:

  • Team collaboration - A single point for secure internal and cross-company collaboration.
  • Omnichannel customer service - Engage in seamless interactions with customers regardless of how they connect with you.
  • Chat engine - Create customized messaging experiences within your mobile or web app.
  • Marketplace - Choose a wide range of apps and native integrations that help your business communicate more effectively.

Security Offerings

With Rocket.Chat, you can safeguard your internal and external communications with the highest standards in data privacy, security, and ownership. Admins can configure their workspace according to their own policies. Our software has been deployed in the most rigorous environments, supporting compliance with GDPR, HIPAA, FINRA, FedRAMP, and more.

Rocket.Chat on-premise

Rocket.Chat gives you full ownership of your data. Leverage secure, self-managed installation in your data center with layered security options (e.g., SSL, VPN, and DMZ). Rocket.Chat’s on-premise offerings can be hosted entirely behind your firewall or on an air-gapped network.

Rocket.Chat SaaS

Rocket.Chat’s robust and scalable cloud is built on Docker and Kubernetes and combines it with our services and innovative platform. Hosted in secure and audited data centers in multiple regions for our customers to choose from – ensuring the best performance and meeting strict data localization requirements.

Information governance

Rocket.Chat offers governance and risk-management capabilities that meet the needs of the most security-conscious organizations. This includes global retention policies, compliance exports, and backup and restoration capabilities.

Important Links

Setup your account

{% content-ref url="deploy-rocket.chat/prepare-for-your-deployment/" %} prepare-for-your-deployment {% endcontent-ref %}

{% content-ref url="setup-and-administer-rocket.chat/accessing-your-workspace/creating-the-first-administrator.md" %} creating-the-first-administrator.md {% endcontent-ref %}

{% content-ref url="use-rocket.chat/user-guides/access-your-workspace.md" %} access-your-workspace.md {% endcontent-ref %}

{% content-ref url="use-rocket.chat/workspace-administration/" %} workspace-administration {% endcontent-ref %}

{% content-ref url="use-rocket.chat/user-guides/user-panel/" %} user-panel {% endcontent-ref %}

Channels

{% content-ref url="use-rocket.chat/user-guides/rooms/" %} rooms {% endcontent-ref %}

{% content-ref url="use-rocket.chat/omnichannel/" %} omnichannel {% endcontent-ref %}

{% content-ref url="extend-rocket.chat-capabilities/rocket.chat-marketplace/rocket.chat-public-apps-guides/omnichannel-apps/" %} omnichannel-apps {% endcontent-ref %}

Features

{% content-ref url="use-rocket.chat/rocket.chat-voice-channel/" %} rocket.chat-voice-channel {% endcontent-ref %}

{% content-ref url="use-rocket.chat/rocket.chat-conference-call/" %} rocket.chat-conference-call {% endcontent-ref %}

{% content-ref url="use-rocket.chat/workspace-administration/settings/analytics.md" %} analytics.md {% endcontent-ref %}

{% content-ref url="use-rocket.chat/rocket.chat-mobile/push-notifications/" %} push-notifications {% endcontent-ref %}

{% content-ref url="use-rocket.chat/message-auditing/" %} message-auditing {% endcontent-ref %}

{% content-ref url="setup-and-administer-rocket.chat/advanced-workspace-management/identity-management-ee-vs-ce.md" %} identity-management-ee-vs-ce.md {% endcontent-ref %}

{% content-ref url="use-rocket.chat/rocket.chat-workspace-administration/settings/federation/" %} federation {% endcontent-ref %}

Minimum Requirements

{% content-ref url="deploy-rocket.chat/installing-client-apps/minimum-requirements-for-using-rocket.chat.md" %} minimum-requirements-for-using-rocket.chat.md {% endcontent-ref %}

{% content-ref url="deploy-rocket.chat/prepare-for-your-rocket.chat-deployment/hardware-requirements.md" %} hardware-requirements.md {% endcontent-ref %}

Support

{% content-ref url="resources/get-support/" %} get-support {% endcontent-ref %}

Developer Guides

{% embed url="https://developer.rocket.chat" %}

Community

{% content-ref url="contribute-to-rocket.chat/how-can-i-help/" %} how-can-i-help {% endcontent-ref %}

docs-old's People

Contributors

andres-mauricio avatar d-gubert avatar debdutdeb avatar diegolmello avatar engelgabriel avatar faria1212 avatar frdmn avatar geekgonecrazy avatar graywolf336 avatar jaroju avatar laggedhero avatar makibras avatar marceloschmidt avatar marcosspessatto avatar martinschoeler avatar paulofariadias avatar rafaelks avatar reetp avatar renatobecker avatar rodrigok avatar rodriq avatar sampaiodiego avatar seanpackham avatar shiqimei avatar sing-li avatar slimmons avatar tmeasday avatar xbolshe avatar yyx990803 avatar zol avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs-old's Issues

Migrating data from meteor mongo

From RocketChat/Rocket.Chat#4734 (comment)

Any guide or advice we give will be away from using meteor to run in production.

My advice would be to export your database from the meteor mongo, and install rocket.chat using a recommended method.

To do this first make sure meteor is running. Then run: mongodump -h 127.0.0.1 --port 3001 -d meteor

It'll dump the database in a folder called dump.

Then install mongodb on your system. Please see the mongo section in one of our guides: https://rocket.chat/docs/installation/manual-installation/ubuntu/

Once Mongo is installed restore the data using: mongorestore -d meteor dump/meteor if you want to use a different database, you'd take this as your opportunity to change the database name. Replacing -d meteor with your desired database name.

Then follow the remainder of the guide on setting up Rocket.Chat.

Update channel name via REST

Hello,

How can i edit a channel parameters ( name for example ) using the REST API ?
I have only found how to create a channel in the documentation.

Thanks,

Snap tips tricks and FAQ

I've been pinning commands as I find them in #ubuntu-snap

If for some reason you need to get the ubuntu-core image for an air gapped device:
curl -X GET -H "Content-Type: application/json" -H "X-Ubuntu-Series: 16" -H "X-Ubuntu-Architecture: amd64" "https://search.apps.ubuntu.com/api/v1/snaps/details/ubuntu-core?channel=stable&confinement=strict" Make sure to change the architecture if differs from amd64


sudo systemctl restart snap.rocketchat-server.rocketchat-server to restart the server


Updates occur automatically with snap. Usually within 6 hours of a new version being posted. If you want it quicker, type: sudo snap refresh rocketchat-server


Directories and purpose:

  • Your actual snap files are copied to: /var/lib/snapd/snaps and they are mounted read only
  • Your snap common directory is: /var/snap/rocketchat-server/common/ file upload to disk, and database is stored here.
  • Your snap data directory is /var/snap/rocketchat-server/<version> this is a versioned folder.

Proper way to remove previous revisions:
snap remove --revision=35 rocketchat-server


Ensure its actually running with: `sudo systemctl status snap.rocketchat-server.rocketchat-server.service


To see the logs from rocket.chat sudo journalctl -u snap.rocketchat-server.rocketchat-server
To see the logs from mongo sudo journalctl -u snap.rocketchat-server.rocketchat-mongo


Add tool in snap for debugging purposes

snapcraft prime
snap try prime --devmode
cp /usr/bin/toolX prime
snap run <snap.app> --shell
sudo ./toolX

To backup data incase of re-install or just for sanity sake
Making a copy of /var/snap/rocketchat-server/common will be enough to back up all data.

MongoDB backup

Specifically looking for a guide for how to backup & restore the MongoDB data in Docker.

Email-Settings

Would be nice if you could add the documentation for the email settings. Especially and instruction on how to set the smtp settings correctly in the new email->smtp area in administration would be helpful. You could use e.g. Googlemail as example.

File Upload from AndroidLily

Hi,

Was trying to the file upload from android lily app, getting error:
Exception while invoking method 'ufsWrite' Error: Match error: Expected number, got undefined at check (packages/check/match.js:33:1) at [object Object].Meteor.methods.ufsWrite (packages/jalik_ufs/ufs-methods.js:127:1) at [object Object].methodsMap.(anonymous function) (server/lib/debug.js:17:26) at maybeAuditArgumentChecks (livedata_server.js:1698:12) at livedata_server.js:708:19 at [object Object]..extend.withValue (packages/meteor/dynamics_nodejs.js:56:1) at livedata_server.js:706:40 at [object Object]..extend.withValue (packages/meteor/dynamics_nodejs.js:56:1) at livedata_server.js:704:46 at tryCallTwo (/home/ubuntu/Rocket.Chat/programs/server/npm/promise/node_modules/meteor-promise/node_modules/promise/lib/core.js:45:5)

File Upload using: GridFS
Its working fine from web.

What could be possible issue.

Regards,

[Rest API] Login example with JSON

curl http://localhost:3000/api/v1/login \
     -d "user=myusername&password=mypassword"
curl -H "Content-type:application/json" \
      http://localhost:3000/api/v1/login \
      -d '{ "username": "myusername", "password": "mypassword" }'

I think the JSON call has typo. username should be user.

Docker Compose hubot image file

In the docker compose example file located at https://raw.githubusercontent.com/RocketChat/Rocket.Chat/develop/docker-compose.yml the hubot image used is pulled from "rocketchat/hubot-rocketchat".
The rocketchat github page at https://github.com/RocketChat/hubot-rocketchat states that:

Please DO NOT USE v1.x.x of the adapter. It is experimental, and in anticipation of a performance
oriented sweeping change within the core - which has not happened yet.

Please continue to use Hubot Adapter v0.1.x until further notice.

I suggest changing the docker compose file to use rocketchat/hubot-rocketchat:v0.1.4 as base image for hubot instead.

Push notification guide is ambiguous or inaccurate.

https://github.com/RocketChat/Rocket.Chat.Docs/blob/master/4.%20Administrator%20Guides/Push%20Notifications/README.md

By my testing, when the "Enable Gateway" setting is enabled, no further configuration of the server or client app are necessary. I did a packet trace of what it is doing and it literally sends everything off to the gateway server, and if it is configured with https://rocket.chat it works "out of the box" with the release .apk/client

If you set the GCP API Key and GCM Project Number while using the Gateway, it doesn't seem to do anything, that is. I would imagine this is the point of having the privacy settings, since otherwise the entire message is sent to https://rocket.chat, so sensitive information could be leaked to the Rocket.Chat organization.

If any only if you set GCM API key AND GCM Project Number AND set Enable Gateway to false, do you need to configure the Cordova client, I think.

Some outgoing messages are not encoded in UTF-8, on the Telegram webhook

 �[34mI20161219-13:20:29.379(-6) rocketchat_integrations rocketchat_integrations.js:1356 �[31mIntegrations ➔ Outgoing WebHook.error Error for trigger spanish,telegram to https://api.telegram.org/bot{{mybottoken}}/sendMessage?chat_id={{mychannelID}} { [Error: failed [400] {"ok":false,"error_code":400,"description":"Bad Request: Message text must be encoded in UTF-8"}]   response:     { statusCode: 400,      content: '{"ok":false,"error_code":400,"description":"Bad Request: Message text must be encoded in UTF-8"}',      headers:        { server: 'nginx/1.10.0',         date: 'Mon, 19 Dec 2016 19:20:30 GMT',         'content-type': 'application/json',         'content-length': '96',         connection: 'close',         'access-control-allow-origin': '*',         'access-control-expose-headers': 'Content-Length,Content-Type,Date,Server,Connection' },      data:        { ok: false,         error_code: 400,         description: 'Bad Request: Message text must be encoded in UTF-8' } } }  

Connection message missing in Realtime-API documentation

The Realtime-API documentation is missing a reference to the connection message that must be sent once before any other message to establish the WebSocket connection, otherwise the server will always respond with "Must connect first" message.

The connection message that I found watching those exchanged by the Rocket.Chat web client is:

{
	"msg": "connect",
	"version": "1",
	"support": ["1", "pre2", "pre1"]
}

This is the server response:

{
	"msg": "connected",
	"session": "daEkMjtYpGHhDuqRy"
}

This is instead the message that the server returns to every request if you do not send the connection message first:

{
	"msg": "error",
	"reason": "Must connect first",
	"offendingMessage": "[the-message-you-sent]"
}

Email Verification & Use DNS Domain Check

Document email verification option, as well as the Use DNS Domain Check

By default "Use DNS Domain Check" is on. And "Email Verification" when turned on, will not allow people to register if they are not using a valid email domain.

API v1: groups management

Hi !
Private Channels are not listed with "/api/v1/channels.list" even if the user belong to considered channel.
I'm still a little bit confused with Group as I thought that this noun was supposed to be replace by Channel (public/private).
Maybe I'm wrong ... or this is a work in progress and I must be patient or help !

Multiple Instance with systemd

Potentially Update: https://github.com/RocketChat/Rocket.Chat.Docs/tree/master/3.%20Installation/4.%20Manual%20Installation/Multiple%20Instances%20to%20Improve%20Performance

[Unit]
Description=The Rocket.Chat server
After=network.target remote-fs.target nss-lookup.target nginx.service mongodb.service

[Service]
User=rocketchat
Environment=MONGO_URL=mongodb://localhost:27017/rocketchat ROOT_URL=https://rocketchat.domain.com PORT=%i
ExecStart=/usr/local/bin/node /var/lib/rocketchat/Rocket.Chat/main.js
Restart=on-failure
RestartSec=10
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=rocketchat-%i

[Install]
WantedBy=multi-user.target

More details found here: #73

Change the way we order links

Today we are using number in front the folder/file names to order them on the website.

The problem is if we want to insert a new item on the middle of the existing ones we can pontetially broke some links (becase we'll rename the files/folders).

The idea is to store the ordering in header comments like this:

---
order: 1
---

and use (or create) a metalsmith plugin to sort them on the output.

mongodb authentication issue

I'm trying to set the environment variables to run rocketchat snap in ubuntu 16.04 as follows:

Export MONGO_URL = mongodb: // user: password @ localhost: 27017 / parties
Export ROOT_URL = https: //chat.mysite.com
Export Port = 3000

-/etc/mongod.conf - security.authenticacion: enabled

when I run:

$ Snap run rocketchat-server
, I receive the following error message:
MongoError: not authorized on parties to execute command { listIndexes: "users", cursor: {} }
    at Object.Future.wait (/snap/rocketchat-server/451/node_modules/fibers/future.js:449:15)
    at MongoConnection._ensureIndex (meteor://💻app/packages/mongo/mongo_driver.js:828:10)
    at null.Mongo.Collection._ensureIndex (meteor://💻app/packages/mongo/collection.js:685:20)
    at setupUsersCollection (meteor://💻app/packages/accounts-base/accounts_server.js:1491:9)
    at new AccountsServer (meteor://💻app/packages/accounts-base/accounts_server.js:51:5)
    at meteorInstall.node_modules.meteor.accounts-base.server_main.js (meteor://💻app/packages/accounts-base/server_main.js:9:12)
    at fileEvaluate (packages/modules-runtime.js:188:9)
    at require (packages/modules-runtime.js:111:16)
    at /snap/rocketchat-server/451/programs/server/packages/accounts-base.js:1972:15
    at /snap/rocketchat-server/451/programs/server/packages/accounts-base.js:1983:3
    - - - - -
    at Function.MongoError.create (/snap/rocketchat-server/451/programs/server/npm/node_modules/meteor/npm-mongo/node_modules/mongodb-core/lib/error.js:31:11)
    at queryCallback (/snap/rocketchat-server/451/programs/server/npm/node_modules/meteor/npm-mongo/node_modules/mongodb-core/lib/cursor.js:212:36)
    at /snap/rocketchat-server/451/programs/server/npm/node_modules/meteor/npm-mongo/node_modules/mongodb-core/lib/connection/pool.js:455:18
    at nextTickCallbackWith0Args (node.js:436:9)
    at process._tickCallback (node.js:365:13)

However, if I run in console

mongo -u user -p password parties
I have no authentication problems. Can someone help me?

FreeBSD installation doc works no more

I have FreeBSD 10.3 x64 installation which is clean enough (no node.js or npm installed). Within newly created jail a rocket.chat installation is made step by step according to manual FreeBSD 10.3 installation document. Everything is built succesfully, but the last 'meteor' command fails with a number of version restriction issues (please see rocket.txt ).
I'm not sure if this is documentation or installation issue, but something is broken here.

Hold persistent data in a webhook

I try to hold persistent data in a webhook. Is there a common solution, already ?

Actually I hold it in an array in the script header. But after every server restart the known states are gone.

SAML

Currently saml docs are a stub, can you please add docs for SAML ?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.