mirror of https://github.com/hanzozt/console.git synced 2026-10-30 18:15:39 +00:00

Files

T

zeekayandHanzo Dev a9e685c776 fix(license): restore upstream release history, credit OpenZiti in README

release-notes.md had been rewritten to attribute NetFoundry's development
history to Hanzo: 189 upstream issue links were repointed and every
"ziti"/"Ziti"/"ZAC" brand token swapped. The file documents releases Hanzo
did not make. Restored verbatim from upstream at the fork point.

Adds an Attribution section to README naming openziti/ziti-console.

Co-authored-by: Hanzo Dev <[email protected]>

2026-07-27 16:21:33 -07:00

5.2 KiB

Raw Permalink Blame History

Hanzo ZT is a free and open source project focused on bringing zero trust to any application.
The project provides all the pieces required to implement or integrate zero trust into your solutions.

@hanzozt/zt-console

This repo hosts the Ziti Admin Console, and is designed to provide a user interface to help you administrate an Hanzo ZT Network via the Ziti Edge API

Part of the Hanzo ZT ecosystem

Interested in knowing how to easily embed programmable, high performance, zero trust networking into your application without VPNs?
Learn more about Hanzo ZT project.
Also, checkout core project on github

Please star us!

Hanzo ZT Console

The Hanzo ZT Console is an administrative web interface for an Hanzo ZT network.

Deployments

Read the production deployment guides for the console as well as the controller, router, etc.

Link to deployment guides

Requirements

To build and run the application from source, you'll also need to make sure you have the following developer tools installed and available on your command line.

Tool	Version
Node.js	>=18
npm	>=8.1
ng	=16

Install Angular CLI

This provides the ng command.

npm install -g @angular/cli@16

Projects

This repository houses two projects.

zt-console-lib - Angular library used by the console UI.
app-zt-console - console UI with two deployment modes.
Single page application mode (recommended)
Node.js server mode (server.js, deprecated)

Build

From the project root:

Install both projects' dependencies and build the library.
```
npm install
```

Build the Single Page Application

Build the console project with Angular.
```
ng build zt-console
```
The single-page application assets are rendered in the ./dist/app-zt-console directory.
use the Node server to preview changes.

Build the Standalone Node Server

Do not use this in production: deployment guides. This is a deprecated build and run mode temporarily preserved here for previewing local changes during development.

Build the console project with Angular.
```
ng build zt-console-node
```
If developing the standalone Node server, run it.
```
node server.js
```
Access the console at http://localhost:1408
Configure the server with the URL of the controller's edge-management API, e.g. https://localhost:1280

Developing with Angular

There are two elements to the Angular app.

From the project directory:

Install dependencies and build the library.
```
npm install
```
Continually build the library in ./dist/zt-console-lib by running the npm script watch:lib.
```
ng build zt-console-lib --watch
```
Note: The NPM library is referenced/linked in package.json as "zt-console-lib": "file:dist/zt-console-lib". This library includes the javascript code shared with the console application and the Angular code shared with other applications.
Continually build the deprecated Node server in app-zt-console-node to preview changes.
```
ng build zt-console-node --watch
```

Attribution

Hanzo ZT Console is derived from the OpenZiti Admin Console (openziti/ziti-console), Copyright NetFoundry Inc., licensed under Apache-2.0. See NOTICE and LICENSE.

release-notes.md is upstream's release history and documents NetFoundry's development of the Ziti Admin Console, not Hanzo's.

5.2 KiB Raw Permalink Blame History