diff --git a/BUILD.md b/BUILD.md index c74c0d68..181c5b7c 100644 --- a/BUILD.md +++ b/BUILD.md @@ -2,9 +2,10 @@ ## zrok -At this time, building `zrok` is pretty straightforward. You will require `node` v16+ to be installed in order to complete the build as well as `go`. Because `zrok` uses CGO, you will also need to have a working C compiler toolchain. [TDM-GCC](https://jmeubank.github.io/tdm-gcc/download/) works great on Windows (just make sure it's in your PATH). +At this time, building `zrok` is pretty straightforward. You will require `node` v18+ to be installed in order to complete the build as well as `go`. Because `zrok` uses CGO, you will also need to have a working C compiler toolchain. [TDM-GCC](https://jmeubank.github.io/tdm-gcc/download/) works great on Windows (just make sure it's in your PATH). To build, follow these steps: + * clone the repository * change to the existing `ui` folder * run `npm install` @@ -13,15 +14,20 @@ To build, follow these steps: * make sure the dist directory exists: `mkdir -p dist` * build the go project normally: `go build -o dist ./...` +## Cross-build zrok with Docker + +Build a `zrok` snapshot binary for amd64, arm64, armhf, or armel with [the `cross-build` container](./docker/images/cross-build/README.md). + ## Documentation/Website The doc website is based on [Docusaurus](https://docusaurus.io/) which in turn will require `npm` to be installed. `yarn` is another tool which is used to start the Docusaurus dev site. To build the doc: + * cd to `website` * run `yarn install` (usually only needed once) * run `yarn start` to start the development server (make sure port 3000 is open or change the port) The development server infrequently behaves differently than the 'production' build. If you must use the 'production' -build it is slower, but you can accomplish that with `yarn build`. \ No newline at end of file +build it is slower, but you can accomplish that with `yarn build`. diff --git a/CHANGELOG.md b/CHANGELOG.md index c1412bda..a8280ce3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,9 @@ FEATURE: New interstitial pages that can be enabled per-frontend, and disabled p CHANGE: Enable `"declaration": true` in `tsconfig.json` for Node SDK. -FIX: Statically link arm 32bit build for broader compatibility. +FIX: build 32bit build for armhf to fix [the FPE issue](https://github.com/openziti/zrok/issues/654) and [the missing link issue](https://github.com/openziti/zrok/issues/642) + +CHANGE: add [cross-build instructions](./BUILD.md) (includes new snapshot build target `armel`) ## v0.4.35