You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit c195e29
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+39-14Lines changed: 39 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,23 +16,15 @@ It can automatically deploy certificates and reload supported services:
16
16
17
17
It is officially supported on Debian-based distributions (Debian, Ubuntu, Raspberry Pi OS, Armbian). Other Linux distributions may work but are not officially supported.
The installer downloads and verifies the latest `local-https`, then installs it to `/usr/local/sbin/local-https`.
26
26
27
-
-`/usr/local/sbin/local-https`
28
-
29
-
Then it runs the setup flow (`local-https --install`) and offers auto-renew (systemd timer recommended).
30
-
31
-
During the interactive install you are asked for a **domain name** to add to the certificate (default `pi.hole`). Pick whatever your network uses (e.g. `home.lan`, `dns.home`). To set it non-interactively, pass it as an environment variable:
On a new installation, or if the initial setup was never completed, it asks whether you want to start the setup. If `local-https` is already configured, running the same command only updates the program and keeps your existing certificates and configuration.
|`local-https --version`| Prints the installed `local-https` version |
52
+
|`local-https --version` / `--v` / `-V`| Prints the installed `local-https` version |
53
+
|`sudo local-https --update`| Checks GitHub for a newer version and asks before updating |
54
+
|`sudo local-https --update --yes`| Updates without asking for confirmation |
60
55
|`sudo local-https --install`| Full setup (Root CA, server cert, PEM/PFX, permissions, auto-renew, optional Pi-hole deploy, Technitium TLS if detected) |
61
56
|`sudo local-https --renew`| Renew if needed (near expiry window). If nothing to do, exits fast |
62
57
|`sudo local-https --renew --force-renew`| Forces a new server certificate + rebuilds PFX + restarts detected services |
63
-
|`sudo local-https --status`| Shows current status and last run info |
58
+
|`sudo local-https --status`| Shows the installed version, current status, and last run info |
64
59
|`sudo local-https --check`| Exit code indicates if renewal is needed |
65
60
|`sudo local-https --configure`| Re-run deploy steps for Pi-hole / Technitium without reinstalling everything |
66
61
|`sudo local-https --print-ca`| Prints `rootCA.crt` (useful to copy to devices) |
67
62
|`sudo local-https --print-pfx-pass`| Prints the PFX password (stored in a root-only file) |
Once installed, you can check for a newer version without using the full `curl` command again:
69
+
70
+
```bash
71
+
sudo local-https --update
72
+
```
73
+
74
+
If a newer version is available, `local-https` shows the current and latest versions and asks before installing it. The update only replaces the program itself; your existing Root CA, certificates, state, and service configuration are kept.
75
+
76
+
For non-interactive updates:
77
+
78
+
```bash
79
+
sudo local-https --update --yes
80
+
```
81
+
82
+
-----
83
+
84
+
## ⚙️ Reconfigure services
85
+
86
+
Use `--configure` when you want to re-detect and reapply supported service integrations without reinstalling `local-https`.
87
+
88
+
```bash
89
+
sudo local-https --configure
90
+
```
91
+
92
+
This re-checks Pi-hole and Technitium, reapplies certificate permissions and TLS deployment, and keeps your existing Root CA and installation.
93
+
94
+
This is useful after installing or changing Pi-hole or Technitium, or when you want to run the integration setup again.
- If Technitium is detected, the script can configure Technitium Web UI TLS to use:
139
164
-`server.pfx` + the stored password
140
165
- Supports both legacy Technitium Linux installations running as root and newer non-root installations.
141
-
-For non-root installations, the Technitium service user is automatically granted access to the `certs` group when required.
166
+
-If the Technitium `dns-server` account exists, it is automatically granted access to the `certs` group. Custom non-root Technitium service users are supported as well.
142
167
- If the Technitium systemd service restricts filesystem access, `local-https` automatically creates a systemd drop-in granting read-only access to `server.pfx`.
143
168
- On renew (when a new cert is created), it restarts the Technitium service so the new cert is loaded.
0 commit comments