Merge pull request #27 from esnet/develop/docs

fix missing image in README

Author: netops2devops

.pre-commit-config.yaml

@@ -17,3 +17,8 @@ repos:
         language: system
         pass_filenames: false
         types: [go]
+
+  -   repo: https://github.com/gitleaks/gitleaks
+      rev: v8.30.1
+      hooks:
+        - id: gitleaks

README.md

@@ -4,7 +4,17 @@
 
 ## How It Works
 
-When a client successfully completes an ACME challenge, `acme-proxy` forwards the certificate signing request to an external certificate authority (CA) that supports External Account Binding (EAB). The external CA signs the certificate and returns it to the client through `acme-proxy`.
+`acme-proxy` runs as an ACME server inside your enterprise environment, acting as an intermediary between your internal infrastructure and an external certificate authority service (such as Sectigo). When a client successfully completes an ACME challenge, `acme-proxy` forwards the certificate signing request to an external certificate authority (CA) that supports External Account Binding (EAB). The external CA signs the certificate and returns it to the client through `acme-proxy`.
+
+**Certificate Request Flow:**
+
+1. Your internal server (behind a firewall perimeter) requests a certificate from `acme-proxy` using standard ACME clients like certbot, acme.sh or cert-manager.io if you're using Kubernetes.
+2. `acme-proxy` presents cryptographic challenges to verify domain ownership
+3. Once validation succeeds, `acme-proxy` forwards the certificate signing request to your external CA using External Account Binding (EAB)
+4. The external CA signs the certificate
+5. `acme-proxy` retrieves the certificate bundle and returns it to your server
+
+![sequence diagram](docs/assets/highlevel-flow.png)
 
 **Note:** LetsEncrypt does not support EAB. However, commercial CAs such as Sectigo and ZeroSSL do.
 
@@ -40,20 +50,6 @@ Using ACME with commercial CAs in enterprise environments provides several advan
 - Leverage standard ACME clients (Certbot, acme.sh, cert-manager.io) for certificate issuance, automatic renewals.
 - Enable self-service certificate requests for development teams
 
