extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2024-11-21 23:53:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

announce armhf, armel build fixes

Browse Source
This commit is contained in:
Kenneth Bingham 2024-07-25 14:59:06 -04:00
parent 353d4b250f
commit e4aef7c43b
No known key found for this signature in database
GPG Key ID: 31709281860130B6
2 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
BUILD.md
View File

@ -2,9 +2,10 @@
## zrok ## 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: To build, follow these steps:
* clone the repository * clone the repository
* change to the existing `ui` folder * change to the existing `ui` folder
* run `npm install` * run `npm install`
@ -13,12 +14,17 @@ To build, follow these steps:
* make sure the dist directory exists: `mkdir -p dist` * make sure the dist directory exists: `mkdir -p dist`
* build the go project normally: `go build -o 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 ## Documentation/Website
The doc website is based on [Docusaurus](https://docusaurus.io/) which in turn will require `npm` to be installed. `yarn` 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. is another tool which is used to start the Docusaurus dev site.
To build the doc: To build the doc:
* cd to `website` * cd to `website`
* run `yarn install` (usually only needed once) * 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) * run `yarn start` to start the development server (make sure port 3000 is open or change the port)

2
CHANGELOG.md
View File

@ -6,7 +6,7 @@ FEATURE: New interstitial pages that can be enabled per-frontend, and disabled p
CHANGE: Enable `"declaration": true` in `tsconfig.json` for Node SDK. 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); add [cross-build instructions](./BUILD.md) (add new snapshot build target `armel`)
## v0.4.35 ## v0.4.35