0.1.0 ✔️

Build time: 2024-02-24T23:47:56+02:00
Commit Ref: 4a5df32

Summary

This release brings Sirveo into a stable release regime. Stable means that we will confidently recommend Sirveo for handling complex automation and integration workloads in production contexts, as we have done since 0.0.5-alpha.

Stable further means that Sirveo can reliably execute 2000 flows per second (via webhooks). And maintain sub-millisecond response times. And execute flows a million times under this kind of constant load, without running into any problems or errors. And with an impressive memory profile.

Developer’s note

After 5 months of design, development, iteration and testing, I’m sufficiently satisfied with a stable designation. So, 0.1.0 represents a stable Sirveo, and 1.0.0 will represent a feature-complete Sirveo, according to my initial vision of a versatile, general-purpose automation and integration platform, which is a breeze to operate and a joy to use.

Based on the initial roadmap, 75% of features and capabilities are implemented. I anticipate that feature-complete Sirveo is about 12 releases away, as the remaining %25 of the roadmap is gradually completed.

Licensing

This release introduces licensing requirements. See the license reference for details.

Breaking Changes

• 🔓⚙️❗ Binaries without a valid license runs in restricted mode
• 🔼⚙️❗ The server API’s JWT expiry time default changed from 72h to 4h
• 🔼⚙️❗ JWT_SIGNING_SECRET now requires a hex-encoded value representing at least 32 bytes

Before upgrading

1. If you have not already been issued a license for your deployments, reach out to [email protected]

2. If prior behaviour is desirable, configure SIRVEO_JWT_EXPIRY with a value of 72h

3. If your configured JWT_SIGNING_SECRET on your deployments, the existing value will probably become invalid after the 0.1.0 upgrade. You can generate an appropriate new value for the setting with OpenSSL:

openssl rand -hex 64

Fixes

• 🐞 ui: fix that server variables with long values could mess with the page layout

Features

• ⚡🔓 ui: license details are visible in the UI under server details
• ⚡🔓 ui: in restricted mode, a notice appears in the header, dashboard and server details

API Authentication

• 🔼⚙️ If not specified, the randomly-generated JWT_SIGNING_SECRET is now 64 bytes in length
• 🔼⚙️ JWT’s generated by API authentication now include iat and nbf claims
• ⚡⚙️ Expiry time of server API JWTs is now configurable

Other features

• ⚡⚙️ for inbound HTTP requests, the header identifying the remote IP is configurable
• ⚡⚙️ Server authentication JWT expiry time is configurable
• ⚡⚙️ customizable telemetry; see the telemetry reference

Enhancements

• ⚡😀 ui: add copy button for non-secret server variables

Server API changes

• 🔼⚙️ api: /api/server/info includes online license validation details

Configuration

New settings are documented in the configuration reference.

• ⚙️ new configuration option: SIRVEO_LICENSE
• ⚙️ new configuration option: SIRVEO_JWT_EXPIRY
• ⚙️ new configuration option: SIRVEO_IP_HEADER_ADMIN
• ⚙️ new configuration option: SIRVEO_IP_HEADER_INBOUND
• ⚙️ new configuration option: SIRVEO_TELEMETRY_MODE
• ⚙️ new configuration option: SIRVEO_TELEMETRY_ID
• ⚙️ new configuration option: SIRVEO_TELEMETRY_URL
• ⚙️ new configuration option: SIRVEO_TELEMETRY_AUTH
• ⚙️ new configuration option: SIRVEO_TELEMETRY_FREQUENCY

Server internals

• ⚙️ server: re-generate instance ID if its not valid at startup