diff --git a/.trivyignore b/.trivyignore index a4e6b60..ee88d5a 100644 --- a/.trivyignore +++ b/.trivyignore @@ -1,8 +1,5 @@ CVE-2022-40897 CVE-2024-6345 -# Pebble -CVE-2024-34156 -CVE-2024-45338 -# statsd exporter -CVE-2024-45337 -CVE-2024-45338 +# statsd-exporter +CVE-2024-45338 # golang.org/x/net +CVE-2024-45337 # golang.org/x/crypto \ No newline at end of file diff --git a/README.md b/README.md index f7ff107..5b41435 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,52 @@ +[![CharmHub Badge](https://charmhub.io/httprequest-lego-provider/badge.svg)](https://charmhub.io/httprequest-lego-provider) +[![Publish to edge](https://github.com/canonical/httprequest-lego-provider/actions/workflows/publish_charm.yaml/badge.svg)](https://github.com/canonical/httprequest-lego-provider/actions/workflows/publish_charm.yaml) +[![Promote charm](https://github.com/canonical/httprequest-lego-provider/actions/workflows/promote_charm.yaml/badge.svg)](https://github.com/canonical/httprequest-lego-provider/actions/workflows/promote_charm.yaml) +[![Discourse Status](https://img.shields.io/discourse/status?server=https%3A%2F%2Fdiscourse.charmhub.io&style=flat&label=CharmHub%20Discourse)](https://discourse.charmhub.io) + # HTTPRequest Lego Provider -A Django application implementing [HTTPRequest Lego Provider](https://go-acme.github.io/lego/dns/httpreq/). +A Juju charm deploying and managing [HTTP request Lego provider as defined by ACME](https://go-acme.github.io/lego/dns/httpreq/) +to manage DNS records. It allows for deployment on +many different Kubernetes platforms, from [MicroK8s](https://microk8s.io) to +[Charmed Kubernetes](https://ubuntu.com/kubernetes) to public cloud Kubernetes +offerings. -## Project and community +Like any Juju charm, this charm supports one-line deployment, configuration, integration, scaling, and more. For Charmed HTTP request Lego provider, this includes: + - Scaling + - Integration with PostgreSQL + +For information about how to deploy, integrate, and manage this charm, see the Official [HTTP request Lego provider Documentation](https://charmhub.io/httprequest-lego-provider/docs). + + +## Get started + +You can follow the tutorial [here](https://charmhub.io/httprequest-lego-provider/docs/tutorial-deploy-the-deploy-the-httprequest-lego-provider-charm-for-the-first-time). + +### Basic operations -The HTTPRequest Lego Provider is a member of the Ubuntu family. It's an open source -project that warmly welcomes community projects, contributions, suggestions, -fixes and constructive feedback. -* [Code of conduct](https://ubuntu.com/community/code-of-conduct) +The following actions are available for this charm: + - create-superuser: Create a new Django superuser account. + - create-user: Create a user for the services that will be requesting the domains. If it exists, the password will be updated. + - list-domains: List the domains an user has access to. + - revoke-domains: Revoke user access to domains. ---- +You can check out the [full list of actions here](https://charmhub.io/httprequest-lego-provider/actions). + +## Integrations + +This charm can be integrated with other Juju charms and services: + + - [COS](https://charmhub.io/topics/canonical-observability-stack): Canonical Observability Stack gathers, processes, visualizes, and alerts on telemetry signals generated by workloads running both within, and outside of, Juju. + - [PostgreSQL](https://charmhub.io/postgresql-k8s): PostgreSQL is a powerful, open source object-relational database system. + +You can find the full list of integrations [here](https://charmhub.io/httprequest-lego-provider/integrations). + +## Learn more +* [Read more](https://charmhub.io/httprequest-lego-provider) +* [Developer documentation](https://go-acme.github.io/lego/dns/httpreq/) +* [Official webpage](https://go-acme.github.io/lego/dns/httpreq/) +* [Troubleshooting](https://matrix.to/#/#charmhub-charmdev:ubuntu.com) +## Project and community +* [Issues](https://github.com/canonical/httprequest-lego-provider/issues) +* [Contributing](https://charmhub.io/httprequest-lego-provider/docs/how-to-contribute) +* [Matrix](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)