{"id":21436788,"url":"https://github.com/modfin/callr","last_synced_at":"2025-03-16T23:23:50.639Z","repository":{"id":106892775,"uuid":"246354836","full_name":"modfin/callr","owner":"modfin","description":"A service that calls you when things go bad","archived":false,"fork":false,"pushed_at":"2020-03-21T09:33:05.000Z","size":69,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-01-23T09:34:05.479Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","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/modfin.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}},"created_at":"2020-03-10T16:40:31.000Z","updated_at":"2023-01-13T06:42:33.000Z","dependencies_parsed_at":null,"dependency_job_id":"32029f3e-92d2-44fb-9052-4fa76954255d","html_url":"https://github.com/modfin/callr","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modfin%2Fcallr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modfin%2Fcallr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modfin%2Fcallr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/modfin%2Fcallr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/modfin","download_url":"https://codeload.github.com/modfin/callr/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243945788,"owners_count":20372932,"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","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":"2024-11-23T00:15:35.617Z","updated_at":"2025-03-16T23:23:50.631Z","avatar_url":"https://github.com/modfin.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Callr\n\nCallr is a small service that, through the use of Twillo, can call an on-call list when an incident occurs.\nIt is meant to be used in with together with another service that monitor uptime, eg. Statuscake, Pingdom \nor really anything that can perform a HTTP GET or POST when an call needs to be made.\n \nSimply put, call and wake someone if things goes down. \n\n## Running on local\n\n* Create a Twillo account and buy a phone number to be used.  \n* Run `ngrok http 8080` in a terminal (Twillo need to be able make requests to Callr)\n* Create a docker compose file containing the twillio and ngrok data\n* `docker-compose up`\n\n```bash \n$ git clone https://github.com/modfin/callr\n$ cd callr\n\n$ echo 'version: \"3.0\"\nservices:\n  callr:\n    build:\n      context: ./cmd/callrd\n      dockerfile: Dockerfile.dev\n    ports:\n      - \"8080:8080\"\n    environment:\n      - \"PORT=8080\"\n      - \"TWIL_SID=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\"\n      - \"TWIL_TOKEN=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY\"\n      - \"TWIL_PHONE=+46123456789\"\n      - \"BASE_URL=https://\u003cNGROK_ID\u003e.ngrok.io\"\n      - \"DATA_PATH=/go/src/callr/store\"\n      - \"BASIC_AUTH_USER=admin\"\n      - \"BASIC_AUTH_PASS=qwerty\"\n      - \"INCIDENT_TOKEN=ABCDEFGHIJ\"\n      - \"INCIDENT_ROTTEN_DURATION=4h\"\n    volumes:\n      - .:/go/src/callr:cached\n      - gopkg:/go/pkg:cached\n\nvolumes:\n  gopkg:\n' \u003e docker-compose.yml\n\n$ docker-compose up\ncallr_1  | ---- API ----\ncallr_1  | Incident reporting: POST/GET: https://b94a4401.ngrok.io/incident?token=ABCDEFGHIJ\ncallr_1  |     Incident is rotten after: 4h0m0s\ncallr_1  | \ncallr_1  | ---- GUI ----\ncallr_1  | Page at: https://b94a4401.ngrok.io\n```\n\n\n\n## Production\n\n**Docker swarm example**\n\n* Create a small node on a VPS provider such as Digital Ocean or Linode \n* Point a DNS `A` record to the IP of the node\n* Install docker on the node\n* Run the following (with the correct credentials)\n\n```bash \nmkdir -p /root/callr\nmkdir -p /root/callr-tls\necho '\nversion: \"3.2\"\nservices:\n  callr:\n    image: modfin/callrd:latest\n    ports:\n      - target: 80\n        published: 80\n        protocol: tcp\n        mode: host\n      - target: 443\n        published: 443\n        protocol: tcp\n        mode: host\n    environment:\n      - \"AUTO_TLS=true\"\n      - \"AUTO_TLS_DIR=/callr-tls\"\n      - \"DEBUG=true\"\n      - \"TWIL_SID=XXXXXXXXXXXXXXXXXXXXXXXX\"\n      - \"TWIL_TOKEN=YYYYYYYYYYYYYYYYYYYYYYY\"\n      - \"TWIL_PHONE=+4612345678\"\n      - \"BASE_URL=https://callr.example.com\"\n      - \"DATA_PATH=/callr-data\"\n      - \"BASIC_AUTH_USER=aUser\"\n      - \"BASIC_AUTH_PASS=aPassword\"\n      - \"INCIDENT_TOKEN=ABCDEFGHIJ\"\n    volumes:\n      - /root/callr:/callr-data\n      - /root/callr-tls:/callr-tls\n' \u003e docker-compose.yml\n\n$ docker stack deploy callr -c ./docker-compose.yml\n\n```\n\n* Go to `https://callr.example.com` and add a on-call list\n* Add the post hook `https://callr.example.com/incident?token=ABCDEFGHIJ` to you monitoring service\n\n## TODO\n* Testing\n* Some clean up \n* Add SQL based DAO\n* Rewriting some stuff to be able to run as a cloud function.\n\n \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmodfin%2Fcallr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmodfin%2Fcallr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmodfin%2Fcallr/lists"}