### Minio Server Startup Output and Configuration Example

Source: https://docs.rocket.chat/v1/docs/minio

This snippet shows the typical output when a Minio server starts, including the endpoint, AccessKey, SecretKey, and region. It also provides an example command for configuring the Minio client (mc) to connect to the server.

```Shell
2017-01-24T19:53:21.141689279Z
2017-01-24T19:53:21.141730078Z Endpoint:  http://172.17.0.2:9000  http://127.0.0.1:9000
2017-01-24T19:53:21.141735582Z AccessKey: 5fD3434325fDaGE77BNJlSoV1xGp
2017-01-24T19:53:21.141738933Z SecretKey: Quie2teech4oofoo9Dahsoo7aithauja
2017-01-24T19:53:21.141742292Z Region:    us-east-1
2017-01-24T19:53:21.141745405Z SQS ARNs:  <none>
2017-01-24T19:53:21.141749472Z
2017-01-24T19:53:21.141752499Z Browser Access:
2017-01-24T19:53:21.141755711Z    http://172.17.0.2:9000  http://127.0.0.1:9000
2017-01-24T19:53:21.141758830Z
2017-01-24T19:53:21.141762000Z Command-line Access: https://docs.minio.io/docs/minio-client-quickstart-guide
2017-01-24T19:53:21.141765638Z    $ mc config host add myminio http://172.17.0.2:9000 1H2MI5BCU45990DZ3WRL flJlSoV1xGp+u2fhfDaGE77BNE6OdyvAsdI15kPq
2017-01-24T19:53:21.141768751Z
2017-01-24T19:53:21.141771631Z Object API (Amazon S3 compatible):
2017-01-24T19:53:21.141774638Z    Go:         https://docs.minio.io/docs/golang-client-quickstart-guide
2017-01-24T19:53:21.142003548Z    Java:       https://docs.minio.io/docs/java-client-quickstart-guide
2017-01-24T19:53:21.142019474Z    Python:     https://docs.minio.io/docs/python-client-quickstart-guide
2017-01-24T19:53:21.142024004Z    JavaScript: https://docs.minio.io/docs/javascript-client-quickstart-guide
2017-01-24T19:53:21.142027614Z
2017-01-24T19:53:21.142030994Z Drive Capacity: 262 GiB Free, 303 GiB Total
```

--------------------------------

### Install Docker and Git on Linux

Source: https://docs.rocket.chat/v1/docs/deploy-with-docker-docker-compose

Installs Docker using the official helper script and Git via apt package manager. Ensure Docker Compose v2 is installed separately if needed.

```bash
curl -L https://get.docker.com | sh # Install Docker
sudo apt install git # Install Git
```

--------------------------------

### Install Git on RHEL

Source: https://docs.rocket.chat/v1/docs/deploy-with-podman

Installs the Git version control system on a RHEL-based system using the DNF package manager. It also includes a command to verify the installation by checking the Git version.

```bash
sudo dnf install git
git -v
```

--------------------------------

### Install Zapier App

Source: https://docs.rocket.chat/v1/docs/zapier-app

Instructions on how to install the Zapier app within your Rocket.Chat workspace.

```APIDOC
## Install Zapier app

### Prerequisites
- Your workspace must be on a secured, publicly available domain.

### Installation Steps
1. Navigate to **Administration > Apps > Marketplace > Explore** in your Rocket.Chat workspace.
2. Search for **Zapier**.
3. Select the Zapier app from the search results.
4. Click **Install**.
5. Click **Agree** to grant the necessary permissions.

Upon successful installation, you will receive a message from `zapier.bot`, indicating that you can now proceed with setting up automations using the Zapier app.
```

--------------------------------

### Start Rocket.Chat Service

Source: https://docs.rocket.chat/v1/docs/deploy-with-centos

This command starts the Rocket.Chat service using systemctl, making the application accessible. This should be run after all update and installation steps are completed.

```bash
sudo systemctl start rocketchat
```

--------------------------------

### Example GitHub App Callback URL

Source: https://docs.rocket.chat/v1/docs/github-app

This is an example of the callback URL format required for the GitHub OAuth app. It must match the URL provided by the Rocket.Chat GitHub app to ensure proper authentication and data exchange between the two platforms.

```text
https://test-workspace.rocket.chat/api/apps/public/826f0d95-9e25-48a6-a781-a32f147230a5/github-app-callback
```

--------------------------------

### Install Rocket.Chat Apps Engine Dependencies (Shell)

Source: https://docs.rocket.chat/v1/docs/deploy-with-ubuntu

These commands are specific to installing version 6.10.x releases and involve setting up a cache directory for Deno, installing npm dependencies for the apps-engine, and ensuring correct file ownership. Note the `npm run postinstall` command might be skipped if errors occur.

```shell
mkdir -p /home/rocketchat/.cache
cd PATH_TO_ROCKETCHAT_INSTALLATION/programs/server/npm/node_modules/@rocket.chat/apps-engine
export DENO_DIR=/home/rocketchat/.cache/deno
npm install --production
npm run postinstall # skip this command if error arises
chown -R rocketchat:rocketchat /home/rocketchat
```

--------------------------------

### Load Rocket.Chat and MongoDB Docker Images

Source: https://docs.rocket.chat/v1/docs/rocketchat-air-gapped-deployment

Loads Rocket.Chat and MongoDB Docker images from tar archives into the Docker daemon on an air-gapped server. Requires the Docker engine to be installed.

```bash
docker load -i rocketchat.tar

docker load -i mongodb.tar
```

--------------------------------

### Example Rocket.Chat OAuth Configuration

Source: https://docs.rocket.chat/v1/docs/third-party-login

This snippet shows example configuration values for integrating a third-party application like Zapier with Rocket.Chat via OAuth. It includes essential URLs and credentials needed for authentication.

