Update offline-binary.md

This commit is contained in:
David Dworken 2024-12-31 09:47:26 -08:00 committed by GitHub
parent f79e4fce09
commit 173a424c07
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -2,7 +2,7 @@
hiSHtory supports disabling syncing at install-time via `curl https://hishtory.dev/install.py | python3 - --offline` or at config-time via `hishtory syncing disable`. This will disable persisting your (encrypted) history on the backend API server. For most users, this is the recommended option for running hiSHtory in an offline environment since it still supports opt-in updates via `hishtory update`. hiSHtory supports disabling syncing at install-time via `curl https://hishtory.dev/install.py | python3 - --offline` or at config-time via `hishtory syncing disable`. This will disable persisting your (encrypted) history on the backend API server. For most users, this is the recommended option for running hiSHtory in an offline environment since it still supports opt-in updates via `hishtory update`.
But, if you need stronger guarantees that hiSHtory will not make any network requests, this can also be done by compiling your own copy of hiSHtory with the `offline` tag. This will statically link in `net_disabled.go` which will guarantee that the binary cannot make any HTTP requests. To use this: But, if you need stronger guarantees that hiSHtory will not make any network requests, this can also be done by compiling your own copy of hiSHtory with the `offline` tag. This will statically link in [`net_disabled.go`](https://github.com/ddworken/hishtory/blob/master/client/lib/net_disabled.go) which will guarantee that the binary cannot make any HTTP requests. To use this:
``` ```
git clone https://github.com/ddworken/hishtory git clone https://github.com/ddworken/hishtory
@ -11,4 +11,4 @@ go build -tags offline
./hishtory install ./hishtory install
``` ```
This binary will be entirely offline and is guaranteed to never make any requests to `api.hishtory.dev`. This binary will be entirely offline and is guaranteed to never make any requests to `api.hishtory.dev`.