From 478caa939b542e7bb1def1e2b2a48880bb6faab8 Mon Sep 17 00:00:00 2001 From: Matthew Vivian Date: Mon, 25 Nov 2024 14:18:09 +0000 Subject: [PATCH] doc: Fix revocation.sh examples & clarify usage Clarify that revocation.sh must be run from federation/ directory. --- federation/README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/federation/README.md b/federation/README.md index 152f8c2..7848b46 100644 --- a/federation/README.md +++ b/federation/README.md @@ -186,12 +186,15 @@ openssl ocsp -url http://localhost:8888 \ ### Certificate Revocation -The `revocation.sh` script allows you to revoke SSL certificates and +The `./scripts/revocation.sh` script allows you to revoke SSL certificates and update the OCSP responder's database. You can also un-revoke certificates -that were previously revoked. +that were previously revoked. + +**Important:** Run this script from the root `federation/` directory, as it requires +direct access to the `_data` directory containing the certificates and PKI infrastructure. ```bash -./revocation.sh --server xmpp1 [--reason reason] [--unrevoke] +./scripts/revocation.sh --server xmpp1 [--reason reason] [--unrevoke] ``` Available revocation reasons: @@ -206,13 +209,13 @@ Available revocation reasons: Examples: ```bash # Revoke xmpp1's certificate -./revocation.sh --server xmpp1 +./scripts/revocation.sh --server xmpp1 # Revoke with specific reason -./revocation.sh --server xmpp1 --reason keyCompromise +./scripts/revocation.sh --server xmpp1 --reason keyCompromise # Remove revocation status -./revocation.sh --server xmpp1 --unrevoke +./scripts/revocation.sh --server xmpp1 --unrevoke ``` To verify the current status: