Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
csp33 committed Sep 15, 2024
1 parent eb49733 commit afb2442
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 39 deletions.
16 changes: 16 additions & 0 deletions DEV_README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Running the test suite

1. Create a domain in DuckDNS.
2. Run the following command.
```shell
export DUCKDNS_DOMAIN=<your-domain> // Example: my-domain for my-domain.duckdns.org
export DUCKDNS_TOKEN=<your-token>
```
3. Run `make test`

# Pushing the image

```shell
export IMAGE_TAG=1.0.1
docker buildx build --push --platform linux/arm64,linux/amd64 -t csp33/cert-manager-duckdns-webhook:$IMAGE_TAG -t csp33/cert-manager-duckdns-webhook:latest .;
```
65 changes: 26 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,45 +8,32 @@

This WebHook solves the DNS01 challenge to prove ownership of DuckDNS domains.

## Helm Chart

[Helm](https://helm.sh) must be installed to use the charts. Please refer to
Helm's [documentation](https://helm.sh/docs) to get started.

Once Helm has been set up correctly, add the repo as follows:
```shell
helm repo add csp33 https://csp33.github.io/cert-manager-duckdns-webhook
```

If you had already added this repo earlier, run `helm repo update` to retrieve
the latest versions of the packages. You can then run `helm search repo
csp33` to see the charts.

To install the <chart-name> chart:
```shell
helm install cert-manager-duckdns-webhook csp33/cert-manager-duckdns-webhook
```
To uninstall the chart:
```shell
helm uninstall cert-manager-duckdns-webhook
```

### Running the test suite

1. Create a domain in DuckDNS.
2. Run the following command.
```shell
export DUCKDNS_DOMAIN=<your-domain> // Example: my-domain for my-domain.duckdns.org
export DUCKDNS_TOKEN=<your-token>
```
3. Run `make test`

### Pushing the image

```shell
export IMAGE_TAG=1.0.1
docker buildx build --push --platform linux/arm64,linux/amd64 -t csp33/cert-manager-duckdns-webhook:$IMAGE_TAG -t csp33/cert-manager-duckdns-webhook:latest .;
```
## How to use it
1. Add the repository
```shell
helm repo add csp33 https://csp33.github.io/cert-manager-duckdns-webhook
```
2. Create a values.yaml file with the following content:
```yaml
token:
value: <your DuckDNS token>
clusterIssuer:
email: <your email>
production:
create: true
staging:
create: true
```
3. Install the chart:
```shell
helm install cert-manager-duckdns-webhook csp33/cert-manager-duckdns-webhook -f values.yaml
```
4. Add the following annotation to the ingress you want to generate a certificate for:
```yaml
cert-manager.io/cluster-issuer: duckdns-letsencrypt-prod
```
5. Wait for it to finish


## Acknowledgments

Expand Down

0 comments on commit afb2442

Please sign in to comment.