-## ACME Proxy Workflow
-
-`acme-proxy` runs as an ACME server inside your enterprise environment, acting as an intermediary between your internal infrastructure and an external certificate authority service (such as Sectigo).
-
-**Certificate Request Flow:**
-
-1. Your internal server (behind a firewall perimeter) requests a certificate from `acme-proxy` using standard ACME clients like certbot, acme.sh or cert-manager.io if you're using Kubernetes.
-2. `acme-proxy` presents cryptographic challenges to verify domain ownership
-3. Once validation succeeds, `acme-proxy` forwards the certificate signing request to your external CA using External Account Binding (EAB)
-4. The external CA signs the certificate
-5. `acme-proxy` retrieves the certificate bundle and returns it to your server
-
-![sequence diagram](docs/sequence.png)
-
 ## Quick Start
 
 ```sh
@@ -118,7 +114,6 @@ The most important parts of the config are -
       "account_email": "",
       "eab_kid": "",
       "eab_hmac_key": "",
-      "certlifetime": 30,
       "metrics": {
         "enabled": true,
         "port": 9234,

docs/assets/highlevel-flow.png

@@ -0,0 +1,5 @@
++++
+title = 'Troubleshoot'
+weight = 20
+BookToC = true
++++

docs/content/examples.md

@@ -136,6 +136,8 @@ <h2 class="book-brand">
 
 
 
+    
+      
         <li>
 
 
@@ -165,8 +167,6 @@ <h2 class="book-brand">
 
 
 
-      
-    
   </ul>
 
 

docs/content/troubleshoot.md

@@ -22,12 +22,14 @@
 Table of Contents# Installing ACME Clients Account Registration Configuring Auto-Renewal via Systemd Log Management Installing ACME Clients# Certbot# Note: Certbot’s actively maintained distribution is via Snap. The .deb packages available in apt repositories are no longer maintained by the Certbot project and ship outdated versions.">
   <meta property="og:locale" content="en">
   <meta property="og:type" content="article">
+    <meta property="article:modified_time" content="2026-04-12T20:08:41-05:00">
 
 
   <meta itemprop="name" content="ACME Clients">
   <meta itemprop="description" content="ACME Clients# This guide covers installation and system-level configuration of ACME clients for use with acme-proxy. It is intended for system administrators deploying certificate automation on behalf of end users.
 For certificate issuance commands and per-scenario usage, see user.md.
 Table of Contents# Installing ACME Clients Account Registration Configuring Auto-Renewal via Systemd Log Management Installing ACME Clients# Certbot# Note: Certbot’s actively maintained distribution is via Snap. The .deb packages available in apt repositories are no longer maintained by the Certbot project and ship outdated versions.">
+  <meta itemprop="dateModified" content="2026-04-12T20:08:41-05:00">
   <meta itemprop="wordCount" content="843">
 
 <title>ACME Clients | ACME Proxy</title>
@@ -145,6 +147,8 @@ <h2 class="book-brand">
 
 
 
+    
+      
         <li>
 
 
@@ -174,8 +178,6 @@ <h2 class="book-brand">
 
 
 
-      
-    
   </ul>
 
 
@@ -478,6 +480,10 @@ <h2 id="log-management">Log Management<a class="anchor" href="#log-management">#
   <div class="flex flex-wrap justify-between">
 
 <div>
+<a class="flex align-center" href="https://github.com/esnet/acme-proxy/commit/bddb8b9e27907357bb040d99257d2cae683cb5bb" title='Last modified by Kapil Agrawal | April 12, 2026' target="_blank" rel="noopener">
+    <img src="/icons/calendar.svg" class="book-icon" alt="Calendar" />
+    <span>April 12, 2026</span>
+  </a>
 
 </div>
 

docs/public/categories/index.html

@@ -16,9 +16,11 @@
   <meta property="og:title" content="Port Requirements">
   <meta property="og:locale" content="en">
   <meta property="og:type" content="article">
+    <meta property="article:modified_time" content="2026-04-12T20:08:41-05:00">
 
 
   <meta itemprop="name" content="Port Requirements">
+  <meta itemprop="dateModified" content="2026-04-12T20:08:41-05:00">
 
 <title>Port Requirements | ACME Proxy</title>
 <link rel="icon" href="/favicon.png" >
@@ -135,6 +137,8 @@ <h2 class="book-brand">
 
 
 
+    
+      
         <li>
 
 
@@ -164,8 +168,6 @@ <h2 class="book-brand">
 
 
 
-      
-    
   </ul>
 
 
@@ -224,6 +226,10 @@ <h3>Port Requirements</h3>
   <div class="flex flex-wrap justify-between">
 
 <div>
+<a class="flex align-center" href="https://github.com/esnet/acme-proxy/commit/bddb8b9e27907357bb040d99257d2cae683cb5bb" title='Last modified by Kapil Agrawal | April 12, 2026' target="_blank" rel="noopener">
+    <img src="/icons/calendar.svg" class="book-icon" alt="Calendar" />
+    <span>April 12, 2026</span>
+  </a>
 
 </div>
 

docs/public/client/index.html

@@ -29,6 +29,7 @@
   <meta itemprop="description" content="What is ACME Proxy?# acme-proxy is a standalone ACME server built on step-ca that operates in registration authority (RA) mode. It accepts certificate orders and validates certificate requests using the ACME protocol (RFC 8555), but does NOT sign certificates or store private keys.
 It runs as a standalone server inside your enterprise environment, acting as an intermediary between your internal infrastructure and an external certificate authority service (such as Sectigo).
 Certificate Request Flow:">
+  <meta itemprop="dateModified" content="2026-04-12T20:08:41-05:00">
   <meta itemprop="wordCount" content="141">
 
 <title>ACME Proxy | ACME Proxy</title>
@@ -147,6 +148,8 @@ <h2 class="book-brand">
 
 
 
+    
+      
         <li>
 
 
@@ -176,8 +179,6 @@ <h2 class="book-brand">
 
 
 
-      
-    
   </ul>
 
 
@@ -266,6 +267,10 @@ <h3>ACME Proxy</h3>
   <div class="flex flex-wrap justify-between">
 
 <div>
+<a class="flex align-center" href="https://github.com/esnet/acme-proxy/commit/bddb8b9e27907357bb040d99257d2cae683cb5bb" title='Last modified by Kapil Agrawal | April 12, 2026' target="_blank" rel="noopener">
+    <img src="/icons/calendar.svg" class="book-icon" alt="Calendar" />
+    <span>April 12, 2026</span>
+  </a>
 
 </div>