Skip to content

Commit

Permalink
Merge pull request #710 from openziti/debug-builder
Browse files Browse the repository at this point in the history
announce armhf, armel build fixes
  • Loading branch information
qrkourier authored Jul 25, 2024
2 parents 1927c64 + bb0cb56 commit ab4132c
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
10 changes: 8 additions & 2 deletions BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand All @@ -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`.
build it is slower, but you can accomplish that with `yarn build`.
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit ab4132c

Please sign in to comment.