{"id":32431184,"url":"https://github.com/jungaretti/bacon","last_synced_at":"2025-10-25T21:57:51.722Z","repository":{"id":40448968,"uuid":"466406696","full_name":"jungaretti/bacon","owner":"jungaretti","description":"Deploy your DNS records from YAML config files to Porkbun","archived":false,"fork":false,"pushed_at":"2025-01-31T04:50:29.000Z","size":220,"stargazers_count":13,"open_issues_count":4,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-31T05:25:40.579Z","etag":null,"topics":["bacon","dns","porkbun"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jungaretti.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":"2022-03-05T09:23:42.000Z","updated_at":"2025-01-31T04:48:23.000Z","dependencies_parsed_at":"2023-01-29T22:50:13.622Z","dependency_job_id":"6d044e6b-9bea-49fe-ad37-b8cec574134d","html_url":"https://github.com/jungaretti/bacon","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/jungaretti/bacon","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jungaretti%2Fbacon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jungaretti%2Fbacon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jungaretti%2Fbacon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jungaretti%2Fbacon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jungaretti","download_url":"https://codeload.github.com/jungaretti/bacon/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jungaretti%2Fbacon/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281026223,"owners_count":26431753,"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":["bacon","dns","porkbun"],"created_at":"2025-10-25T21:57:48.624Z","updated_at":"2025-10-25T21:57:51.714Z","avatar_url":"https://github.com/jungaretti.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bacon 🥓\n\nBacon 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.\n\n![Demo of bacon deploy](https://user-images.githubusercontent.com/19893438/167231076-2f99e0ce-9ed7-40e4-9b1e-fc2fd578cd0f.gif)\n\n## Getting Started\n\nYou 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.\n\n### Installation\n\n[Download the latest release from GitHub.](https://github.com/jungaretti/bacon/releases)\n\n[![Status of release assets](https://github.com/jungaretti/bacon/actions/workflows/release-assets.yml/badge.svg)](https://github.com/jungaretti/bacon/actions/workflows/release-assets.yml)\n\n#### Build it Yourself\n\n1. Install Bacon's prerequisites:\n   - [Go](https://go.dev/dl/)\n   - [GNU Make](https://ftp.gnu.org/gnu/make/)\n2. Clone this repo and use `make` to build `bin/bacon`\n3. Authenticate with your DNS provider (see below)\n\n### Authentication\n\nSign 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.\n\nNext, `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.\n\nYou can use [`bacon ping`](#ping) to check your authentication configuration.\n\n## Usage\n\nBacon offers a few commands to help you deploy and save your DNS records:\n\n- `ping` to double-check your API keys (stored in environment variables)\n- `deploy \u003cconfig\u003e` to deploy DNS records from a YAML config file\n- `print \u003cdomain\u003e` to print your DNS records in YAML format\n\n### Commands\n\n#### `ping`\n\nVerifies your API keys by pinging Porkbun.\n\n#### `deploy \u003cconfig\u003e`\n\nDeploys 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.\n\n##### Parameters\n\n- `--delete` disable dry-run deletions and delete outdated records\n- `--create` disable dry-run creations and create new records\n\n#### `print \u003cdomain\u003e`\n\nPrints records for a domain in YAML format.\n\n##### Notes\n\nUse `\u003e` to redirect output to a Bacon config file. For example, `bacon print example.com \u003e example.com.yml`\n\n## Configuration\n\nSee [`config.example.yml`](https://github.com/jungaretti/bacon/blob/main/config.example.yml) for a complete example.\n\n```yaml\ndomain: example.com\nrecords:\n  - type: A\n    host: blog.example.com\n    content: 123.456.789.112\n    ttl: 600\n  - type: A\n    host: www.example.com\n    content: 123.456.789.112\n    ttl: 600\n```\n\n### Schema\n\n#### Record\n\n- `type` - Required. Allowed values: `A`, `MX`, `CNAME`, `ALIAS`, `TXT`, `NS`, `AAAA`, `SRV`, `TLSA`, `CAA`, `HTTPS`, `SVCB`.\n- `host` - Required.\n- `content` - Required.\n- `ttl` - Required. Minimum value: `600`.\n- `priority` - Optional. Allowed for `MX` and `SRV` records.\n\nBacon does not support `priority`. In order to specify a certain `priority`, you must create the record with Bacon and update the `priority` manually.\n\n#### Config\n\n- `domain` - Required.\n- `records`\n\n## Development\n\n```bash\n# Build Bacon\nmake build\n\n# Run unit tests\nmake test-unit\n\n# Run system tests (auth required)\nmake test-system\n```\n\n## Built With\n\n- [Cobra](https://cobra.dev/)\n- [Porkbun API](https://porkbun.com/api/json/v3/documentation)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjungaretti%2Fbacon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjungaretti%2Fbacon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjungaretti%2Fbacon/lists"}