Skip to content

Commit

Permalink
chore(doc): Update README (#81)
Browse files Browse the repository at this point in the history
* chore(doc): Update README

* chore(doc): Apply comment

* Update README.md

Co-authored-by: Erin Conley <[email protected]>

* chore(trivy): Add go libraries ignore

* chore(): Addressed comments.

---------

Co-authored-by: Erin Conley <[email protected]>
  • Loading branch information
alithethird and erinecon authored Jan 10, 2025
1 parent b05c6a8 commit 6e33c9a
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 13 deletions.
9 changes: 3 additions & 6 deletions .trivyignore
Original file line number Diff line number Diff line change
@@ -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
54 changes: 47 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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) <!--Link to the charm's official documentation-->
* [Developer documentation](https://go-acme.github.io/lego/dns/httpreq/) <!--Link to any developer documentation-->
* [Official webpage](https://go-acme.github.io/lego/dns/httpreq/) <!--(Optional) Link to official webpage/blog/marketing content-->
* [Troubleshooting](https://matrix.to/#/#charmhub-charmdev:ubuntu.com) <!--(Optional) Link to a page or section about troubleshooting/FAQ-->
## Project and community
* [Issues](https://github.com/canonical/httprequest-lego-provider/issues) <!--Link to GitHub issues (if applicable)-->
* [Contributing](https://charmhub.io/httprequest-lego-provider/docs/how-to-contribute) <!--Link to any contribution guides-->
* [Matrix](https://matrix.to/#/#charmhub-charmdev:ubuntu.com) <!--Link to contact info (if applicable), e.g. Matrix channel-->

0 comments on commit 6e33c9a

Please sign in to comment.