```text
Application Name: Zapier login
Redirect URI: https://zapier.com/dashboard/auth/oauth/return/App201062CLIAPI/
Client ID: zapier
Client Secret: RTK6TlndaCIolhQhZ7_KHIGOKnlaOq_o-7J
Authorization URL: https://example.rocket.chat/oauth/authorize
Access Token URL: https://example.dev.rocket.chat/oauth/token
```

--------------------------------

### Verify Docker Images and Running Containers (Bash)

Source: https://docs.rocket.chat/v1/docs/rocketchat-air-gapped-deployment

These commands help verify that no Rocket.Chat or MongoDB images are currently running on the air-gapped server before proceeding with the installation. They list all available Docker images and all currently running Docker containers.

```bash
docker images 

docker ps
```

--------------------------------

### Start ngrok Tunnel Command

Source: https://docs.rocket.chat/v1/docs/deploy-on-windows-10

This command initiates an ngrok tunnel to expose a local service to the internet via HTTPS. It requires the ngrok executable to be installed and configured. The command takes the desired public URL and the local port as arguments.

```shell
ngrok http --url=amazed-monkfish-busy.ngrok-free.app 80
```

```shell
ngrok http --url=amazed-monkfish-busy.ngrok-free.app 3000
```

--------------------------------

### Start and Initialize MongoDB

Source: https://docs.rocket.chat/v1/docs/deploy-with-ubuntu

These commands are used to enable, start, and restart the MongoDB service on Ubuntu. Following that, it initializes the MongoDB replica set, which is a requirement for Rocket.Chat deployments.

```bash
sudo systemctl enable --now mongod
sudo systemctl restart mongod
mongosh --eval "printjson(rs.initiate())"

```

--------------------------------

### Start MongoDB Service (Bash)

Source: https://docs.rocket.chat/v1/docs/migrate-from-mmap-to-wiredtiger-storage-engine

Starts the MongoDB service with the new WiredTiger storage engine configuration.

```bash
systemctl start mongod
```

--------------------------------

### Start Rocket.Chat Containers with Docker Compose

Source: https://docs.rocket.chat/v1/docs/deploy-on-windows-10

This command initiates the Rocket.Chat server and its associated services by creating and starting containers defined in the `docker-compose.yml` file. Ensure you are in the directory containing the `docker-compose.yml` file before execution. The service will be accessible at `http://localhost:3000` after a few minutes.

```bash
docker compose up
```

--------------------------------

### Install Rocket.Chat Server with Specific Version via Snap

Source: https://docs.rocket.chat/v1/docs/deploy-with-snaps

Installs a specific major version of Rocket.Chat using the Snap package manager. The `--channel` flag specifies the version, where 'x.x/stable' indicates the major and minor version. For example, '6.x/stable' installs the latest release within version 6. This command is primarily for development or testing specific versions.

```bash
sudo snap install rocketchat-server --channel=x.x/stable
```

--------------------------------

### Install Nginx Web Server

Source: https://docs.rocket.chat/v1/docs/deploy-with-podman

Installs the Nginx web server using the DNF package manager. This is a prerequisite for setting up Nginx as a reverse proxy for Rocket.Chat.

```bash
sudo dnf install -y nginx
```

--------------------------------

### Start Rocket.Chat with Podman Compose

Source: https://docs.rocket.chat/v1/docs/deploy-with-podman

This command starts the Rocket.Chat workspace along with supporting services like database, monitoring, and Traefik reverse proxy using `podman-compose`. It pulls the necessary Docker images and runs them in detached mode.

```bash
podman-compose -f compose.database.yml -f compose.monitoring.yml -f compose.traefik.yml -f compose.yml up -d
```

--------------------------------

### Install Latest Rocket.Chat Server Version via Snap

Source: https://docs.rocket.chat/v1/docs/deploy-with-snaps

