Skip to content
This repository has been archived by the owner on Mar 17, 2023. It is now read-only.

Commit

Permalink
GitBook: [#2085] Extend Rocket.Chat
Browse files Browse the repository at this point in the history
  • Loading branch information
Faria1212 authored and gitbook-bot committed Jan 16, 2023
1 parent 693f6e9 commit 87242c5
Show file tree
Hide file tree
Showing 243 changed files with 422 additions and 422 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ Rocket.Chat offers governance and risk-management capabilities that meet the nee

### Setup your account

{% content-ref url="deploy-rocket.chat/deploying-rocket.chat/" %}
[deploying-rocket.chat](deploy-rocket.chat/deploying-rocket.chat/)
{% content-ref url="deploy-rocket.chat/prepare-for-your-rocket.chat-deployment/" %}
[prepare-for-your-rocket.chat-deployment](deploy-rocket.chat/prepare-for-your-rocket.chat-deployment/)
{% endcontent-ref %}

{% content-ref url="setup-and-administer-rocket.chat/accessing-your-workspace/creating-the-first-administrator.md" %}
Expand All @@ -49,8 +49,8 @@ Rocket.Chat offers governance and risk-management capabilities that meet the nee
[connecting-to-a-server.md](use-rocket.chat/user-guides/connecting-to-a-server.md)
{% endcontent-ref %}

{% content-ref url="use-rocket.chat/user-guides/registration.md" %}
[registration.md](use-rocket.chat/user-guides/registration.md)
{% content-ref url="broken-reference" %}
[Broken link](broken-reference)
{% endcontent-ref %}

{% content-ref url="use-rocket.chat/user-guides/user-panel/" %}
Expand All @@ -67,8 +67,8 @@ Rocket.Chat offers governance and risk-management capabilities that meet the nee
[omnichannel](use-rocket.chat/omnichannel/)
{% endcontent-ref %}

{% content-ref url="use-rocket.chat/app-guides/omnichannel-apps/" %}
[omnichannel-apps](use-rocket.chat/app-guides/omnichannel-apps/)
{% content-ref url="extend-rocket.chat-capabilities/rocket.chat-marketplace/omnichannel-apps/" %}
[omnichannel-apps](extend-rocket.chat-capabilities/rocket.chat-marketplace/omnichannel-apps/)
{% endcontent-ref %}

### Features
Expand All @@ -85,8 +85,8 @@ Rocket.Chat offers governance and risk-management capabilities that meet the nee
[analytics.md](use-rocket.chat/administration/admin-panel/settings/analytics.md)
{% endcontent-ref %}

{% content-ref url="use-rocket.chat/mobile-guides/push-notifications/" %}
[push-notifications](use-rocket.chat/mobile-guides/push-notifications/)
{% content-ref url="use-rocket.chat/rocket.chat-mobile/push-notifications/" %}
[push-notifications](use-rocket.chat/rocket.chat-mobile/push-notifications/)
{% endcontent-ref %}

{% content-ref url="use-rocket.chat/message-auditing/" %}
Expand All @@ -107,14 +107,14 @@ Rocket.Chat offers governance and risk-management capabilities that meet the nee
[minimum-requirements-for-using-rocket.chat.md](deploy-rocket.chat/installing-client-apps/minimum-requirements-for-using-rocket.chat.md)
{% endcontent-ref %}

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

### Support

{% content-ref url="resources/getting-support/" %}
[getting-support](resources/getting-support/)
{% content-ref url="rocket.chat-resources/getting-support/" %}
[getting-support](rocket.chat-resources/getting-support/)
{% endcontent-ref %}

### Developer Guides
Expand All @@ -123,6 +123,6 @@ Rocket.Chat offers governance and risk-management capabilities that meet the nee

### Community

{% content-ref url="contributors/how-can-i-help/" %}
[how-can-i-help](contributors/how-can-i-help/)
{% content-ref url="contributor-to-rocket.chat/how-can-i-help/" %}
[how-can-i-help](contributor-to-rocket.chat/how-can-i-help/)
{% endcontent-ref %}
456 changes: 228 additions & 228 deletions SUMMARY.md

Large diffs are not rendered by default.

File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Examples of things that aren't considered bugs:
* Can't get the server installed
* Want a new widget in Rocket.Chat

If your issue falls into one of these categories, please see [Getting Support](../../resources/getting-support/)
If your issue falls into one of these categories, please see [Getting Support](../../rocket.chat-resources/getting-support/)

New feature requests should be posted in the [forums](https://forums.rocket.chat).

Expand Down

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,6 @@ Production deployments should continually collect metrics regarding the installa

Rocket.Chat cuts a new release every month. Please check the link below for more information about the release cycles and make sure you are running a supported version.

{% content-ref url="../../resources/getting-support/" %}
[getting-support](../../resources/getting-support/)
{% content-ref url="../../rocket.chat-resources/getting-support/" %}
[getting-support](../../rocket.chat-resources/getting-support/)
{% endcontent-ref %}
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Other Deployment Methods

{% content-ref url="manual-installation/" %}
[manual-installation](manual-installation/)
{% endcontent-ref %}

{% content-ref url="nonofficial-methods/" %}
[nonofficial-methods](nonofficial-methods/)
{% endcontent-ref %}

{% content-ref url="plug-in-deployments/" %}
[plug-in-deployments](plug-in-deployments/)
{% endcontent-ref %}

{% content-ref url="windows-10-pro.md" %}
[windows-10-pro.md](windows-10-pro.md)
{% endcontent-ref %}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Manual Installation

Here you can find guides on how to manually install and manage Rocket.Chat server in different Operational systems:

{% content-ref url="debian-based-distros/debian.md" %}
[debian.md](debian-based-distros/debian.md)
{% endcontent-ref %}

{% content-ref url="debian-based-distros/ubuntu.md" %}
[ubuntu.md](debian-based-distros/ubuntu.md)
{% endcontent-ref %}

{% content-ref url="debian-based-distros/kali-linux.md" %}
[kali-linux.md](debian-based-distros/kali-linux.md)
{% endcontent-ref %}
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ This installation guide was tested in the following environment:

## Requirements

* **Install MongoDB:** Please refer to the official MongoDB documentation on [how to install MongoDB on Debian](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-debian/). For the list of supported versions, see our documentation [here](../../../../../resources/getting-support/#mongodb-versions).
* **Install NodeJS:** Follow the [official guide](https://github.com/nodesource/distributions/blob/master/README.md#debinstall) to install NodeJS on a Debian system. Check out our page on [supported node versions](../../../../environment-configuration/node-configuration/supported-nodejs-version.md) for your specific version. You can also use third-party tools like [nvm](https://github.com/nvm-sh/nvm#installing-and-updating) or [n](https://www.npmjs.com/package/n).
* **Install MongoDB:** Please refer to the official MongoDB documentation on [how to install MongoDB on Debian](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-debian/). For the list of supported versions, see our documentation [here](../../../../../rocket.chat-resources/getting-support/#mongodb-versions).
* **Install NodeJS:** Follow the [official guide](https://github.com/nodesource/distributions/blob/master/README.md#debinstall) to install NodeJS on a Debian system. Check out our page on [supported node versions](../../../../rocket.chat-environment-configuration/node-configuration/supported-nodejs-version.md) for your specific version. You can also use third-party tools like [nvm](https://github.com/nvm-sh/nvm#installing-and-updating) or [n](https://www.npmjs.com/package/n).

## Install Rocket.Chat

Expand Down Expand Up @@ -107,7 +107,7 @@ The command above will create a barebone service file, this service file is what

### Passing environment variables

Next you need to pass some environment variables to the running process. For more information of configuring via environment variables read [this article](../../../../environment-configuration/environment-variables.md).
Next you need to pass some environment variables to the running process. For more information of configuring via environment variables read [this article](../../../../rocket.chat-environment-configuration/environment-variables.md).

Run:

Expand Down Expand Up @@ -195,10 +195,10 @@ sudo systemctl enable --now rocketchat

## Optional configurations

* [Configure firewall rule](../../../../environment-configuration/optional-configurations.md)
* [Configure a HTTP reverse proxy to access Rocket.Chat server](../../../../environment-configuration/configuring-ssl-reverse-proxy.md)
* [Configure mongo access control](../../../../environment-configuration/mongodb-configuration/mongodb-uri-authentication.md)
* [Configure production values for mongodb](../../../../environment-configuration/mongodb-configuration/mongo-options.md)
* [Configure firewall rule](../../../../rocket.chat-environment-configuration/optional-configurations.md)
* [Configure a HTTP reverse proxy to access Rocket.Chat server](../../../../rocket.chat-environment-configuration/configuring-ssl-reverse-proxy.md)
* [Configure mongo access control](../../../../rocket.chat-environment-configuration/mongodb-configuration/mongodb-uri-authentication.md)
* [Configure production values for mongodb](../../../../rocket.chat-environment-configuration/mongodb-configuration/mongo-options.md)

## Configure your Rocket.Chat server

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ sudo systemctl enable rocketchat && sudo systemctl start rocketchat

## Optional configurations

[Configure firewall rule](../../../../environment-configuration/optional-configurations.md) [Configure a HTTP reverse proxy to access Rocket.Chat server](../../../../environment-configuration/configuring-ssl-reverse-proxy.md) \[Configure mongo access control] \[Configure production values for mongodb]
[Configure firewall rule](../../../../rocket.chat-environment-configuration/optional-configurations.md) [Configure a HTTP reverse proxy to access Rocket.Chat server](../../../../rocket.chat-environment-configuration/configuring-ssl-reverse-proxy.md) \[Configure mongo access control] \[Configure production values for mongodb]

## Configure your Rocket.Chat server

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ We recommend installing on any Ubuntu version with LTS.

* **MongoDB**

Please refer to the official MongoDB documentation on [how to install MongoDB on Ubuntu](https://www.mongodb.com/docs/manual/tutorial/install-mongodb-on-ubuntu/). For the list of supported versions, see our documentation [here](../../../../../resources/getting-support/#mongodb-versions).
Please refer to the official MongoDB documentation on [how to install MongoDB on Ubuntu](https://www.mongodb.com/docs/manual/tutorial/install-mongodb-on-ubuntu/). For the list of supported versions, see our documentation [here](../../../../../rocket.chat-resources/getting-support/#mongodb-versions).
* **NodeJS**

Follow the [official guide](https://github.com/nodesource/distributions/blob/master/README.md#debinstall) to install NodeJS on a Debian system. Check out our page on [supported node version](../../../../environment-configuration/node-configuration/supported-nodejs-version.md) for your specific version. You can also use third-party tools like [nvm](https://github.com/nvm-sh/nvm#installing-and-updating) or [n](https://www.npmjs.com/package/n).
Follow the [official guide](https://github.com/nodesource/distributions/blob/master/README.md#debinstall) to install NodeJS on a Debian system. Check out our page on [supported node version](../../../../rocket.chat-environment-configuration/node-configuration/supported-nodejs-version.md) for your specific version. You can also use third-party tools like [nvm](https://github.com/nvm-sh/nvm#installing-and-updating) or [n](https://www.npmjs.com/package/n).

## Install Rocket.Chat

Expand Down Expand Up @@ -93,7 +93,7 @@ The command above will create a barebone service file, this service file is what

### Passing environment variables

Next you need to pass some environment variables to the running process. For more information of configuring via environment variables read [this article](../../../../environment-configuration/environment-variables.md).
Next you need to pass some environment variables to the running process. For more information of configuring via environment variables read [this article](../../../../rocket.chat-environment-configuration/environment-variables.md).

Run:

Expand Down Expand Up @@ -181,7 +181,7 @@ sudo systemctl enable --now rocketchat

## Optional configurations

[Configure firewall rule](../../../../environment-configuration/optional-configurations.md) [Configure a HTTP reverse proxy to access Rocket.Chat server](../../../../environment-configuration/configuring-ssl-reverse-proxy.md) \[Configure mongo access control] \[Configure production values for mongodb]
[Configure firewall rule](../../../../rocket.chat-environment-configuration/optional-configurations.md) [Configure a HTTP reverse proxy to access Rocket.Chat server](../../../../rocket.chat-environment-configuration/configuring-ssl-reverse-proxy.md) \[Configure mongo access control] \[Configure production values for mongodb]

## Configure your Rocket.Chat server

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ sudo systemctl enable rocketchat && sudo systemctl start rocketchat
## Optional configurations
[Configure firewall rule](../../../environment-configuration/optional-configurations.md) [Configure a HTTP reverse proxy to access Rocket.Chat server](../../../environment-configuration/configuring-ssl-reverse-proxy.md) \[Configure mongo access control] \[Configure production values for mongodb]
[Configure firewall rule](../../../rocket.chat-environment-configuration/optional-configurations.md) [Configure a HTTP reverse proxy to access Rocket.Chat server](../../../rocket.chat-environment-configuration/configuring-ssl-reverse-proxy.md) \[Configure mongo access control] \[Configure production values for mongodb]
## Configure your Rocket.Chat server
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ Optionally, if you want to manage your messages and configuration information, e

To update the `rocketchat` docker image to the latest version, update the `RELEASE` value in your `.env` file, then simply run `docker compose up -d`. Your data should not be affected by this, since it's located in the `mongo` image.

{% content-ref url="../../../upgrading-rocket.chat.md" %}
[upgrading-rocket.chat.md](../../../upgrading-rocket.chat.md)
{% content-ref url="../../../updating-rocket.chat.md" %}
[updating-rocket.chat.md](../../../updating-rocket.chat.md)
{% endcontent-ref %}

[^1]:
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,6 @@ rocketchat:
### Create a Load Balancer
* Now, setup up a [reverse proxy](../../../../environment-configuration/configuring-ssl-reverse-proxy.md) on each host to terminate SSL on each rocket.chat node or terminate SSL on the load balancer, this is up to you.
* Now, setup up a [reverse proxy](../../../../rocket.chat-environment-configuration/configuring-ssl-reverse-proxy.md) on each host to terminate SSL on each rocket.chat node or terminate SSL on the load balancer, this is up to you.
* See [Nginx multi-instance reverse proxy example](https://docs.rocket.chat/installation/manual-installation/multiple-instances-to-improve-performance#update-your-nginx-proxy-config).
* Set up a load balancer to reach each instance on `443` or `3000` (depends on the choice above).
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This guide will help you migrate from the built-in Meteor mongo server to an ext
{% hint style="info" %}
We do not advise running Rocket.Chat in production from source using the meteor command. Instead we recommend using a separate mongo database and using a compiled meteor bundle. Either our official release or your own.

See our [recommended deployment methods](../../deploying-rocket.chat/rapid-deployment-methods/).
See our [recommended deployment methods](../../prepare-for-your-rocket.chat-deployment/rapid-deployment-methods/).
{% endhint %}

Before starting make sure meteor is running.
Expand All @@ -14,10 +14,10 @@ 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](../../deploying-rocket.chat/other-deployment-methods/manual-installation/) in one of our guides for your current OS
Then install mongodb on your system. Please see the [mongo section](../../prepare-for-your-rocket.chat-deployment/other-deployment-methods/manual-installation/) in one of our guides for your current OS

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](../../deploying-rocket.chat/other-deployment-methods/manual-installation/) for your current OS.
Then follow the remainder of the guide on [setting up Rocket.Chat](../../prepare-for-your-rocket.chat-deployment/other-deployment-methods/manual-installation/) for your current OS.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Each Rocket.Chat version requires a specific Node version for it to
# Supported NodeJs Version

{% hint style="info" %}
The only reason you may need to check this (except for idle curiosity or debugging purposes) is if you're using the manual method of deployment. We don't recommend manual installation. Instead, [Docker](../../deploying-rocket.chat/rapid-deployment-methods/docker-and-docker-compose/) is recommended and encouraged. With [Docker](../../deploying-rocket.chat/rapid-deployment-methods/docker-and-docker-compose/) (or [Snap](../../deploying-rocket.chat/rapid-deployment-methods/snaps/)) you won't need to worry about the Node version.
The only reason you may need to check this (except for idle curiosity or debugging purposes) is if you're using the manual method of deployment. We don't recommend manual installation. Instead, [Docker](../../prepare-for-your-rocket.chat-deployment/rapid-deployment-methods/docker-and-docker-compose/) is recommended and encouraged. With [Docker](../../prepare-for-your-rocket.chat-deployment/rapid-deployment-methods/docker-and-docker-compose/) (or [Snap](../../prepare-for-your-rocket.chat-deployment/rapid-deployment-methods/snaps/)) you won't need to worry about the Node version.
{% endhint %}

Rocket.Chat is built with [Meteor](https://meteor.com), a JavaScript framework. The version of Meteor in use dictates the supported NodeJs version for that specific version.
Expand Down
Loading

0 comments on commit 87242c5

Please sign in to comment.