{"id":23075213,"url":"https://github.com/wovalle/angelos","last_synced_at":"2025-08-15T17:31:39.366Z","repository":{"id":46016581,"uuid":"422329475","full_name":"wovalle/angelos","owner":"wovalle","description":"Angelos automates the synchronization of DNS Records between your server and Cloudflare. ","archived":false,"fork":false,"pushed_at":"2024-02-23T20:23:08.000Z","size":562,"stargazers_count":5,"open_issues_count":1,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-03T18:13:40.595Z","etag":null,"topics":["cloudflare","cloudflare-tunnel","docker","homelab-setup","willy-im"],"latest_commit_sha":null,"homepage":"https://github.com/wovalle/angelos","language":"TypeScript","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/wovalle.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}},"created_at":"2021-10-28T19:22:33.000Z","updated_at":"2023-03-17T12:46:30.000Z","dependencies_parsed_at":"2024-02-23T21:29:12.012Z","dependency_job_id":"eb1fad69-b308-49f6-b95c-77c5011788b5","html_url":"https://github.com/wovalle/angelos","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/wovalle/angelos","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wovalle%2Fangelos","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wovalle%2Fangelos/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wovalle%2Fangelos/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wovalle%2Fangelos/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wovalle","download_url":"https://codeload.github.com/wovalle/angelos/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wovalle%2Fangelos/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270603843,"owners_count":24614578,"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-08-15T02:00:12.559Z","response_time":110,"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":["cloudflare","cloudflare-tunnel","docker","homelab-setup","willy-im"],"created_at":"2024-12-16T08:40:33.636Z","updated_at":"2025-08-15T17:31:38.937Z","avatar_url":"https://github.com/wovalle.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv id=\"top\"\u003e\u003c/div\u003e\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/wovalle/angelos\"\u003e\u003c/a\u003e\n\n\u003ch3 align=\"center\"\u003eangelos\u003c/h3\u003e\n  \u003cp align=\"center\"\u003e\n    Angelos automates the synchronization of \u003ca href=\"https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/routing-to-tunnel/dns\"\u003eDNS Records\u003c/a\u003e between your server and cloudflare. Specially useful if you're using \u003ca href=\"https://developers.cloudflare.com/cloudflare-one/connections/connect-apps\"\u003eCloudflare tunnels\u003c/a\u003e to expose your services to internet.\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/wovalle/angelos/discussions/2\"\u003eRoadmap\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/wovalle/angelos/issues\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/wovalle/angelos/issues\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n## About The Project\n\nIn Greek mythology, Angelos (Ancient Greek: Ἄγγελος) was the first daughter of Zeus and [Hera](https://github.com/aschzero/hera). Let's say you\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## Prerequisites\n- You must already have a [Cloudflare Tunnel](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/tunnel-guide) running.\n\n\n##  Configuration\nAngelos supports the following environment variables.\n\n| Env Var | Default | Description  |\n| ------------- |-------------| -----|\n| CLOUDFLARE_ZONE_ID `*` | `N/A` | Zone id where your cf domain is. Usually can be seen under API section after selecting a domain in your [dashboard](https://dash.cloudflare.com/) or through their [api](https://api.cloudflare.com/#zone-list-zones) |\n| CLOUDFLARE_API_TOKEN `*` | `N/A` | CF Api Token with edit DNS Record Permission. See [here](https://github.com/wovalle/angelos/discussions/4)|\n| CLOUDFLARE_TUNNEL_URL  `*` | `N/A` | Your [tunnel url](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/tunnel-guide) that should follow `uuid.cfargotunnel.com` |\n| PROVIDER | `docker` | Supported values: `docker`, `traefik`. If provider=`docker` you must pass a docker sock (see [docker](#docker) example) if provider=`traefik` you must pass `TRAEFIK_API_URL` |\n| DOCKER_LABEL_HOSTNAME | `angelos.hostname` | Which docker label will angelos use as a hostname|\n| DOCKER_LABEL_ENABLE | `angelos.enabled` | If set to false, the service will be ignored |\n| LOG_LEVEL | `info` | Possible values: `silly`, `trace`, `debug`, `info`, `warn`, `error`, `fatal` \n| DRY_RUN | false | If set to true, Angelos will not create or delete DNS records |\n| DELETE_DNS_RECORD_DELAY | 300 | How many seconds it'll wait to delete a dns record in cf (in case you removed a service by mistake) |\n| ADD_DNS_RECORD_DELAY | 60 | How many seconds it'll wait to create a dns record in cf (in case you removed a service by mistake) |\n| TRAEFIK_API_URL | `N/A` | If provider=`traefik` this must point to Traefik's [api url](https://doc.traefik.io/traefik/operations/api/) |\n| TRAEFIK_POLL_INTERVAL | 600 | Indicates how often (in seconds) angelos will check traefik routers|\n\n`*` Required\n\n\u003cdiv id=\"docker\"\u003e\u003c/div\u003e\n\n### Running with Docker\n\n```bash\ndocker run \\\n-e CLOUDFLARE_ZONE_ID=\u003ccloudflare zone\u003e \\ # Required\n-e CLOUDFLARE_API_TOKEN=\u003ctoken with edit dns record permission\u003e \\ # Required\n-e CLOUDFLARE_TUNNEL_URL=\u003ctunnel-uuid.cfargotunnel.com\u003e \\ # Required\n-e PROVIDER=docker \\ # for more options, see Configuration\n-v /var/run/docker.sock:/var/run/docker.sock \\ # if provider=docker\nghcr.io/wovalle/angelos\n```\n### Running with Docker-Compose\n```yaml\nangelos:\n  image: ghcr.io/wovalle/angelos\n  container_name: angelos\n  environment:\n    - CLOUDFLARE_ZONE_ID=\u003ccloudflare zone\u003e # Required\n    - CLOUDFLARE_API_TOKEN=\u003ctoken with edit dns record permission\u003e # Required\n    - CLOUDFLARE_TUNNEL_URL=\u003ctunnel-uuid.cfargotunnel.com\u003e # Required\n    - PROVIDER=docker\n    # for more options, see Configuration\n  volumes:\n    - /var/run/docker.sock:/var/run/docker.sock # if provider=docker\n```\n\n### Running manually\nAngelos is a typescript project. You'll need [node 14](https://nodejs.org/en/) or later.\n\n- Clone the project from github:\n\n```bash\ngit clone git@github.com:wovalle/angelos.git\n```\n\n- Install the dependencies:\n\n```bash\nyarn # or npm install\n```\n\n- Create a credentials file\n```\nCopy the existing .env.example and name it .env\n```\n\n- Run the project\n```bash\nyarn start # or npm start\n```\n\n- Have fun!\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n## Contributing\n\nHave a bug or a feature request? Please search [the issues](https://github.com/wovalle/fireorm/issues) to prevent duplication. If you couldn't find what you were looking for, [proceed to open a new one](https://github.com/wovalle/fireorm/issues/new). Pull requests are welcome!\n\n### Commiting\n\nThis repo uses [Conventional Commits](https://www.conventionalcommits.org/) as the commit messages convention. Commits must follow [Angular's git commit guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines).\n\nSupported commit types ([source](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#type)):\n\n- **feat:** A new feature\n- **fix:** A bug fix\n- **docs:** Documentation only changes\n- **style:** Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)\n- **refactor:** A code change that neither fixes a bug nor adds a feature\n- **perf:** A code change that improves performance\n- **test:** Adding missing or correcting existing tests\n- **chore:** Changes to the build process or auxiliary tools and libraries such as documentation generation\n\n### Releases\n\nThis repo uses [Github Actions](https://github.com/wovalle/angelos/tree/main/.github/workflows) to automate workflows like run tests and create releases. It uses [Sematic Release](https://github.com/semantic-release/semantic-release) to bump the versions according to their commit messages. \n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## Contributors\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"http://twitter.com/wovalle\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/7854116?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eWilly Ovalle\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/wovalle/fireorm/commits?author=wovalle\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/wovalle/fireorm/commits?author=wovalle\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#example-wovalle\" title=\"Examples\"\u003e💡\u003c/a\u003e \u003ca href=\"#ideas-wovalle\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"https://github.com/wovalle/fireorm/commits?author=wovalle\" title=\"Tests\"\u003e⚠️\u003c/a\u003e\u003c/td\u003e\n\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\n## License\n\nMIT © [Willy Ovalle](https://github.com/wovalle). See [LICENSE](https://github.com/wovalle/fireorm/blob/master/LICENSE) for details.\n\n\u003cp align=\"left\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwovalle%2Fangelos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwovalle%2Fangelos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwovalle%2Fangelos/lists"}