Files
ziti/quickstart
dovholuknf caee6124e2 add support for and identity-driven bindPoints in controller (#3315)
* add support for and identity-driven bindPoints in controller

* cannot use ListenOptions as it pulls the go sdk into xweb :(

* more generic log message

* add ziti cli login tests in prep for continuing adding identity support in controller

* updates to tests

* updates to tests

* rebase with main

* allow login testing to external overlay

* more changes to allow a zitified ziti cli. add a test for testing login and ensure it works over a zitified connection

* refactor bindPoints to a module

* rebase with main

* no functional changes, just major refactoring based on PR requests. encapsulated all tests state into loginTestState, moved overlay to testutil

* rework a couple of util funcs to be cleaner per PR feedback

* make the new func more useful

* run tests via github action

* update changelog and remove unnecssary serveTls for now

* update from xweb v2 to v3

* change where factory is added and fix compilation issue of a test

* linting changes, move ascode test to cli_tests and activate via cli_tests

* use proper go build

* forgot to set the bin location

* fix timeout on test

* different errors on linux, windows and on gh runners

* cleanup after self-pr review

* use longer name to prevent codespell issues...

* additional changelog and add addressable terminator support

* fix out of control concatenation in cache file. fix ipv6 checking

* updates based on newer sdk and edge api client

* ensure oidc sessions auth for both older and newer commands

* add better error when url is empty and update changelog

* codespell fixes

* remove extraneous file

* update to 1.3.0 to kick off CI

* PR related changes. add interface enforcer and refactor networkIdentity

* go tidied

* fix golangci-lint and ha quickstart test

* keep fixing golanglint-ci... lol

* golanglint i was sure i'd fixed

* fix login test

* should fix ziti ops verify traffic as well

* fix verify traffic when all login information is supplied as well

* make all the timeouts longer? seems to run fine locally but fail in actions
2025-11-14 11:07:52 -05:00
..
2025-03-26 11:25:28 -04:00

Quickstart

The Ziti quickstart documentation is here: Ziti Network Quickstarts.

Releasing a new version of the Quickstart

Artifacts Produced by a Release

The enclosing project's GitHub releases are never updated and no Git tags are created for a quickstart release.

  1. openziti/quickstart container image in Docker Hub
  2. a CloudFront Function in AWS pointing the get.openziti.io reverse proxy to the GitHub SHA of the release

Release Process

A quickstart release is created when either of the following conditions are met:

  1. OpenZiti, the enclosing project, is released by the OpenZiti team
  2. A pull request is merged into the trunk branch main with the label quickstartrelease

Release Machinery

The release process is encoded in a GitHub workflow.

GitHub Raw Reverse Proxy

The get.openziti.io reverse proxy is a CloudFront distribution that points to a CloudFront Function and serves as a shorter HTTP URL getter for raw GitHub source files, e.g. https://get.openziti.io/dock/simplified-docker-compose.yml. The CloudFront Function is a JavaScript function that looks at the URI path of the incoming request and forwards it to the appropriate GitHub raw download path. The CloudFront Function is updated by the release process, and the CloudFront Distribution itself is hand-maintained in the AWS Console. The Distribution has these characteristics:

  • Viewer Domain Name: get.openziti.io (frontend)
  • Route Origin: raw.githubusercontent.com (backend, upstream)
  • Auto-renewing TLS certificate from ACM
  • Cache Policy CachingOptimized (default)
  • Routes to Origin based on Javascript Function deployed by quickstart release

You can add or change a GitHub raw shortcut route by modifying the routes.yml file.