Unverified Commit 520d3247 authored by Fongang Rodrique's avatar Fongang Rodrique Committed by gitbook-bot
Browse files

GitBook: [#1640] [Style Guide]Update the content

parent f4fba0aa
......@@ -338,7 +338,7 @@
* [Departments](guides/omnichannel/departments.md)
* [Custom Fields](guides/omnichannel/custom-fields.md)
* [Livechat Triggers Manager's Guide](guides/omnichannel/livechat-triggers-managers-guide.md)
* [Livechat Widget Installation](guides/omnichannel/livechat-widget-installation/README.md)
* [Livechat Widget Installation](guides/omnichannel/livechat-widget-installation.md)
* [Troubleshoot Livechat Widget Installation](guides/omnichannel/livechat-widget-installation/troubleshoot-livechat-widget-installation.md)
* [Livechat Widget Appearance](guides/omnichannel/livechat-widget-appearance.md)
* [Webhooks Manager's Guide](guides/omnichannel/webhooks-managers-guide.md)
......
......@@ -8,11 +8,11 @@ description: Requirements for official support from the Rocket.Chat team
Setting up and running software is not always an easy thing. We get that. That's why we try to help everybody as good as possible with their instance of Rocket.Chat. And while we do like to help everybody, it just isn't feasible in any case. That is why we have to limit the support by the core team to some extent.
The following paragraphs will tell you about limits of the support the core team can give as well as where to find the community to help you and how you yourself can contribute by reporting bugs to us on GitHub.
The following sections will tell you about limits of the support the core team can give as well as where to find the community to help you and how you yourself can contribute by reporting bugs to us on GitHub.
## Official support
In order to obtain official support from our team, we have a minimum set of requirements. These requirements are necessary for us to access essential system information, to provide an SLA, to answer questions, or to provide a solution for the problem.
In order to obtain official support from our team, we have a minimum set of requirements. These requirements are necessary for us to access the essential system information, to provide an SLA, to answer questions, or to provide a solution for the problem.
Only installations matching these minimum requirements can be covered by our SLAs and our paid Support Policy, some requirements may vary depending on the installation size as described in the following sections.
......
......@@ -10,13 +10,13 @@ To access **Livechat Installation** settings:
Go to **Livechat Installation** in the omnichannel panel settings, as shown below:
![](<../../../.gitbook/assets/0 (4).png>)
![](<../../.gitbook/assets/0 (4).png>)
## To install the livechat widget:
1. Copy the given piece of code.
![](<../../../.gitbook/assets/1 (11).png>)
![](<../../.gitbook/assets/1 (11).png>)
1. Paste this code above the last **\</body>** tag on your site; the livechat widget will appear on the bottom right corner on your webpage.
......@@ -24,4 +24,4 @@ Go to **Livechat Installation** in the omnichannel panel settings, as shown belo
If you are running the livechat widget from a different domain to your Rocket.Chat server you need to disable the **Restrict access inside any iframe** option under the General settings as shown in the screenshot below.&#x20;
![Administration > General](../../../.gitbook/assets/restrict-access-inside-any-iframe.png)
![Administration > General](../../.gitbook/assets/restrict-access-inside-any-iframe.png)
......@@ -6,7 +6,7 @@ description: Minimum Requirements for Server Deployment
To get a Rocket.Chat instance running, you need to pay attention to the properties of the machine/hardware you have.
These Requirements vary greatly with:
These requirements vary greatly with:
* Number of concurrently active users
* Number of actually connected devices per user
......@@ -44,9 +44,9 @@ The above minimal virtual configuration, when not over-provisioned by the provid
The above virtual configuration, when not over-provisioned by the provider, can accommodate small deployments of up to 500 users, up to 100 concurrently active and moderate levels of mixed uploads, sharing, and bot activities.
## Really Small office Server&#x20;
## Really Small office Server
* Raspberry Pi 3 or Pi 2&#x20;
* Raspberry Pi 3 or Pi 2
* 4 cores 1 GB memory
* 32 GB SD card ($15)
......
# Choosing a Deployment Method
RocketChat offers a series of deployment methods and making a choice on which to use can get a little conflicting
RocketChat offers a series of deployment methods and making a choice on which to use can get a little conflicting.
Although we recommend using [Docker and Docker Compose](../rapid-deployment-methods/docker-and-docker-compose/), you may want to know when best to consider any of the other deployment methods.
......@@ -44,14 +44,14 @@ This is something that’s ignored very frequently but should be considered for
This scorecard shows a rating(on 05) of each deployment method against each consideration.
| | Docker | Snaps | One Click Deploment |
| ----------------------- | :-----------------------------------------: | :----------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| **Scalability** | <mark style="color:blue;">**`3.75`**</mark> | <mark style="color:red;">**`1.0`**</mark> | <mark style="color:red;">**`2.0`**</mark> |
| **Ease of Deployment** | <mark style="color:blue;">**`3.75`**</mark> | <mark style="color:blue;">**`4.5`**</mark> | <mark style="color:blue;">**`5.0`**</mark> |
| **Ease of Maintenance** | <mark style="color:blue;">**`4.0`**</mark> | <mark style="color:blue;">**`5.0`**</mark> | <mark style="color:red;">**`1.0`**</mark> |
| **Official Support** | <mark style="color:blue;">**`5.0`**</mark> | <mark style="color:blue;">**`5.0`**</mark> | <p>Digital Ocean: <mark style="color:blue;"><strong><code>5.0.</code></strong></mark><br><mark style="color:blue;"><strong><code></code></strong></mark>Linode: <mark style="color:red;"><strong><code>0.0</code></strong></mark></p> |
| **Community Support** | <mark style="color:blue;">**`5.0`**</mark> | <mark style="color:red;">**`2.0`**</mark> | <mark style="color:blue;">**`4.0`**</mark> |
| Comments | See comments below | See comments below | All one click deployment methods have thesame score ranking. |
| | Docker | Snaps | One Click Deploment |
| ----------------------- | :-----------------------------------------: | :----------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| **Scalability** | <mark style="color:blue;">**`3.75`**</mark> | <mark style="color:red;">**`1.0`**</mark> | <mark style="color:red;">**`2.0`**</mark> |
| **Ease of Deployment** | <mark style="color:blue;">**`3.75`**</mark> | <mark style="color:blue;">**`4.5`**</mark> | <mark style="color:blue;">**`5.0`**</mark> |
| **Ease of Maintenance** | <mark style="color:blue;">**`4.0`**</mark> | <mark style="color:blue;">**`5.0`**</mark> | <mark style="color:red;">**`1.0`**</mark> |
| **Official Support** | <mark style="color:blue;">**`5.0`**</mark> | <mark style="color:blue;">**`5.0`**</mark> | <p>Digital Ocean: <mark style="color:blue;"><strong><code>5.0.</code></strong></mark><br>Linode: <mark style="color:red;"><strong><code>0.0</code></strong></mark></p> |
| **Community Support** | <mark style="color:blue;">**`5.0`**</mark> | <mark style="color:red;">**`2.0`**</mark> | <mark style="color:blue;">**`4.0`**</mark> |
| Comments | See comments below | See comments below | All one click deployment methods have the same score ranking. |
### Comments
......
......@@ -12,41 +12,41 @@ This guide covers the following:
## Launch an EC2 instance
Log into AWS console, open the ["_EC2_" service](https://console.aws.amazon.com/ec2/), click on "_Instances_" in the left sidebar and click on "_Launch Instance_" to set up a new EC2 instance. Now follow the steps below:
Log into AWS console, open the ["_EC2_" service](https://console.aws.amazon.com/ec2/), click on "_Instances_" in the left sidebar and click on "**Launch Instance**" to set up a new EC2 instance. Now follow the steps below:
1. In the first step search for "_Ubuntu Server 18.04 LTS_" with "_64-bit (x86)_" architecture and click on "_Select_"
2. Select an instance type of your choice and click "_Next_"
3. Adjust the instance details as needed or keep the defaults. Proceed with "_Next_"
4. Adjust the storage size and configuration as needed and click on "_Next_"
5. Make sure to add a tag called "_Name_" and assign a value
6. Allow "_SSH_", "_HTTP_" and "_HTTPS_" in the security group configuration, proceed with "_Review and Launch_"
7. Review your instance configuration and confirm with "_Launch_"
8. Choose an existing key pair or create a new one and click on "_Launch Instance_"
1. In the first step search for "_Ubuntu Server 18.04 LTS_" with "_64-bit (x86)_" architecture and click on "**Select**".
2. Select an instance type of your choice and click "**Next**".
3. Adjust the instance details as needed or keep the defaults. Proceed with "**Next**".
4. Adjust the storage size and configuration as needed and click on "**Next**".
5. Make sure to add a tag called "**Name**" and assign a value.
6. Allow "_SSH_", "_HTTP_" and "_HTTPS_" in the security group configuration, proceed with "**Review and Launch**".
7. Review your instance configuration and confirm with "**Launch**".
8. Choose an existing key pair or create a new one and click on "**Launch Instance**".
## Allocate an Elastic IP
Back in the ["_EC2_" service](https://console.aws.amazon.com/ec2/) dashboard, click on "_Elastic IPs_" in the left sidebar:
1. Click on "_Allocate New Address_"
2. Select "_Amazon's pool of IPv4 addresses_" and click on "_Allocate_"
3. Click on the newly created IP address and select "_Associate Elastic IP address_"
4. Select your instance and click "_Associate_"
5. In the details below, copy the "_Public DNS_". You will need it in the DNS step.
1. Click on "**Allocate New Address**"
2. Select "**Amazon's pool of IPv4 addresses**" and click on "**Allocate**"
3. Click on the newly created IP address and select "**Associate Elastic IP address**"
4. Select your instance and click "**Associate**"
5. In the details below, copy the "**Public DNS**". You will need it in the DNS step.
(It should be in a format like this: `ec2-18-197-161-168.eu-central-1.compute.amazonaws.com`)
## Configure DNS w/ AWS Route 53
Open the "_Route 53_" service dashboard:
Open the "**Route 53**" service dashboard:
1. Create a new hosted zone by clicking on "_Create Hosted Zone_":
2. Enter your domain name and select "_Public Hosted Zone_" as type, then click on "_Create"_
3. Select your newly created zone and click on "_Create Record Set_"
4. Enter "_www_" as subdomain (if desired), select Type "_CNAME_", enter the Public DNS name from the above step to the value field and click "_Create_"
1. Create a new hosted zone by clicking on "**Create Hosted Zone**":
2. Enter your domain name and select "_Public Hosted Zone_" as type, then click on "**Create**_"_
3. Select your newly created zone and click on "**Create Record Set**"
4. Enter "_www_" as subdomain (if desired), select Type "_CNAME_", enter the Public DNS name from the above step to the value field and click "**Create**"
## Get an SSL certificate from Let's Encrypt
We will use Let's Encrypt to get a free & open-source SSL certificate:
We use Let's Encrypt to get a free & open-source SSL certificate:
1. SSH to your instance:
......@@ -169,7 +169,7 @@ Confirm that it is running properly by opening a web browser and going to your d
## Set up Docker containers
1. Create local directories
1. Create local directories.
```
sudo mkdir -p /opt/docker/rocket.chat/data/runtime/db
......@@ -248,6 +248,6 @@ Confirm that it is running properly by opening a web browser and going to your d
## Use it
1. Login to your site at `https://ABC.DOMAIN.COM`
1. Login to your site at `https://ABC.DOMAIN.COM.`
Note: the first user to login will be an administrator user.
**Note:** the first user to login will be an administrator user.
......@@ -6,14 +6,14 @@ description: Deploying Rocket.Chat on Google Compute Engine
## 1. Create a compute instance
1. Click create VM instance in google cloud console
2. Select a preferred Machine Type \(Default : 1cpu, 3.75GB Memory\)
3. Select a linux image \(Default Debian/ ubuntu\)
4. Allow HTTP/S Traffic
1. Click create VM instance in google cloud console.
2. Select a preferred Machine Type (Default : 1cpu, 3.75GB Memory).
3. Select a Linux image (Default Debian/ ubuntu).
4. Allow HTTP/S Traffic.
## 2. SSH to the instance
Connect to the instance by SSH or connect via browser on port other than 80
Connect to the instance by SSH or connect via browser on port other than 80.
## 3. run the following to install docker
......@@ -54,12 +54,11 @@ You are now running rocket chat on compute engine. You can open a browser with t
If you want the containers to start each time the instance reboots configure the following to the instance.
* click on the instance in the and hit "edit"
* Click on the instance in the and hit "**edit**"
* Under "Custom metadata" add an item with
```text
```
key: "startup-script"
value "sudo docker start mongo;
sudo docker start rocketchat"
```
......@@ -9,14 +9,16 @@ IBM Cloud have various options for hosting Rocket.Chat, Docker container on a Ku
## Prerequisite
* An IBM Cloud account
* The IBM Cloud command line client \(ibmcloud\) installed
* The IBM Cloud command line client (ibmcloud) installed
* git
## Deploying Rocket.Chat
First, logon to the [IBM Cloud dashboard](https://cloud.ibm.com/) and then select in the Apps box, `Create an app`.
Then give the Rocket.Chat server a unique app name, select as `Starting point` Create a new app, and as `Platform` select Node.js. Finish by clicking `Create`.
Then give the Rocket.Chat server a unique app name, select as `Starting point`&#x20;
Create a new app, and as `Platform` select Node.js. Finish by clicking `Create`.
After creation is finished, select `Create service` from the App Details tab, select Databases from the list of services, and Databases for MongoDB.
......@@ -26,23 +28,22 @@ All remaining steps will be preformed at the command line.
Git clone the latest Rocket.Chat:
```text
```
git clone https://github.com/RocketChat/Rocket.Chat.git
```
Log in to the IBM Cloud command-line interface:
```text
```
ibmcloud cf login
```
Push Rocket.Chat to the app you created early in the dashboard using meteor-buildpack-horse:
```text
```
cf push <your app name> -m 512M -b https://github.com/RocketChat/meteor-buildpack-horse.git
```
Go to `https://<your app name>.mybluemix.net/` in your browser to access your instance of Rocket.Chat
If you encounter any problem check the IBM Cloud Creating Apps instructions [here](https://cloud.ibm.com/docs/apps/tutorials?topic=creating-apps-tutorial-starterkit).
......@@ -4,8 +4,8 @@ Deploying Rocket.Chat with Docker and Docker Compose is as easy as it can get.
### Installing Docker and Docker Compose
* If you don't have already, make sure you have [Docker](https://docs.docker.com/install) and [Docker-compose](https://docs.docker.com/compose/install/) installed and operational
* Navigate to any directory of your choice create a `docker-compose.yml` based on[ our example](https://github.com/RocketChat/Rocket.Chat/blob/develop/apps/meteor/docker-compose.yml). OR You can download directly by executing the following command on your terminal
* If you don't have already, make sure you have [Docker](https://docs.docker.com/install) and [Docker-compose](https://docs.docker.com/compose/install/) installed and operational.
* Navigate to any directory of your choice create a `docker-compose.yml` based on[ our example](https://github.com/RocketChat/Rocket.Chat/blob/develop/apps/meteor/docker-compose.yml). OR you can download directly by executing the following command on your terminal.
```bash
curl -L https://go.rocket.chat/i/docker-compose.yml -O
......@@ -13,14 +13,14 @@ curl -L https://go.rocket.chat/i/docker-compose.yml -O
**Editing Variables:**
* Edit `image: registry.rocket.chat/rocketchat/rocket.chat:latest` to specify which image you wish to use (see section [Docker Images Available](docker-containers/available-images.md) )
* Edit `image: registry.rocket.chat/rocketchat/rocket.chat:latest` to specify, which image you wish to use (see section [Docker Images Available](docker-containers/available-images.md) )
* Edit `ROOT_URL` from the default `http://localhost:3000` to match your domain name or IP address as you wish
* If you have a registration token to automatically register the workspace you can provide with:
```
REG_TOKEN={your token here} docker-compose up -d
```
* Next, start up the contianer by executing:
* Next, start up the container by executing:
```
docker-compose up -d
......@@ -32,7 +32,7 @@ This is going to:
* Start a service named `mongo-init-replica` that will wait for `mongo` to be ready, connect to it, initialize it and terminate itself (`mongo` will keep running).
* Start a service `rocketchat`, that will also wait for `mongo` to be ready, the `mongo-init-replica` to initialize, and then run Rocket.Chat.
Mongo supports 24 x 7 operations and live backup. You should not need to restart it too frequently. See [mongodb documentations](https://docs.mongodb.org/manual/) for proper operation and management of a mongo server.
Mongo supports 24 x 7 operations and live backup. You should not need to restart it too frequently. See [mongodb documentation](https://docs.mongodb.org/manual/) for proper operation and management of a mongo server.
Optionally, if you want to manage your messages and configuration information, edit the file again to uncomment the volume mounts. Make sure you have a `data` subdirectory to mount and store the data.
......
......@@ -11,7 +11,7 @@ This guide will walk you through the installation and configuration of a Docker-
For people new to docker here's a quick primer: Docker is a program that allows other programs and their dependencies to be run in a type of virtual container. Using this deployment guide, you do not need to download any of the rocket chat program files manually whatsoever.\
Docker will get everything needed for Rocket.Chat to run. If you follow this guide closely, it provides everything from start to finish needed to install, create, and run your own Rocket.Chat web instance with Nginx handling SSL termination, and a Hubot chatbot keeping your general chat channel warm on those cold winter mornings.
This guide is designed for everyone, however, it is intentionally detailed to help new users who may need a little extra guidance. If you're experienced with things like docker, Nginx, etc. you may prefer one of the other deployment guides found elsewhere on this wiki.
This guide is designed for everyone, however, it is intentionally detailed to help the new users who may need a little extra guidance. If you're experienced with things like docker, Nginx, etc. you may prefer one of the other deployment guides found elsewhere on this wiki.
## What we'll cover in this guide
......@@ -43,8 +43,7 @@ First, make sure [UFW](https://en.wikipedia.org/wiki/Uncomplicated\_Firewall) (U
apt -qq list ufc
```
It will return simple info about the package if it is found. \
Otherwise, install the package by running
It will return simple information about the package if it is found. Otherwise, install the package by running
```
sudo apt-get install ufw
......@@ -57,7 +56,7 @@ sudo apt-get install ufw
In case you have the port changed on your device, be sure to use the corresponding port.\
Failure to do so will break your SSH connection and log you out of the server as soon as you enable the firewall!
_**Set the default access rules:**_
**Set the default access rules:**
```
sudo ufw default deny incoming
......@@ -115,7 +114,7 @@ Press **Y** when prompted to proceed with the install.
**Install Docker**
Follow this guide [https://docs.docker.com/linux/step\_one/](https://docs.docker.com/linux/step\_one/) to get Docker installed
Follow this guide [https://docs.docker.com/linux/step\_one/](https://docs.docker.com/linux/step\_one/) to get Docker installed.
**Install Docker-Compose version 1.24.0 (64 bit) via cURL**
......@@ -123,7 +122,7 @@ Follow this guide [https://docs.docker.com/linux/step\_one/](https://docs.docker
sudo curl -L "https://github.com/docker/compose/releases/download/1.24.0/docker-compose-Linux-x86_64" -o /usr/local/bin/docker-compose
```
**Set the executable permissions:**
**Set the executable permissions**
```
sudo chmod +x /usr/local/bin/docker-compose
......@@ -149,7 +148,7 @@ sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
If your hostname.domain.tld is mapped to a publicly routable IP, it needs to be set to your local address, for example, 127.0.0.1. Please note that the order in which localhost and your hostname are placed in this file is important; make sure localhost is first.
**Edit the hosts file:**
**Edit the hosts file**
```
sudo nano /etc/hosts
......@@ -176,7 +175,7 @@ If you don't have a certificate already, you can grab one for free at [Let's Enc
Or, if you want to use a self-signed SSL cert instead, skip ahead to [Self-Signed SSL](./#5b-self-signed-ssl).
**Install the private key (created when you generated the CSR):**
**Install the private key (created when you generated the CSR)**
```
sudo nano /etc/nginx/certificate.key
......@@ -186,7 +185,7 @@ Open the private key and Copy the entire private key text-block from the file th
Save and Exit.
**Install the SSL certificate (note that this goes in certificate.**_**crt**_**, not .**_**key**_**):**
**Install the SSL certificate (note that this goes in certificate.**_**crt**_**, not .**_**key**_**)**
```
sudo nano /etc/nginx/certificate.crt
......@@ -398,7 +397,7 @@ Next, let's try opening the web browser and going to your new chat room. Provide
https://chat.inumio.com
```
**If for some reason that fails, try HTTP:** **Open port 3000/tcp in the firewall, and reload to set the new policy**
**If for some reason that fails, try HTTP:** **Open port 3000/tcp in the firewall, and reload to set the new policy.**
```
sudo ufw allow 3000/tcp
......@@ -509,5 +508,5 @@ With TOP running, try to replicate the problem while watching TOP for high loads
You can also deploy using Docker and Docker Compose by following one of these guides:
* [Docker Compose](broken-reference)
* [Docker Compose](broken-reference/)
* [Available Images](available-images.md)
......@@ -4,7 +4,7 @@
Snap is preinstalled in most modern distributions. If it is not, please read snap's [official documentation](https://snapcraft.io/docs/installing-snapd) on how to install snap.
Installing Rocket.Chat with snap on Ubuntu is as easy as executing
Installing Rocket.Chat with snap on Ubuntu is as easy as executing:
```
sudo snap install rocketchat-server
......
......@@ -31,7 +31,7 @@ If you want to enable SSL and Let's Encrypt certificates you should:
1. input a URL starting with HTTPS
2. own the domain name you would like to use
3. and have the correct DNS record set up to resolve your domain name to your public IP (remember DNS records could take some time to propagate).
3. have the correct DNS record set up to resolve your domain name to your public IP (remember DNS records could take some time to propagate).
These next commands will check that configuration is set up correctly before starting the services:
......@@ -78,7 +78,7 @@ For 4.x latest AMD64 snaps or 3.x latest ARM64 snaps
{% endhint %}
{% hint style="info" %}
Both caddy v2 and caddy v1 (EOL) is deilivered in the snap, v2 is prioritized over v1
Both caddy v2 and caddy v1 (EOL) is deilivered in the snap, v2 is prioritized over v1.
{% endhint %}
If you want to configure Caddy yourself, place the Caddyfile in `/var/snap/rocketchat-server/current/` directory and restart rocketchat-server.
......@@ -87,7 +87,7 @@ If you want to configure Caddy yourself, place the Caddyfile in `/var/snap/rocke
sudo snap restart rocketchat-server
```
If you want to use some other reverse proxy, just disable Caddy by running
If you want to use some other reverse proxy, just disable Caddy by running.
```
sudo systemctl disable snap.rocketchat-server.rocketchat-caddy
......
......@@ -2,4 +2,4 @@
Starting track 4.x, you can configure MongoDB by yourself. The configuration file is located in `/var/snap/rocketchat-server/current/mongod.conf`.
For all configuration option, see MongoDB's Official Documentation.
For all configuration options, see MongoDB's Official Documentation.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment