Categorygithub.com/widhaprasa/go-acme-service
repositorypackage
0.9.5
Repository: https://github.com/widhaprasa/go-acme-service.git
Documentation: pkg.go.dev
Overview
Dependencies
15
Dependents
0

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# README

go-acme-service

go-acme-service is a service for generating and renewing Let's Encrypt certificates as a service. It utilizes the go-acme/lego library and currently supports the DNS Challenge using the Cloudflare provider.

The service is protected using basic authentication for its endpoints and stores certificate data using an SQLite database.

How to Use

To use go-acme-service, you must set the following environment variables:

Cloudflare API Credentials:

  • CF_API_EMAIL
  • CF_DNS_API_TOKEN
  • CF_ZONE_API_TOKEN

These credentials are required to authenticate with Cloudflare's DNS for the DNS Challenge.

Basic Authentication Credentials:

  • SERVICE_USERNAME
  • SERVICE_PASSWORD

These variables are used to secure the service endpoints with basic authentication.

Service Port

The default port for the service is 8080, but you can change it using the environment variable:

  • SERVICE_PORT

SQLite Database

The service uses an SQLite database located at db/acme.db to store certificate-related data. Ensure that this path is available and accessible for proper operation of the service.

API Endpoints

DescriptionMethodEndpoint
Certs ListGET/certs/list
Certs ReadPOST/certs/read
Certs Private KeyPOST/certs/privatekey
Certs CertificatesPOST/certs/certificate
Certs GeneratePOST/certs/generate
Certs DeletePOST/certs/delete

For more details on how to configure the Cloudflare provider, please refer to the official documentation:
Cloudflare DNS Challenge Setup