Installs the most recent stable version of Rocket.Chat available through the Snap package manager. This is a simplified command for quick deployment without specifying a version. After installation, access the workspace via a web browser at the root URL (e.g., http://localhost:3000).

```bash
sudo snap install rocketchat-server
```

--------------------------------

### Install Nginx

Source: https://docs.rocket.chat/v1/docs/deploy-with-ubuntu

Installs the Nginx web server on Debian-based systems using apt. This is a prerequisite for using Nginx as a reverse proxy.

```bash
sudo apt update
sudo apt install nginx
```

--------------------------------

### Configure Rocket.Chat Environment Variables

Source: https://docs.rocket.chat/v1/docs/rocketchat-air-gapped-deployment

This shows an example of how the `.env` file should be configured for Rocket.Chat deployment. Key variables like `RELEASE`, `ROOT_URL`, and `MONGO_VERSION` need to be set according to your environment and desired Rocket.Chat version. Remember to uncomment and update the variables you are changing.

```plaintext
RELEASE=7.0.0
ROOT_URL=https://test.rocket.chat
MONGO_VERSION=6.0.3
```

--------------------------------

### Install Podman Compose with Pip

Source: https://docs.rocket.chat/v1/docs/deploy-with-podman

Installs Podman Compose using pip, the Python package installer. It's recommended to use a Python version of 3.8 or later. The installation is user-specific and the executable is added to the PATH.

```bash
python3.12 -m pip install --user podman-compose
echo 'export PATH=$HOME/.local/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
podman-compose --version
```

--------------------------------

### Start Rocket.Chat Without Monitoring and Traefik

Source: https://docs.rocket.chat/v1/docs/deploy-with-podman

This command starts the Rocket.Chat workspace and its core database services, excluding monitoring and Traefik. This is useful for deployments where these optional components are not required.

```bash
podman-compose -f compose.database.yml -f compose.yml up -d
```

--------------------------------

### Enable and Start Rocket.Chat Service (Bash)

Source: https://docs.rocket.chat/v1/docs/deploy-on-debian

This command enables the Rocket.Chat service to start automatically on system boot and also starts it immediately. It ensures the Rocket.Chat server is running and accessible after system restarts.

```bash
sudo systemctl enable --now rocketchat
```

--------------------------------

### Install Podman on RHEL

Source: https://docs.rocket.chat/v1/docs/deploy-with-podman

Installs the Podman containerization tool on a RHEL system using the DNF package manager. The command includes the -y flag for non-interactive installation. Verification is done by checking the Podman version.

```bash
sudo dnf install -y podman
podman --version
```

--------------------------------

### Install Rocket.Chat Server Dependencies

Source: https://docs.rocket.chat/v1/docs/deploy-with-ubuntu

After extracting the Rocket.Chat server files, this command installs the necessary production dependencies using npm. It's recommended to run this with a non-root account or use the --unsafe-perm flag.

```bash
cd /tmp/bundle/programs/server && npm install --production
# or
npm install --unsafe-perm --production

```

--------------------------------

### Install Python 3.12 and Pip

Source: https://docs.rocket.chat/v1/docs/deploy-with-podman

Installs Python 3.12 and its package installer, pip, on a RHEL system using DNF. This is necessary for installing Podman Compose, which relies on Python.

```bash
sudo dnf install -y python3.12 python3.12-pip
```

--------------------------------

### Update Image Paths for Rocket.Chat and MongoDB (YAML Example)

Source: https://docs.rocket.chat/v1/docs/rocketchat-air-gapped-deployment

This snippet demonstrates how to update the image paths in your Docker Compose file to point to your private registry. Ensure `<registry_ip_address>:5000` is correctly configured with your registry details.

```yaml
rocketchat:
    image: <registry_ip_address>:5000/registry.rocket.chat/rocketchat/rocket.chat:7.0.0
    
mongodb:
    image:<registry_ip_address>:5000/docker.io/bitnami/mongodb:latest
```

--------------------------------

### Run Private Docker Registry Container

Source: https://docs.rocket.chat/v1/docs/rocketchat-air-gapped-deployment

Starts a Docker container for the private registry. It's configured to run in detached mode (-d), map port 5000, restart automatically, and assigns a name to the container.

```bash
docker run -d -p 5000:5000 --restart=always --name private-registry registry:2
```

--------------------------------

### Install and Configure Traefik for Rocket.Chat

Source: https://docs.rocket.chat/v1/docs/deploy-on-debian

Installs Traefik, configures its main settings including entry points and Let's Encrypt, sets up dynamic configuration for Rocket.Chat routing, and manages the Traefik service. Requires root privileges for installation and configuration.

```bash
sudo apt update && sudo apt install -y wget
wget https://github.com/traefik/traefik/releases/download/v2.10.4/traefik_v2.10.4_linux_amd64.tar.gz
tar -zxvf traefik_v2.10.4_linux_amd64.tar.gz
sudo mv traefik /usr/local/bin/
```

```bash
sudo mkdir -p /etc/traefik
sudo nano /etc/traefik/traefik.toml
```

```ini
[entryPoints]
  [entryPoints.web]
    address = ":80"
  [entryPoints.websecure]
    address = ":443"

[certificatesResolvers.letsencrypt.acme]
  email = "your_email@your_domain.com"
  storage = "/etc/traefik/acme.json"
  [certificatesResolvers.letsencrypt.acme.tlsChallenge]

[providers.file]
  directory = "/etc/traefik/dynamic_conf"

[api]
  dashboard = true
```

```bash
sudo mkdir -p /etc/traefik/dynamic_conf
sudo nano /etc/traefik/dynamic_conf/rocketchat.toml
```

```ini
[http.routers]
  [http.routers.rocketchat]
    rule = "Host(`your_domain.com`)"
    service = "rocketchat"
    entryPoints = ["websecure"]
    [http.routers.rocketchat.tls]
      certResolver = "letsencrypt"

[http.services]
  [http.services.rocketchat.loadBalancer]
    [[http.services.rocketchat.loadBalancer.servers]]
      url = "http://your_ip:3000"
```

```bash
sudo nano /etc/systemd/system/traefik.service
```

```ini
[Unit]
Description=Traefik
Documentation=https://doc.traefik.io/traefik/
After=network-online.target
Wants=network-online.target

[Service]
Type=simple
ExecStart=/usr/local/bin/traefik --configfile=/etc/traefik/traefik.toml
Restart=on-failure
RestartSec=5

[Install]
WantedBy=multi-user.target
```

```bash
sudo systemctl daemon-reload
sudo systemctl enable --now traefik
```

```bash
sudo systemctl edit rocketchat
```

```bash
Environment=ROOT_URL=https://your_domain.com
```

```bash
sudo systemctl daemon-reload
sudo systemctl restart rocketchat
```

```bash
sudo ufw allow 80/tcp
sudo ufw allow 443/tcp
```

--------------------------------

### Start Rocket.Chat with Docker Compose

Source: https://docs.rocket.chat/v1/docs/deploy-with-docker-docker-compose

Execute this command to download necessary Docker images and start the Rocket.Chat container along with its supporting services like MongoDB, NATS, Prometheus, Grafana, and Traefik. This command orchestrates the deployment using multiple compose files.

```bash
docker compose -f compose.database.yml -f compose.monitoring.yml -f compose.traefik.yml -f compose.yml up -d
```

--------------------------------

### Install Rocket.Chat Production Dependencies

Source: https://docs.rocket.chat/v1/docs/deploy-on-debian

This command navigates to the server directory within the extracted Rocket.Chat bundle (`/tmp/bundle/programs/server`) and installs the necessary production dependencies using `npm`. It is recommended to run this command as a non-root user or use `npm install --unsafe-perm`.

```bash
cd /tmp/bundle/programs/server && npm install
```

--------------------------------

### Start Rocket.Chat Docker Compose

Source: https://docs.rocket.chat/v1/docs/docker-deployment-faq

This command starts the Rocket.Chat services defined in your `compose.yml` file in detached mode (`-d`), allowing Rocket.Chat to run in the background.

```bash
docker compose up -d
```

--------------------------------

### Install Rocket.Chat using Helm

Source: https://docs.rocket.chat/v1/docs/deploy-a-federated-rocketchat-workspace-with-kubernetes

Installs Rocket.Chat on a Kubernetes cluster using the specified Helm chart and a custom configuration file. This command initiates the deployment process.

```bash
helm install rocketchat -f values.yaml rocketchat/rocketchat
```

--------------------------------

### Rocket.Chat Helm Chart Configuration Example

Source: https://docs.rocket.chat/v1/docs/deploy-a-federated-rocketchat-workspace

An example `values.yaml` file for configuring a federated Rocket.Chat deployment. It includes settings for image repository and tag, MongoDB, microservices, ingress, federation, and PostgreSQL. Users need to replace placeholders like `<release>` and `domain.xyz` with their specific values.

```yaml
image:
 pullPolicy: IfNotPresent
 repository: registry.rocket.chat/rocketchat/rocket.chat
 tag: <release> #Set the Rocket.Chat release

mongodb:
  enabled: true
  auth:
    passwords:
      - rocketchat
    rootPassword: rocketchatroot


microservices:
 enabled: false  #Set to false for a monolithic deployment
host: domain.xyz  #Replace with your Rocket.Chat domain
ingress:
 enabled: true
 ingressClassName: nginx  #Specify the installed ingress controller in the K8s cluster
 annotations:
   cert-manager.io/cluster-issuer: production-cert-issuer # Replace with your ClusterIssuer name
tls:
   - secretName: federation #Use a different name if preferred
     hosts:
       - domain.xyz #Replace with your Rocket.Chat domain
       - synapse.domain.xyz #Replace with your Synapse server domain 

federation:
 enabled: true
 host: synapse.domain.xyz #Replace with your Synapse server domain 
persistence:
   enabled: true

postgresql:
 enabled: true 

```

--------------------------------

### Install Nginx Web Server

Source: https://docs.rocket.chat/v1/docs/deploy-with-docker-docker-compose

Installs the Nginx web server using the apt package manager. This is a prerequisite for using Nginx as a reverse proxy.

```bash
sudo apt-get install nginx
```

--------------------------------

### Initialize MongoDB Replica Set

Source: https://docs.rocket.chat/v1/docs/deploy-on-debian

Command to initialize the MongoDB replica set after configuring it. This command connects to the MongoDB shell and executes the `rs.initiate()` function to start the replica set initialization process.

```bash
mongosh --eval "printjson(rs.initiate())"
```

--------------------------------

### Install Rocket.Chat Dependencies and Download

Source: https://docs.rocket.chat/v1/docs/deploy-with-ubuntu

This section covers installing necessary packages for Rocket.Chat on Ubuntu, such as curl, build-essential, and graphicsmagick. It also includes commands to download either a specific version or the latest release of Rocket.Chat using curl.

```bash
sudo apt install -y curl build-essential graphicsmagick
curl -L https://releases.rocket.chat/6.13.0/download -o /tmp/rocket.chat.tgz
# or for the latest version:
curl -L https://releases.rocket.chat/latest/download -o /tmp/rocket.chat.tgz

```

--------------------------------

### Install Required Packages for Rocket.Chat

Source: https://docs.rocket.chat/v1/docs/deploy-on-debian

Installs essential packages required for Rocket.Chat deployment on Debian, including `curl` for downloading, `build-essential` for compiling, and `graphicsmagick` for image processing. The `-y` flag automatically confirms the installation.

```bash
sudo apt install -y curl build-essential graphicsmagick
```

--------------------------------

### Start and Enable Traefik Service

Source: https://docs.rocket.chat/v1/docs/deploy-with-centos

This snippet starts the Traefik service and configures it to launch automatically on system boot. It first reloads the systemd daemon to recognize the new service file and then enables and starts the service.

```Bash
sudo systemctl daemon-reload
sudo systemctl enable --now traefik
```

--------------------------------

### Apply Rocket.Chat License using Environment Variables

Source: https://docs.rocket.chat/v1/docs/air-gapped-license

Configure Rocket.Chat to use a license key by adding environment variables to the `rocketchat` service in your `compose.yml` file. This method is useful for air-gapped installations or when bypassing the setup wizard. Replace `<ENTER-YOUR-LICENSE-KEY>` with your actual license key. Setting `OVERWRITE_SETTING_Show_Setup_Wizard: completed` will skip cloud registration.

```yaml
OVERWRITE_SETTING_Show_Setup_Wizard: completed
OVERWRITE_SETTING_Enterprise_License: <ENTER-YOUR-LICENSE-KEY>
```

--------------------------------

### Install Traefik

Source: https://docs.rocket.chat/v1/docs/deploy-with-ubuntu

Downloads and installs Traefik v2.10.4 for Linux AMD64. This involves downloading a tarball, extracting it, and moving the binary to a system path.

```bash
sudo apt update && sudo apt install -y wget
wget https://github.com/traefik/traefik/releases/download/v2.10.4/traefik_v2.10.4_linux_amd64.tar.gz
tar -zxvf traefik_v2.10.4_linux_amd_64.tar.gz
sudo mv traefik /usr/local/bin/
```

--------------------------------

### Start and Enable MongoDB Service

Source: https://docs.rocket.chat/v1/docs/deploy-on-debian

Commands to enable MongoDB to start automatically on boot (`sudo systemctl enable --now mongod`) and then restart the MongoDB service (`sudo systemctl restart mongod`) to apply any configuration changes.

```bash
sudo systemctl enable --now mongod  
sudo systemctl restart mongod
```

--------------------------------

### Install Certbot for Nginx SSL

Source: https://docs.rocket.chat/v1/docs/deploy-with-ubuntu

Installs Certbot and its Nginx plugin using apt to enable SSL/TLS for the Nginx configuration.

```bash
sudo apt update
sudo apt install certbot python3-certbot-nginx
```

--------------------------------

### Install Rocket.Chat Desktop App on Linux (Snap)

Source: https://docs.rocket.chat/v1/docs/desktop-mobile-apps

Installs the Rocket.Chat desktop application on Linux using the Snap package manager. Snaps provide automatic updates and cross-platform compatibility, simplifying client management.

```bash
sudo snap install rocketchat-desktop
```

--------------------------------

### Start Rocket.Chat Service (Bash)

Source: https://docs.rocket.chat/v1/docs/migrate-from-mmap-to-wiredtiger-storage-engine

Starts the Rocket.Chat service after the MongoDB migration is complete. This allows Rocket.Chat to connect to the newly configured WiredTiger database.

```bash
systemctl start rocketchat
```

--------------------------------

### Start, Enable, and Manage Rocket.Chat Service

Source: https://docs.rocket.chat/v1/docs/deploy-with-centos

This set of commands is used to manage the Rocket.Chat systemd service. It includes enabling the service to start on boot, starting it immediately, checking its status, reloading the systemd daemon after configuration changes, and restarting the service to apply updates.

```bash
sudo systemctl enable --now rocketchat
sudo systemctl status rocketchat
sudo systemctl daemon-reload
sudo systemctl restart rocketchat
```

--------------------------------

### Telegram Incoming Integration: Get Chat ID Example

Source: https://docs.rocket.chat/v1/docs/simple-telegram-bot

This example shows the expected response from RawDataBot when added to a Telegram group, which includes the group's chat ID. This ID is crucial for configuring Rocket.Chat integrations.

```plaintext
Your chat id is -873457731, your id is 1140377161

Also you can send me username or joinchat link in a private message

Kisses, your bot
```

--------------------------------

### Start Rocket.Chat without Monitoring or Traefik

Source: https://docs.rocket.chat/v1/docs/deploy-with-docker-docker-compose

This command starts Rocket.Chat and its core database (MongoDB) and NATS, omitting the monitoring and Traefik reverse proxy services. This is useful for deployments where these optional components are not required.

```bash
docker compose -f compose.database.yml -f compose.yml up -d
```

--------------------------------

### Install Rocket.Chat Apps Engine Dependencies (Bash)

Source: https://docs.rocket.chat/v1/docs/deploy-on-debian

These commands are for installing version 6.10 of Rocket.Chat and specifically address the dependencies for the Apps Engine. It involves creating a cache directory, setting the DENO_DIR environment variable, and running npm install and postinstall scripts.

```bash
mkdir -p /home/rocketchat/.cache
cd PATH_TO_ROCKETCHAT_INSTALLATION/programs/server/npm/node_modules/@rocket.chat/apps-engine
export DENO_DIR=/home/rocketchat/.cache/deno
npm install --production
npm run postinstall  # skip this command if error arises
chown -R rocketchat:rocketchat /home/rocketchat
```

--------------------------------

### Install Rocket.Chat Monitoring with Helm (Bash)

Source: https://docs.rocket.chat/v1/docs/deploy-with-kubernetes

Installs the Rocket.Chat monitoring stack using Helm. This command requires a `values-monitoring.yaml` file to be present in the current directory. It deploys the monitoring components into your Kubernetes cluster.

```bash
helm install monitoring -f values-monitoring.yaml rocketchat/monitoring

```

--------------------------------

### Verify Rocket.Chat VoIP Settings

Source: https://docs.rocket.chat/v1/docs/troubleshooting-setup-for-team-voice-calls

Confirms that the Rocket.Chat application's VoIP settings are correctly configured to interface with FreeSWITCH. Refer to the official setup guide for specific parameters.

```json
{
  "voipSettings": {
    "enableVoip": true,
    "voipDomain": "your.freeswitch.domain.com",
    "voipPort": 8080,
    "voipSecurePort": 8443
  }
}
```

--------------------------------

### Start FreeSWITCH Container

Source: https://docs.rocket.chat/v1/docs/deploy-freeswitch-for-team-voice-calls-with-docker

Starts the FreeSWITCH container in detached mode using Docker Compose. This command assumes the freeswitch.yaml file has been downloaded.

```bash
docker compose -f freeswitch.yaml up -d
```

--------------------------------

### Update ROOT_URL in Compose File (YAML Example)

Source: https://docs.rocket.chat/v1/docs/rocketchat-air-gapped-deployment

This example shows how to update the `ROOT_URL` in the `compose.yaml` file. It's crucial to set this to your server's URL or domain name for Rocket.Chat to function correctly, especially in an air-gapped environment.

```yaml
ROOT_URL: http://172.55.18.208
```

--------------------------------

### Install Deno Version with Shell

Source: https://docs.rocket.chat/v1/docs/deploy-with-centos

Installs a specific version of Deno using a shell script. Requires `curl` to download the script and `sh` to execute it. Exports the Deno path for subsequent use.

```shell
curl -fsSL https://deno.land/install.sh | sh -s v1.38.5
export DENO_INSTALL="/home/ec2-user/.deno"
export PATH="$DENO_INSTALL/bin:$PATH"
```

--------------------------------

### GET /get-sidebar-icon

Source: https://docs.rocket.chat/v1/docs/whatsapp-cloud-app

Retrieves the WhatsApp conversation room icons to be displayed in the 'Chats in Progress' section.

```APIDOC
## GET /get-sidebar-icon

### Description
Retrieves the WhatsApp conversation room icons displayed in the "Chats in Progress" section on the left-hand menu.

### Method
GET

### Endpoint
/api/apps/public/{appId}/get-sidebar-icon

### Parameters
None

### Request Example
```bash
curl -X GET https://{workspace-url}/api/apps/public/87cf50f2-2db4-4e05-a8fd-135ad24f9c08/get-sidebar-icon
```

### Response
#### Success Response (200)
Returns the icon data or a URL to the icon.

#### Response Example
(Response structure will depend on the icon format provided by the app)
```

--------------------------------

### Restart Rocket.Chat Snap Services with systemctl

Source: https://docs.rocket.chat/v1/docs/snaps-faq

Offers an alternative method to restart individual Rocket.Chat Snap services using `systemctl`. This provides more granular control for troubleshooting specific components.

```bash
sudo systemctl restart snap.rocketchat-server.rocketchat-server
sudo systemctl restart snap.rocketchat-server.rocketchat-mongo 
sudo systemctl restart snap.rocketchat-server.rocketchat-cadd
```

--------------------------------

### View Rocket.Chat Snap Configuration Options

Source: https://docs.rocket.chat/v1/docs/deploy-with-snaps

Displays all available configuration options for a Rocket.Chat installation managed by Snap. This command lists current settings for variables like MongoDB connection URLs, ports, and the site URL. It's useful for understanding what can be customized.

```bash
sudo snap get rocketchat-server
```

--------------------------------

### ICE Server Configuration Example

Source: https://docs.rocket.chat/v1/docs/configure-team-voice-calls

Illustrates the format for configuring ICE servers (STUN/TURN) for VoIP calls. This includes optional username/password encoding and the structure for specifying server addresses.

```text
[username:password@]stun:host:port
[username:password@]turn:host:port
```

--------------------------------

### Install Nginx and Certbot for Rocket.Chat

Source: https://docs.rocket.chat/v1/docs/deploy-with-digital-ocean

Installs Nginx web server and Certbot with the Nginx plugin on your droplet. Nginx will act as a reverse proxy for Rocket.Chat, and Certbot will automate SSL certificate management for HTTPS.

```bash
sudo apt update && sudo apt install nginx -y
```

```bash
sudo apt install certbot python3-certbot-nginx -y
```

--------------------------------

### Set Rocket.Chat Snap Registration Token

Source: https://docs.rocket.chat/v1/docs/snaps-faq

Provides instructions on setting a registration token for the Rocket.Chat Snap by creating a `.env` file in the specified directory and adding the token. A server restart is necessary to apply the token.

```bash
REG_TOKEN=<your token>
```

--------------------------------

### Access Rocket.Chat Workspace URL

Source: https://docs.rocket.chat/v1/docs/deploy-with-digital-ocean

The URL format to access your Rocket.Chat workspace after successful deployment on DigitalOcean. Append ':3000' to your droplet's IP address. The first user to access this URL will initiate the setup wizard.

```bash
http://<droplet-ip>:3000
```

--------------------------------

### Install Traefik Reverse Proxy

Source: https://docs.rocket.chat/v1/docs/deploy-with-centos

This snippet installs the Traefik reverse proxy on a Linux system by downloading the binary, extracting it, and moving it to the system's PATH. It requires root privileges and a stable internet connection.

```Bash
sudo curl -L https://github.com/traefik/traefik/releases/download/v2.9.6/traefik_v2.9.6_linux_amd64.tar.gz -o traefik.tar.gz
sudo tar -zxvf traefik.tar.gz
sudo mv traefik /usr/local/bin/
```

--------------------------------

### Google Calendar App Slash Commands Reference

Source: https://docs.rocket.chat/v1/docs/using-the-google-calendar-app

A comprehensive list of slash commands available for interacting with the Google Calendar app in Rocket.Chat. These commands cover various functionalities including help, setup, disconnection, settings management, and event retrieval.

```text
/google-calendar help
/google-calendar setup
/google-calendar disconnect
/google-calendar settings
/google-calendar events
```

--------------------------------

### Install Rocket.Chat with Helm (Bash)

Source: https://docs.rocket.chat/v1/docs/deploy-with-kubernetes

Installs Rocket.Chat on your Kubernetes cluster using Helm. This command requires a `values.yaml` file containing your specific Rocket.Chat deployment configurations. It deploys the Rocket.Chat application and its dependencies.

```bash
helm install rocketchat -f values.yaml rocketchat/rocketchat

```

--------------------------------

### Check Rosetta 2 Installation on macOS

Source: https://docs.rocket.chat/v1/docs/docker-deployment-faq

This command verifies if Rosetta 2 is installed on your Apple Silicon Mac, which is necessary for running x86_64 Docker images. If Rosetta 2 is not installed, macOS will prompt you to install it.

```bash
arch -x86_64 uname -m
```

--------------------------------

### Install Certbot and Nginx on RPM-based Systems

Source: https://docs.rocket.chat/v1/docs/deploy-with-docker-docker-compose

Installs Certbot and Nginx on RPM-based Linux distributions (like Redhat and CentOS) using yum-utils and yum. This is a prerequisite for obtaining Let's Encrypt certificates and setting up Nginx as a reverse proxy.

```bash
sudo yum install yum-utils
sudo yum install nginx
```

--------------------------------

### Obtain SSL Certificate with Certbot

Source: https://docs.rocket.chat/v1/docs/deploy-with-ubuntu

Runs Certbot to automatically obtain and install an SSL certificate for the specified domain, configuring Nginx for HTTPS.

```bash
sudo certbot --nginx -d your_domain.com
```

--------------------------------

### Create Rocket.Chat Environment File

Source: https://docs.rocket.chat/v1/docs/deploy-with-docker-docker-compose

Copies the example environment file to a new .env file, which is used to customize Rocket.Chat deployment configurations like version and workspace URL without modifying the main compose file.

```bash
cp .env.example .env
```

--------------------------------

### Install and Configure Nginx for Rocket.Chat

Source: https://docs.rocket.chat/v1/docs/deploy-on-debian

Installs Nginx, creates a server block to proxy requests to Rocket.Chat running on localhost:3000, and enables SSL with Certbot. Requires root privileges for installation and configuration.

```bash
sudo apt update
sudo apt install nginx
```

```bash
sudo nano /etc/nginx/sites-available/rocketchat
```

```nginx
server {
    listen 80;
    server_name your_domain.com;

    location / {
        proxy_pass http://localhost:3000;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $http_host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto http;
        proxy_set_header X-Nginx-Proxy true;
        proxy_redirect off;
    }
}
```

```bash
sudo ln -s /etc/nginx/sites-available/rocketchat /etc/nginx/sites-enabled/
```

```bash
sudo nginx -t
sudo systemctl restart nginx
```

```bash
sudo apt update
sudo apt install certbot python3-certbot-nginx
```

```bash
sudo certbot --nginx -d your_domain.com
```

--------------------------------

### Rocket.Chat DigitalOcean Droplet Welcome Message

Source: https://docs.rocket.chat/v1/docs/deploy-with-digital-ocean

The welcome message displayed upon connecting to the Rocket.Chat droplet via SSH. It provides essential information about Rocket.Chat, its Docker-based deployment, and links to relevant documentation and community forums.

```bash
##################################################################################################################################################################
Rocket.Chat is the leading open source team chat software solution. Free, unlimited and completely customizable with on-premises and SaaS cloud hosting.
Replace email, HipChat & Slack with the ultimate team chat software solution.

This Rocket.Chat image uses docker under the hood. To learn more, please read our docker documentation - https://docs.rocket.chat/deploy/prepare-for-your-deployment/rapid-deployment-methods/docker-and-docker-compose

You can find the compose project in $HOME/rocketchat directory.

Looking for how to use Rocket.Chat? Be sure to check our docs: https://docs.rocket.chat
Need some help? Join our community forums https://forums.rocket.chat and https://open.rocket.chat
##################################################################################################################################################################
```

--------------------------------

### Create OpenShift Project

Source: https://docs.rocket.chat/v1/docs/unsupported-methods-openshift

Creates a new project within OpenShift to host the Rocket.Chat application. This command initializes a dedicated space for your deployment.

```bash
$ oc new-project rocket-chat
```

--------------------------------

### Check Running Podman Containers

Source: https://docs.rocket.chat/v1/docs/deploy-with-podman

This command lists all currently running containers managed by Podman. It's used to verify that the Rocket.Chat workspace and its associated services have started successfully.

```bash
podman ps
```

--------------------------------

### View Rocket.Chat Snap Logs with snap logs

Source: https://docs.rocket.chat/v1/docs/deploy-with-snaps

Instructions for viewing Rocket.Chat server logs using the `snap logs` command, including options for viewing all logs and real-time updates.

```Bash
snap logs rocketchat-server
```

```Bash
snap logs -f rocketchat-server
```

--------------------------------

### Debug Rocket.Chat Snap with strace

Source: https://docs.rocket.chat/v1/docs/snaps-faq

Demonstrates how to add and use debugging tools like `strace` within a sandboxed Snap environment. This involves copying the tool into the Snap's `prime` directory and running in `devmode`.

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

--------------------------------

### Remove Rocket.Chat Installation Folder

Source: https://docs.rocket.chat/v1/docs/deploy-with-centos

This command removes the existing Rocket.Chat installation directory, typically located in `/opt`. This ensures a clean update by removing old files before installing the new version. Use with caution as it permanently deletes the directory and its contents.

```bash
sudo rm -rf /opt/Rocket.Chat
```

--------------------------------

### List Rocket.Chat Snap Services

Source: https://docs.rocket.chat/v1/docs/snaps-faq

This command displays information about the Rocket.Chat Snap package, including the core services it manages. The 'services' section details the snap-internal names and their corresponding systemd service names.

```bash
snap info rocketchat-server
```

--------------------------------

### Enable Nginx Site and Reload Configuration

Source: https://docs.rocket.chat/v1/docs/deploy-with-digital-ocean

Enables the newly created Nginx configuration file for your domain and tests the Nginx configuration syntax. Finally, it reloads the Nginx service to apply the changes, ensuring the reverse proxy is active.

```bash
sudo ln -s /etc/nginx/sites-available/chat.mycompany.com /etc/nginx/sites-enabled/
sudo nginx -t
sudo systemctl reload nginx
```

--------------------------------

### Create Rocket.Chat Systemd Service File

Source: https://docs.rocket.chat/v1/docs/deploy-with-centos

This section shows how to create a systemd service file for Rocket.Chat. It defines the service's description, dependencies, execution command (using the determined Node.js path), logging, and the user under which it will run. It also provides guidance on customizing the `User` and `ExecStart` directives, especially for users managing Node.js versions with nvm.

```bash
cat << EOF |sudo tee -a /lib/systemd/system/rocketchat.service
[Unit]
Description=The Rocket.Chat server
After=network.target remote-fs.target nss-lookup.target nginx.service mongod.service
[Service]
ExecStart=$NODE_PATH /opt/Rocket.Chat/main.js
StandardOutput=journal
StandardError=journal
SyslogIdentifier=rocketchat
User=rocketchat
[Install]
WantedBy=multi-user.target
EOF
```

```bash
ExecStart=/usr/bin/node /opt/Rocket.Chat/main.js
```

```bash
ExecStart=/bin/bash -c 'source /home/<user>/.nvm/nvm.sh && /home/<user>/.nvm/versions/node/<node_version>/bin/node /opt/Rocket.Chat/main.js'
```

--------------------------------

### Update and Upgrade Debian System

Source: https://docs.rocket.chat/v1/docs/deploy-on-debian

Commands to update the package list and upgrade installed packages on a Debian system. `sudo apt -y update` refreshes the list of available packages, and `sudo apt -y upgrade` installs the latest versions of all installed packages.

```bash
sudo apt -y update
sudo apt -y upgrade
```

--------------------------------

### Install Rocket.Chat with Dynamic Passwords using Helm

Source: https://docs.rocket.chat/v1/docs/configuring-rocketchat-with-kubernetes

This command installs the Rocket.Chat Helm chart, dynamically generating secure passwords for MongoDB authentication using openssl. It demonstrates passing configuration parameters directly to helm install using the --set flag.

```bash
helm install rocketchat rocketchat/rocketchat --set mongodb.auth.passwords={$(echo -n $(openssl rand -base64 32))},mongodb.auth.rootPassword=$(echo -n $(openssl rand -base64 32))
```

--------------------------------

### Download Rocket.Chat and MongoDB Docker Images

Source: https://docs.rocket.chat/v1/docs/rocketchat-air-gapped-deployment

These commands pull the specified versions of Rocket.Chat and MongoDB Docker images from their respective registries. Ensure you replace the version placeholders with your desired release numbers. Supported versions can be found in the Rocket.Chat release notes.

```bash
docker pull registry.rocket.chat/rocketchat/rocket.chat:<rocket.chat-version>

docker pull docker.io/bitnami/mongodb:<mongodb-version>
```

--------------------------------

### Install Nginx

Source: https://docs.rocket.chat/v1/docs/deploy-with-centos

Installs the Nginx web server on a YUM-based Linux distribution. This is a prerequisite for using Nginx as a reverse proxy.

```bash
sudo yum update
sudo yum install nginx
```

--------------------------------

### Configure Rocket.Chat Docker Compose for Apple Silicon

Source: https://docs.rocket.chat/v1/docs/docker-deployment-faq

This snippet shows how to modify the `compose.yml` file to deploy Rocket.Chat on Apple Silicon Macs. It involves specifying the `linux/amd64` platform for the Rocket.Chat service and enabling QEMU emulation for the MongoDB service.

```yaml
services:
  rocketchat:
    image: "rocket.chat:latest"
    platform: "linux/amd64"
    # ... other rocketchat service configurations
  mongodb:
    image: "mongo:4.4"
    environment:
      - EXPERIMENTAL_DOCKER_DESKTOP_FORCE_QEMU=1
    # ... other mongodb service configurations
```

--------------------------------

### GET /api/apps/public/87cf50f2-2db4-4e05-a8fd-135ad24f9c08/get-sidebar-icon

Source: https://docs.rocket.chat/v1/docs/whatsapp-360dialog-cloud-api

Retrieve WhatsApp conversation room icons for the 'Chats in Progress' section using the GET get-sidebar-icon endpoint.

```APIDOC
## GET /api/apps/public/{appId}/get-sidebar-icon

### Description
Retrieves the sidebar icon for WhatsApp conversation rooms, displayed in the 'Chats in Progress' section of the left-hand menu.

### Method
GET

### Endpoint
`/api/apps/public/{appId}/get-sidebar-icon`

### Parameters
#### Path Parameters
- **appId** (string) - Required - The ID of the public app.

### Request Example
```bash
curl -X GET https://{workspace-url}/api/apps/public/87cf50f2-2db4-4e05-a8fd-135ad24f9c08/get-sidebar-icon
```

### Response
#### Success Response (200)
- **iconUrl** (string) - The URL of the sidebar icon.

#### Response Example
```json
{
  "iconUrl": "https://example.com/icons/whatsapp.png"
}
```
```

--------------------------------

### Register RHEL System with Subscription Manager

Source: https://docs.rocket.chat/v1/docs/deploy-with-podman

Registers the RHEL system to the Red Hat subscription service, enabling access to software repositories. This is a prerequisite for installing packages via DNF. It requires user credentials or an activation key.

```bash
sudo subscription-manager register
```

--------------------------------

### Enable RHEL Software Repositories

Source: https://docs.rocket.chat/v1/docs/deploy-with-podman

Enables essential software repositories for RHEL 8 (x86_64 architecture) required for installing packages. It's recommended to disable any conflicting EUS (Extended Update Support) repositories.

```bash
sudo subscription-manager repos \
  --enable=rhel-8-for-x86_64-baseos-rpms \
  --enable=rhel-8-for-x86_64-appstream-rpms
```

```bash
sudo subscription-manager repos \
  --disable=rhel-8-for-x86_64-baseos-eus-rpms \
  --disable=rhel-8-for-x86_64-appstream-eus-rpms
```

--------------------------------

### Create Rocket.Chat Systemd Service File (Bash)

Source: https://docs.rocket.chat/v1/docs/deploy-on-debian

This snippet creates a systemd service file for Rocket.Chat. It defines how the service should be started, stopped, and managed by the system. It includes dependencies on other services and specifies the user to run the process.

```bash
cat << EOF |sudo tee -a /lib/systemd/system/rocketchat.service
[Unit]
Description=The Rocket.Chat server
After=network.target remote-fs.target nss-lookup.target nginx.service mongod.service
[Service]
ExecStart=$NODE_PATH /opt/Rocket.Chat/main.js
StandardOutput=journal
StandardError=journal
SyslogIdentifier=rocketchat
User=rocketchat
[Install]
WantedBy=multi-user.target
EOF
```

--------------------------------

### Install Rocket.Chat Dependencies with Bash

Source: https://docs.rocket.chat/v1/docs/deploy-with-centos

Installs necessary dependency packages for Rocket.Chat deployment on CentOS, including EPEL release, GraphicsMagick, and Development Tools.

```bash
sudo dnf install epel-release
sudo dnf install GraphicsMagick
sudo yum groupinstall "Development Tools"
```