{"id":31923035,"url":"https://github.com/rocketchat/rocketchat-compose","last_synced_at":"2026-01-23T02:50:59.079Z","repository":{"id":306442874,"uuid":"1025807939","full_name":"RocketChat/rocketchat-compose","owner":"RocketChat","description":"Docker / Podman Compose ","archived":false,"fork":false,"pushed_at":"2025-08-25T13:34:20.000Z","size":87,"stargazers_count":13,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-09-29T01:40:00.330Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RocketChat.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-24T20:46:40.000Z","updated_at":"2025-09-27T12:41:51.000Z","dependencies_parsed_at":"2025-08-25T15:33:56.911Z","dependency_job_id":null,"html_url":"https://github.com/RocketChat/rocketchat-compose","commit_stats":null,"previous_names":["rocketchat/compose","rocketchat/rocketchat-compose"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/RocketChat/rocketchat-compose","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2Frocketchat-compose","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2Frocketchat-compose/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2Frocketchat-compose/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2Frocketchat-compose/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RocketChat","download_url":"https://codeload.github.com/RocketChat/rocketchat-compose/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2Frocketchat-compose/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279017232,"owners_count":26086016,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-10-13T23:43:32.022Z","updated_at":"2026-01-23T02:50:58.777Z","avatar_url":"https://github.com/RocketChat.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Rocket.Chat Compose Files\n\n## Important Note!\n\nIf you are using the built in MongoDB and are still using the Bitnami MongoDB Images please see this important forum post on how to update:\n\nhttps://forums.rocket.chat/t/action-required-docker-compose-moving-from-bitnami-to-official-mongodb-image/22693\n\n## TLDR;\n\n1. Clone: `git clone --depth 1 https://github.com/RocketChat/rocketchat-compose.git`\n2. cd to the cloned dir: `cd rocketchat-compose`\n3. Copy the example environment file: `cp .env.example .env`\n4. Edit .env file and update values\n5. Start the stack: `docker compose -f compose.database.yml -f compose.monitoring.yml -f compose.traefik.yml -f compose.yml up -d`\n\nYou can access Rocket.Chat at: http://localhost\n\nYou can login to Grafana at: http://grafana.localhost with the default credentials:\n* User: admin\n* Password: rc-admin\n\n## Getting Started\n\nFirst, clone this repository:\n\n```bash\ngit clone --depth 1 https://github.com/RocketChat/rocketchat-compose.git\n```\n\n---\n\n\n### Docker/Podman Compose\n\n\nFor deploying the recommended stack with Rocket.Chat, Traefik, MongoDB, NATS, and Prometheus for monitoring:\n\n1. **Configure environment variables:**\n   - Copy the example environment file:\n     ```bash\n     cp .env.example .env\n     ```\n   - Edit `.env` to fit your deployment. Recommended changes - we recommend to keep other values from the example for reference.\n     ```env\n     # Rocket.Chat Cloud registration token (optional)\n     REG_TOKEN=\n     # Set to 'https' to enable HTTPS with Traefik (recommended for internet exposure)\n     TRAEFIK_PROTOCOL=http\n     # Set to true after you've set your domain and lets encrypt email\n     LETSENCRYPT_ENABLED=\n     # Email for Let's Encrypt certificate\n     LETSENCRYPT_EMAIL=\n     # Domain for Rocket.Chat\n     DOMAIN=localhost\n     # Domain for Grafana, blank to use as a path\n     GRAFANA_DOMAIN=\n     GRAFANA_PATH=/grafana\n     # Should match your domain; use https if enabled\n     ROOT_URL=http://localhost\n     ```\n\n2. **Using Grafana as a Path instead of Subdomain:**\n  - Change the variables\n    ```env\n    # set this to empty\n    GRAFANA_DOMAIN=\n    # set this to you desired path without trailing slash\n    GRAFANA_PATH=/grafana\n    ```\n  - If you wan't to use subdomain\n    ```env\n    # set this to your subdomain\n    GRAFANA_DOMAIN=grafana.your-domain.com\n    # set this as empty\n    GRAFANA_PATH=\n    ```\n\n3. **Start the stack:**\n   - With Docker Compose:\n     ```bash\n     docker compose \\\n       -f compose.monitoring.yml \\\n       -f compose.traefik.yml \\\n       -f compose.database.yml \\\n       -f compose.yml \\\n       up -d\n     ```\n   - Or with Podman Compose:\n     ```bash\n     podman compose \\\n       -f compose.monitoring.yml \\\n       -f compose.traefik.yml \\\n       -f compose.database.yml \\\n       -f compose.yml \\\n       up -d\n     ```\n\n   This will launch all containers. Rocket.Chat will be available at [http://localhost](http://localhost), and Grafana at [http://grafana.localhost](http://grafana.localhost).\n   \u003e **Note:** If deploying to a custom domain, update `ROOT_URL` and related variables accordingly.\n\n4. **Stop the stack:**\n  - With Docker Compose:\n    ```bash\n    docker compose \\\n        -f compose.monitoring.yml \\\n        -f compose.traefik.yml \\\n        -f compose.database.yml \\\n        -f compose.yml \\\n        down\n    ```\n  - Or with Podman Compose:\n     ```bash\n     podman compose \\\n       -f compose.monitoring.yml \\\n       -f compose.traefik.yml \\\n       -f compose.database.yml \\\n       -f compose.yml \\\n       down\n     ```\n\n---\n\n### Customizing the stack\n\nTo exclude components (e.g., MongoDB or Prometheus), simply remove their compose files from the command. For example, to deploy Rocket.Chat with Traefik only:\n\n```bash\npodman compose \\\n  -f compose.traefik.yml \\\n  -f compose.yml \\\n  up -d\n```\n\n\n---\n\n### Multiple servers\nWhen running multiple Rocket.Chat servers, you can configure Traefik to discover those servers and include them in load balancing by adding a variable in the `.env` file:\n\n```env\nROCKETCHAT_BACKEND_SERVERS=rocketchat-1:3000,rocketchat-2:3000,rocketchat-3:3000\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frocketchat%2Frocketchat-compose","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frocketchat%2Frocketchat-compose","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frocketchat%2Frocketchat-compose/lists"}