https://github.com/jungaretti/bacon
Deploy your DNS records from YAML config files to Porkbun
https://github.com/jungaretti/bacon
bacon dns porkbun
Last synced: 8 months ago
JSON representation
Deploy your DNS records from YAML config files to Porkbun
- Host: GitHub
- URL: https://github.com/jungaretti/bacon
- Owner: jungaretti
- License: gpl-3.0
- Created: 2022-03-05T09:23:42.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-31T04:50:29.000Z (over 1 year ago)
- Last Synced: 2025-01-31T05:25:40.579Z (over 1 year ago)
- Topics: bacon, dns, porkbun
- Language: Go
- Homepage:
- Size: 215 KB
- Stars: 13
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bacon 🥓
Bacon deploys your DNS records from YAML config files to [Porkbun](https://porkbun.com/api/json/v3/documentation). You can use Bacon to deploy, backup, and restore your DNS records.
## Getting Started
You can use Bacon locally or in a GitHub Actions workflow. For local use, download the latest release from GitHub or build it yourself. For GitHub Actions, use the [Bacon Deploy Action](https://github.com/jungaretti/bacon-deploy-action) in your workflow.
### Installation
[Download the latest release from GitHub.](https://github.com/jungaretti/bacon/releases)
[](https://github.com/jungaretti/bacon/actions/workflows/release-assets.yml)
#### Build it Yourself
1. Install Bacon's prerequisites:
- [Go](https://go.dev/dl/)
- [GNU Make](https://ftp.gnu.org/gnu/make/)
2. Clone this repo and use `make` to build `bin/bacon`
3. Authenticate with your DNS provider (see below)
### Authentication
Sign into Porkbun and [generate a new API keyset](https://porkbun.com/account/api) for your account. Read the ["Generating API Keys" section of Porkbun's docs](https://kb.porkbun.com/article/190-getting-started-with-the-porkbun-dns-api) for more detailed instructions. Be sure to enable API access for the domain(s) that you would like to manage with Bacon.
Next, `export` the `PORKBUN_API_KEY` and `PORKBUN_SECRET_KEY` environment variables or add them to an `.env` file. Bacon uses these environment variables to authenticate with Porkbun. If the current directory contains an `.env` file, then Bacon will load its contents into environment variables. See [`.env.example`](https://github.com/jungaretti/bacon/blob/main/.env.example) for an example.
You can use [`bacon ping`](#ping) to check your authentication configuration.
## Usage
Bacon offers a few commands to help you deploy and save your DNS records:
- `ping` to double-check your API keys (stored in environment variables)
- `deploy ` to deploy DNS records from a YAML config file
- `print ` to print your DNS records in YAML format
### Commands
#### `ping`
Verifies your API keys by pinging Porkbun.
#### `deploy `
Deploys records from a domain's config file by deleting unknown records and creating new records. Defaults to a dry-run mode that doesn't modify your DNS records.
##### Parameters
- `--delete` disable dry-run deletions and delete outdated records
- `--create` disable dry-run creations and create new records
#### `print `
Prints records for a domain in YAML format.
##### Notes
Use `>` to redirect output to a Bacon config file. For example, `bacon print example.com > example.com.yml`
## Configuration
See [`config.example.yml`](https://github.com/jungaretti/bacon/blob/main/config.example.yml) for a complete example.
```yaml
domain: example.com
records:
- type: A
host: blog.example.com
content: 123.456.789.112
ttl: 600
- type: A
host: www.example.com
content: 123.456.789.112
ttl: 600
```
### Schema
#### Record
- `type` - Required. Allowed values: `A`, `MX`, `CNAME`, `ALIAS`, `TXT`, `NS`, `AAAA`, `SRV`, `TLSA`, `CAA`, `HTTPS`, `SVCB`.
- `host` - Required.
- `content` - Required.
- `ttl` - Required. Minimum value: `600`.
- `priority` - Optional. Allowed for `MX` and `SRV` records.
Bacon does not support `priority`. In order to specify a certain `priority`, you must create the record with Bacon and update the `priority` manually.
#### Config
- `domain` - Required.
- `records`
## Development
```bash
# Build Bacon
make build
# Run unit tests
make test-unit
# Run system tests (auth required)
make test-system
```
## Built With
- [Cobra](https://cobra.dev/)
- [Porkbun API](https://porkbun.com/api/json/v3/documentation)