zrok/CHANGELOG.md

147 lines
8.9 KiB
Markdown
Raw Normal View History

2023-03-06 21:58:53 +01:00
# v0.4.0
2023-05-01 18:20:52 +02:00
FEATURE: New `tcpTunnel` backend mode allowing for private sharing of local TCP sockets with other `zrok` users (https://github.com/openziti/zrok/issues/170)
2023-05-04 17:36:58 +02:00
FEATURE: New `udpTunnel` backend mode allowing for private sharing of local UDP sockets with other `zrok` users (https://github.com/openziti/zrok/issues/306)
2023-04-05 19:29:37 +02:00
FEATURE: New metrics infrastructure based on OpenZiti usage events (https://github.com/openziti/zrok/issues/128). See the [v0.4 Metrics Guide](docs/guides/metrics-and-limits/configuring-metrics.md) for more information.
FEATURE: New limits implementation based on the new metrics infrastructure (https://github.com/openziti/zrok/issues/235). See the [v0.4 Limits Guide](docs/guides/metrics-and-limits/configuring-limits.md) for more information.
FEATURE: The invite mechanism has been reworked to improve user experience. The configuration has been moved to the `admin` stanza of the controller configuration and now includes a boolean flag indicating whether or not the instance allows new invitations to be created, and also includes contact details for requesting a new invite. These values are used by the `zrok invite` command to provide a smoother end-user invite experience https://github.com/openziti/zrok/issues/229)
2023-04-05 19:29:37 +02:00
CHANGE: The controller configuration version bumps from `v: 2` to `v: 3` to support all of the new `v0.4` functionality. See the [example ctrl.yml](etc/ctrl.yml) for details on the new configuration.
2023-03-06 21:58:53 +01:00
2023-03-10 17:37:45 +01:00
CHANGE: The underlying database store now utilizes a `deleted` flag on all tables to implement "soft deletes". This was necessary for the new metrics infrastructure, where we need to account for metrics data that arrived after the lifetime of a share or environment; and also we're going to need this for limits, where we need to see historical information about activity in the past (https://github.com/openziti/zrok/issues/262)
2023-04-25 21:17:09 +02:00
# v0.3.7
FIX: Improved TUI word-wrapping (https://github.com/openziti/zrok/issues/180)
2023-04-17 18:52:21 +02:00
# v0.3.6
CHANGE: Additional change to support branch builds (for CI purposes) and additional containerization efforts around k8s.
2023-03-10 22:35:12 +01:00
# v0.3.5
CHANGE: `zrok config set apiEndpoint` now validates that the new API endpoint correctly starts with `http://` or `https://` (https://github.com/openziti/zrok/issues/258)
2023-03-22 18:10:15 +01:00
CHANGE: Additional linting to support homebrew (https://github.com/openziti/zrok/issues/264)
2023-03-06 22:07:55 +01:00
# v0.3.4
CHANGE: `zrok test endpoint` incorporates `--ziti` mode (and related flags) to allow direct endpoint listening on a Ziti service
CHANGE: `zrok test websocket` command to test websockets, whether over TCP or over Ziti
FIX: Websocket support now functional
2023-02-23 20:09:08 +01:00
# v0.3.3
CHANGE: `zrok test loop` has been moved to `zrok test loop public`, making way for additional types of loopback testing tools. The `zrok test endpoint` server now includes an `/echo` endpoint, which provides a simple echo websocket (https://github.com/openziti/zrok/issues/237)
2023-02-15 19:17:57 +01:00
# v0.3.2
2023-02-21 20:37:31 +01:00
FEATURE: New docker infrastructure, including `docker-compose.yml` examples (and documentation) illustrating how to deploy `zrok` in `docker`-based environments
2023-02-16 22:47:31 +01:00
CHANGE: Include missing `--headless` flag for `zrok enable` and `zrok access private` (https://github.com/openziti/zrok/issues/246)
2023-02-15 19:17:57 +01:00
CHANGE: Fix for `zrok enable` error path handling (https://github.com/openziti/zrok/issues/244)
2023-02-16 22:36:08 +01:00
FEATURE: `zrok controller validate` and `zrok access public validate` will both perform a quick syntax validation on controller and public frontend configuration documents (https://github.com/openziti/zrok/issues/238)
$ zrok controller validate etc/dev.yml
[ERROR]: controller config validation failed (error loading controller config 'etc/dev.yml': field 'maintenance': field 'registration': field 'expiration_timeout': got [bool], expected [time.Duration])
CHANGE: `zrok status` no longer shows secrets (secret token, ziti identity) unless the `--secrets` flag is passed (https://github.com/openziti/zrok/issues/243)
2023-02-08 16:58:02 +01:00
# v0.3.1
2023-02-09 20:49:24 +01:00
CHANGE: Incorporate initial docker image build (https://github.com/openziti/zrok/issues/217)
2023-02-09 20:50:27 +01:00
CHANGE: Improve target URL parsing for `zrok share` when using `--backend-mode` proxy (https://github.com/openziti/zrok/issues/211)
2023-02-09 20:52:45 +01:00
New and improved URL handling for proxy backends:
2023-05-01 18:20:52 +02:00
2023-02-09 20:52:45 +01:00
9090 -> http://127.0.0.1:9090
localhost:9090 -> http://127.0.0.1:9090
https://localhost:9090 -> https://localhost:9090
2023-02-08 16:58:02 +01:00
CHANGE: Improve usability of `zrok invite` TUI in low-color environments (https://github.com/openziti/zrok/issues/206)
CHANGE: Better error responses when `zrok invite` fails due to missing token (https://github.com/openziti/zrok/issues/207)
2023-02-06 19:50:56 +01:00
# v0.3.0
CHANGE: Removed some minor web console lint and warnings (https://github.com/openziti/zrok/issues/205)
2023-01-30 22:51:24 +01:00
# v0.3.0-rc6
2023-02-02 23:03:51 +01:00
CHANGE: Better error message when `zrok admin create frontend` runs into a duplicate name collision (https://github.com/openziti/zrok/issues/168)
2023-02-01 17:19:56 +01:00
CHANGE: Gentler CLI error messages by default (https://github.com/openziti/zrok/issues/203)
2023-02-01 16:09:20 +01:00
CHANGE: Add favicon to web console (https://github.com/openziti/zrok/issues/198)
2023-01-31 19:51:15 +01:00
CHANGE: Add configurable "terms of use" link in the controller configuration, and optionally display the link on the login form and registration forms (https://github.com/openziti/zrok/issues/184)
2023-01-30 22:51:24 +01:00
CHANGE: Prevent multiple `zrok enable` commands from succeeding (https://github.com/openziti/zrok/issues/190)
2023-01-30 23:39:32 +01:00
CHANGE: New `--insecure` flag for `share <public|private|reserved>` commands (https://github.com/openziti/zrok/issues/195)
2023-01-30 17:39:36 +01:00
# v0.3.0-rc5
CHANGE: Improvements to controller log messages to assist in operations (https://github.com/openziti/zrok/issues/186)
2023-01-30 19:04:35 +01:00
CHANGE: `armv7` builds for Linux are now shipped with releases; these builds were tested against a Raspberry Pi 4 (https://github.com/openziti/zrok/issues/93)
2023-01-30 19:59:02 +01:00
CHANGE: `zrok config set` now includes a warning when the `apiEndpoint` config is changed and an environment is already enabled; the user will not see the change until `zrok disable` is run. The CLI now includes a `zrok config unset` command (https://github.com/openziti/zrok/issues/188)
2023-01-26 17:52:14 +01:00
# v0.3.0-rc4
CHANGE: Enable notarization for macos binaries (https://github.com/openziti/zrok/issues/92)
# v0.3.0-rc3
2023-01-23 19:06:12 +01:00
> This release increments the configuration version from `1` to `2`. See the note below.
CHANGE: The email "from" configuration moved from `registration/email_from` to `email/from`. **NOTE: This change increments the configuration `V` from `1` to `2`.**
2023-01-23 19:11:23 +01:00
CHANGE: Replaced un-salted sha512 password hashing with salted hashing based on Argon2 **NOTE: This version will _invalidate_ all account passwords, and will require all users to use the 'Forgot Password?' function to reset their password.** (https://github.com/openziti/zrok/issues/156)
2023-01-23 19:06:12 +01:00
2023-01-24 17:40:15 +01:00
CHANGE: Switched from `ubuntu-latest` (`22.04`) for the Linux builds to `ubuntu-20.04`. Should improve `glibc` compatibility with older Linux distributions (https://github.com/openziti/zrok/issues/179)
2023-01-24 19:47:50 +01:00
CHANGE: `zrok admin generate` now outputs the generated tokens to `stdout` after successfully provisioning the tokens (https://github.com/openziti/zrok/issues/181)
2023-01-23 22:45:06 +01:00
FIX: Fixed log message in `resetPasswordRequest.go` (https://github.com/openziti/zrok/issues/175)
2023-01-24 18:01:01 +01:00
FIX: Fixed `-v` (verbose mode) on in TUI-based `zrok share` and `zrok access` (https://github.com/openziti/zrok/issues/174)
2023-01-20 19:23:47 +01:00
# v0.3.0-rc2
FEATURE: Allow users to reset their password (https://github.com/openziti/zrok/issues/65)
CHANGE: Improved email styling for new user invite emails (https://github.com/openziti/zrok/issues/157)
CHANGE: Migrated from `openziti-test-kitchen` to `openziti` (https://github.com/openziti/zrok/issues/158).
CHANGE: Show a hint when `zrok invite` fails, indicating that the user should check to see if they need to be using the `--token` flag and token-based invites (https://github.com/openziti/zrok/issues/172).
FIX: Fixed PostgreSQL migration issue where sequences got reset and resulted in primary key collisions on a couple of tables (https://github.com/openziti/zrok/issues/160).
FIX: Remove `frontend` instances when `zrok disable`-ing an environment containing them (https://github.com/openziti/zrok/issues/171)
2023-02-16 22:36:08 +01:00
# v0.3.x Series
2022-11-11 19:32:08 +01:00
2023-01-19 19:11:26 +01:00
The `v0.2` series was a _proof-of-concept_ implementation for the overall `zrok` architecture and the concept.
2022-11-21 20:05:37 +01:00
2023-01-19 19:11:26 +01:00
`v0.3` is a massive elaboration of the concept, pivoting it from being a simple ephemeral reverse proxy solution, to being the beginnings of a comprehensive sharing platform, complete with public and private sharing (built on top of OpenZiti).
2022-11-21 20:05:37 +01:00
2023-01-19 19:11:26 +01:00
`v0.3.0` includes the minimal functionality required to produce an early, preview version of the elaborated `zrok` concept, suitable for both production use at `zrok.io`, and also suitable for private self-hosting.
2022-11-21 20:05:37 +01:00
2023-01-19 19:11:26 +01:00
From `v0.3.0` forward, we will begin tracking notable changes in this document.
2022-11-14 19:58:42 +01:00
2022-11-11 19:23:51 +01:00
# v0.2.18
2022-11-02 20:23:35 +01:00
2022-11-28 17:22:06 +01:00
* DEFECT: Token generation has been improved to use an alphabet consisting of `[a-zA-Z0-9]`. Service token generation continues to use a case-insensitive alphabet consisting of `[a-z0-9]` to be DNS-safe.