Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(doc): Update README #81

Merged
merged 7 commits into from
Jan 10, 2025
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 49 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,54 @@
[![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:
- allow-domains: Grant user access to domains.
- 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.
- rotate-secret-key: Rotate the secret key. Users will be forced to log in again. This might be useful if a security breach occurs.
erinecon marked this conversation as resolved.
Show resolved Hide resolved

---
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:

- [Loki](https://charmhub.io/loki-k8s): Loki is a horizontally scalable, highly available, multi-tenant log aggregation system inspired by Prometheus.
erinecon marked this conversation as resolved.
Show resolved Hide resolved
- [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-->
Loading