Skip to content

Commit 57f6d54

Browse files
committed
chore(repo): 🔧 standardize docs and license
1 parent a1a105c commit 57f6d54

3 files changed

Lines changed: 30 additions & 4 deletions

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Alessandro Digilio
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 🔐 Homelab mTLS Certificate Issuer
1+
# 🔐 mtls-cli
22

33
A simple toolkit to generate, package, and securely share long-lived **client certificates** for **mutual TLS (mTLS)** authentication — perfect for self-hosted services, homelabs, friends, family, or small teams.
44

@@ -21,7 +21,7 @@ Built on top of [Smallstep CA](https://smallstep.com/docs/step-ca) and optimized
2121
| `serve-certs.sh` | Serves one bundle via temporary HTTP + QR code |
2222
| `cert-recap.md` | Cheat sheet explaining `.crt`, `.p12`, `.key`, etc. |
2323
| `.gitignore` | Ignores secrets, output, and certs |
24-
| `README_NPM.md` | Extra guide to use mTLS with Nginx Proxy Manager (NPM) |
24+
| `docs/nginx-proxy-manager.md` | Extra guide to use mTLS with Nginx Proxy Manager (NPM) |
2525
| `roots.pem` *(generated)* | Cached copy of the root certificate (created on first run) |
2626
| `issued_passwords.csv` *(generated)* | Logs all issued certs and passwords (created by the script) |
2727

@@ -196,10 +196,15 @@ STEP_CA_PASSWORD=test-only docker compose config --quiet
196196
## 🧠 Extras
197197

198198
- `cert-recap.md` explains all the formats: `.crt`, `.key`, `.p12`, `.pem`, etc.
199-
- `README_NPM.md` contains Nginx Proxy Manager-specific setup for mTLS
199+
- [docs/nginx-proxy-manager.md](docs/nginx-proxy-manager.md) contains
200+
Nginx Proxy Manager-specific setup for mTLS
200201

201202
---
202203

203204
## 💬 Feedback
204205

205206
Got ideas or want to contribute? Open an issue or ping me!
207+
208+
## License
209+
210+
MIT. See [LICENSE](LICENSE).

README_NPM.md renamed to docs/nginx-proxy-manager.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 🔐 Using Client Certificates with Nginx Proxy Manager (NPM)
1+
# Using Client Certificates with Nginx Proxy Manager
22

33
This guide shows how to configure **Nginx Proxy Manager** (NPM) to use **mutual TLS (mTLS)** authentication with client certificates generated using the `issue-client-cert.sh` script.
44

0 commit comments

Comments
 (0)