{"id":30353145,"url":"https://github.com/canepro/rocketchat-local-dev","last_synced_at":"2025-10-25T03:36:35.943Z","repository":{"id":310239721,"uuid":"1039168630","full_name":"Canepro/rocketchat-local-dev","owner":"Canepro","description":"Local development stack for Rocket.Chat with MongoDB, Redis, Traefik","archived":false,"fork":false,"pushed_at":"2025-08-16T17:09:16.000Z","size":3,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-16T19:06:29.869Z","etag":null,"topics":["dev-environment","docker-compose","mongo","redis","rocketchat"],"latest_commit_sha":null,"homepage":null,"language":null,"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/Canepro.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-08-16T16:16:30.000Z","updated_at":"2025-08-16T17:09:53.000Z","dependencies_parsed_at":"2025-08-16T19:17:20.092Z","dependency_job_id":null,"html_url":"https://github.com/Canepro/rocketchat-local-dev","commit_stats":null,"previous_names":["canepro/rocketchat-local-dev"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/Canepro/rocketchat-local-dev","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Canepro%2Frocketchat-local-dev","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Canepro%2Frocketchat-local-dev/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Canepro%2Frocketchat-local-dev/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Canepro%2Frocketchat-local-dev/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Canepro","download_url":"https://codeload.github.com/Canepro/rocketchat-local-dev/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Canepro%2Frocketchat-local-dev/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280901466,"owners_count":26410586,"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-25T02:00:06.499Z","response_time":81,"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":["dev-environment","docker-compose","mongo","redis","rocketchat"],"created_at":"2025-08-19T01:21:09.736Z","updated_at":"2025-10-25T03:36:35.916Z","avatar_url":"https://github.com/Canepro.png","language":null,"readme":"# Rocket.Chat Local Dev Stack\n\n![Compose Lint](https://github.com/Canepro/rocketchat-local-dev/actions/workflows/compose-lint.yml/badge.svg?branch=main)\n\nSet up Rocket.Chat locally with MongoDB, Redis, and Traefik in one command.\nWorks with Docker or Podman. Designed to be beginner‑friendly.\n\n## Prerequisites\n\n- One of:\n  - Docker Desktop (or Docker Engine with Compose)\n  - Podman + podman-compose (or Podman with `podman compose`)\n- Bash shell (macOS, Linux, or WSL)\n\nTip for Windows users: run this in WSL for the smoothest experience.\n\n## Get the code\n\n```bash\ngit clone https://github.com/Canepro/rocketchat-local-dev.git\ncd rocketchat-local-dev\n```\n\n## Quick start (one command)\n\n```bash\n./up.sh\n```\n\nWhat this does:\n\n- Creates `.env` from `.env.example` if it doesn’t exist\n- Detects Docker or Podman automatically\n- Starts all services\n- Waits for MongoDB and initializes the replica set (required by Rocket.Chat)\n\nOpen:\n\n- Rocket.Chat: [http://localhost:8080](http://localhost:8080)\n- Traefik Dashboard (dev only): [http://localhost:8081](http://localhost:8081)\n\nIf you get “permission denied” running scripts, make them executable once:\n\n```bash\nchmod +x up.sh down.sh upgrade.sh\n```\n\n## Common tasks\n\n- Stop and remove everything:\n\n  ```bash\n  ./down.sh\n  ```\n\n- Upgrade Rocket.Chat (or other images):\n  1) Edit `.env` and bump the image tag(s), e.g. `ROCKETCHAT_IMAGE=rocketchat/rocket.chat:7.5.1`\n  2) Apply the upgrade:\n\n  ```bash\n  ./upgrade.sh\n  ```\n\n- Change the port (served by Traefik):\n\n  ```env\n  TRAEFIK_HTTP_PORT=8080\n  ```\n\n  Then restart:\n\n  ```bash\n  ./down.sh \u0026\u0026 ./up.sh\n  ```\n\n## How it works (simple overview)\n\n- Traefik reverse‑proxies [http://localhost:8080](http://localhost:8080) → Rocket.Chat on port 3000\n- We use Traefik’s file provider (no Docker/Podman socket needed)\n- MongoDB runs as a single‑node replica set (Rocket.Chat requirement)\n- Redis is used for performance and realtime features\n\n## Best practices (local dev)\n\n- Keep your customizations in `.env` (image tags, ports, project name)\n- Prefer `podman compose` on Linux if you’re using Podman; the scripts detect it too\n- Avoid mapping container ports publicly beyond what you need (we expose 8080 and 8081 only)\n- Use volumes for data (`mongo-data` is persisted) and `./down.sh` to reset cleanly\n- For production, do NOT use this stack as-is. Secure Traefik (TLS, auth), harden MongoDB, add backups, etc.\n\n## Logs and troubleshooting\n\n- Service logs:\n  - Docker: `docker compose logs -f \u003cservice\u003e`\n  - Podman: `podman compose logs -f \u003cservice\u003e` or `podman-compose logs -f \u003cservice\u003e`\n- Useful services to check: `rocketchat`, `mongo`, `traefik`\n- If you previously saw `/var/run/docker.sock` permission errors: fixed. Traefik now uses a file provider.\n\n## File layout\n\n- `docker-compose.yml`: services (Traefik, MongoDB, Redis, Rocket.Chat)\n- `traefik/dynamic.yml`: Traefik routing (no engine socket required)\n- `up.sh` / `down.sh` / `upgrade.sh`: one‑click start/stop/upgrade scripts\n- `.env.example`: defaults you can copy to `.env`\n\n## License\n\nMIT\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcanepro%2Frocketchat-local-dev","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcanepro%2Frocketchat-local-dev","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcanepro%2Frocketchat-local-dev/lists"}