extern/hishtory
1
0
Fork 0
mirror of https://github.com/ddworken/hishtory.git synced 2025-08-18 02:40:33 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add support for fully offline binary via compile-time 'offline' tag (#272)

Browse Source 
* Add support for fully offline binary via compile-time 'offline' tag

* Update docs
This commit is contained in:
David Dworken
2024-12-31 12:42:41 -05:00
committed by GitHub
parent ffc224e3d3
commit f79e4fce09
11 changed files with 118 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/offline-binary.md Normal file
View File

@@ -0,0 +1,14 @@
# Offline Binary
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:
```
git clone https://github.com/ddworken/hishtory
cd hishtory
go build -tags offline
./hishtory install
```
This binary will be entirely offline and is guaranteed to never make any requests to `api.hishtory.dev`.