diff --git a/README.md b/README.md index 15ab66d0..bde29c72 100644 --- a/README.md +++ b/README.md @@ -123,6 +123,11 @@ By default the certificate, key and root will be owned by root and world-readabl Use the `autocert.step.sm/owner` and `autocert.step.sm/mode` annotations to set the owner and permissions of the files. The owner annotation requires user and group IDs rather than names because the images used by the containers that create and renew the certificates do not have the same user list as the main application containers. +To run a custom script at certificate renewal time, add an +`autocert.step.sm/renewalVolume` annotation, with the value the name of a volume +to mount in the renewal container. The volume should contain an executable +called `renew.sh`, which will be run by `step ca renew --exec`. + Let's deploy a [simple mTLS server](examples/hello-mtls/go/server/server.go) named `hello-mtls.default.svc.cluster.local`: @@ -161,7 +166,8 @@ root.crt site.crt site.key We're done. Our container has a certificate, issued by our CA, which `autocert` will automatically renew. -Now let's deploy another server with a `autocert.step.sm/duration`, `autocert.step.sm/owner` and `autocert.step.sm/mode`: +Now let's deploy another server with a `autocert.step.sm/duration`, `autocert.step.sm/owner`, +`autocert.step.sm/mode` and `autocert.step.sm/renewalVolume`: ```yaml cat <