studio/tuwunel
2
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Fix docs regarding optimized builds; replace haswell with v1/v2/v3 etc. (fixes #175)

Browse Source 
Signed-off-by: Jason Volk <jason@zemos.net>
This commit is contained in:
Jason Volk
2025-09-23 14:54:45 +00:00
parent 6dca02860c
commit 887a22dabd
1 changed files with 8 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/deploying/generic.md
View File

@@ -12,10 +12,10 @@
You may simply download the binary that fits your machine architecture (x86_64 You may simply download the binary that fits your machine architecture (x86_64
or aarch64). Run `uname -m` to see what you need. or aarch64). Run `uname -m` to see what you need.
Prebuilt fully static musl binaries can be downloaded from the latest tagged Prebuilt fully static binaries can be downloaded from the latest tagged
release [here](https://github.com/matrix-construct/tuwunel/releases/latest) or release [here](https://github.com/matrix-construct/tuwunel/releases/latest) or
`main` CI branch workflow artifact output. These also include Debian/Ubuntu `main` CI branch workflow artifact output. These also include `.deb` packages
packages. for Debian or Ubuntu and `.rpm` packages for Red Hat or Fedora.
These can be curl'd directly from. `ci-bins` are CI workflow binaries by commit These can be curl'd directly from. `ci-bins` are CI workflow binaries by commit
hash/revision, and `releases` are tagged releases. Sort by descending last hash/revision, and `releases` are tagged releases. Sort by descending last
@@ -24,12 +24,11 @@ modified for the latest.
These binaries have jemalloc and io_uring statically linked and included with These binaries have jemalloc and io_uring statically linked and included with
them, so no additional dynamic dependencies need to be installed. them, so no additional dynamic dependencies need to be installed.
For the **best** performance; if using an `x86_64` CPU made in the last ~15 years, For the **best** performance; if using an `x86_64` CPU made in the last ~10 years,
we recommend using the `-haswell-` optimised binaries. This sets we recommend using the `-v3-` optimised packages. If the server refuses to start
`-march=haswell` which is the most compatible and highest performance with or exits with an "Illegal Instruction" error you will need `-v2-` or `-v1-`
optimised binaries. The database backend, RocksDB, most benefits from this as it packages instead. The database backend, RocksDB, benefits from `-v2-` or greater
will then use hardware accelerated CRC32 hashing/checksumming which is critical as it features performance critical hardware accelerated CRC32 hashing/checksumming.
for performance.
### Compiling ### Compiling