Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wovalle/angelos
Angelos automates the synchronization of DNS Records between your server and Cloudflare.
https://github.com/wovalle/angelos
cloudflare cloudflare-tunnel docker homelab-setup willy-im
Last synced: about 2 months ago
JSON representation
Angelos automates the synchronization of DNS Records between your server and Cloudflare.
- Host: GitHub
- URL: https://github.com/wovalle/angelos
- Owner: wovalle
- License: mit
- Created: 2021-10-28T19:22:33.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-23T20:23:08.000Z (12 months ago)
- Last Synced: 2024-02-23T21:29:09.358Z (12 months ago)
- Topics: cloudflare, cloudflare-tunnel, docker, homelab-setup, willy-im
- Language: TypeScript
- Homepage: https://github.com/wovalle/angelos
- Size: 549 KB
- Stars: 5
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
angelos
Angelos automates the synchronization of DNS Records between your server and cloudflare. Specially useful if you're using Cloudflare tunnels to expose your services to internet.
Roadmap
·
Report Bug
·
Request Feature
## About The Project
In Greek mythology, Angelos (Ancient Greek: Ἄγγελος) was the first daughter of Zeus and [Hera](https://github.com/aschzero/hera). Let's say you
## Prerequisites
- You must already have a [Cloudflare Tunnel](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/tunnel-guide) running.
## Configuration
Angelos supports the following environment variables.
| Env Var | Default | Description |
| ------------- |-------------| -----|
| 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) |
| CLOUDFLARE_API_TOKEN `*` | `N/A` | CF Api Token with edit DNS Record Permission. See [here](https://github.com/wovalle/angelos/discussions/4)|
| 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` |
| 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` |
| DOCKER_LABEL_HOSTNAME | `angelos.hostname` | Which docker label will angelos use as a hostname|
| DOCKER_LABEL_ENABLE | `angelos.enabled` | If set to false, the service will be ignored |
| LOG_LEVEL | `info` | Possible values: `silly`, `trace`, `debug`, `info`, `warn`, `error`, `fatal`
| DRY_RUN | false | If set to true, Angelos will not create or delete DNS records |
| 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) |
| 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) |
| TRAEFIK_API_URL | `N/A` | If provider=`traefik` this must point to Traefik's [api url](https://doc.traefik.io/traefik/operations/api/) |
| TRAEFIK_POLL_INTERVAL | 600 | Indicates how often (in seconds) angelos will check traefik routers|
`*` Required
### Running with Docker
```bash
docker run \
-e CLOUDFLARE_ZONE_ID= \ # Required
-e CLOUDFLARE_API_TOKEN= \ # Required
-e CLOUDFLARE_TUNNEL_URL= \ # Required
-e PROVIDER=docker \ # for more options, see Configuration
-v /var/run/docker.sock:/var/run/docker.sock \ # if provider=docker
ghcr.io/wovalle/angelos
```
### Running with Docker-Compose
```yaml
angelos:
image: ghcr.io/wovalle/angelos
container_name: angelos
environment:
- CLOUDFLARE_ZONE_ID= # Required
- CLOUDFLARE_API_TOKEN= # Required
- CLOUDFLARE_TUNNEL_URL= # Required
- PROVIDER=docker
# for more options, see Configuration
volumes:
- /var/run/docker.sock:/var/run/docker.sock # if provider=docker
```
### Running manually
Angelos is a typescript project. You'll need [node 14](https://nodejs.org/en/) or later.
- Clone the project from github:
```bash
git clone [email protected]:wovalle/angelos.git
```
- Install the dependencies:
```bash
yarn # or npm install
```
- Create a credentials file
```
Copy the existing .env.example and name it .env
```
- Run the project
```bash
yarn start # or npm start
```
- Have fun!
## Contributing
Have 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!
### Commiting
This 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).
Supported commit types ([source](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#type)):
- **feat:** A new feature
- **fix:** A bug fix
- **docs:** Documentation only changes
- **style:** Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- **refactor:** A code change that neither fixes a bug nor adds a feature
- **perf:** A code change that improves performance
- **test:** Adding missing or correcting existing tests
- **chore:** Changes to the build process or auxiliary tools and libraries such as documentation generation
### Releases
This 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.
## Contributors
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
## License
MIT © [Willy Ovalle](https://github.com/wovalle). See [LICENSE](https://github.com/wovalle/fireorm/blob/master/LICENSE) for details.
