You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-18Lines changed: 4 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -116,24 +116,10 @@ The smoke tests (`make smoke`) automatically verify that signed `GET`/`HEAD` req
116
116
117
117
To allow users to download files, your backend application must generate an **edge signed URL**. These use a standard HMAC signature. Since the gateway verifies the signature before generating a ticket, bogus requests are dropped at the edge—saving your private network from dealing with malicious traffic.
118
118
119
-
We provide drop-in packages for Go, TypeScript, and Python under the `packages/` directory. The TypeScript package is published to GitHub Packages as the public package `@terion-name/air3-edgesign`. Configure npm for the GitHub Packages scope before installing:
119
+
We provide drop-in packages for Go, TypeScript, and Python under the `packages/` directory. The TypeScript package is published to the public npm registry as `@terion/air3-edgesign`:
120
120
121
121
```sh
122
-
# One-time user config; alternatively put this line in your project .npmrc.
123
-
npm config set @terion-name:registry https://npm.pkg.github.com
124
-
125
-
# GitHub's npm registry may require auth for install/metadata access even
126
-
# when package visibility is public. Use a classic PAT with read:packages.
For CI, set `NODE_AUTH_TOKEN` (for example from `${GITHUB_TOKEN}` in GitHub Actions, or another token with package read access) and add a project `.npmrc` like:
@@ -203,7 +189,7 @@ go test ./... -race # run race-enabled Go tests
203
189
204
190
## Releases & Docker Images
205
191
206
-
We publish multi-architecture Docker images (Linux on `amd64` and `arm64`) to the GitHub Container Registry on every release. Cross-compiled binaries for macOS, Windows, and Linux are also attached to GitHub releases. The same tag workflow publishes the public npm package `@terion-name/air3-edgesign` to GitHub Packages with the tag as the npm version. GitHub's npm registry can require a token for install and metadata requests even when a package is public; use the `@terion-name` registry and authentication setup shown above before running `npm install @terion-name/air3-edgesign`.
192
+
We publish multi-architecture Docker images (Linux on `amd64` and `arm64`) to the GitHub Container Registry on every release. Cross-compiled binaries for macOS, Windows, and Linux are also attached to GitHub releases. The same tag workflow publishes the public npm package `@terion/air3-edgesign` to npmjs with the tag as the npm version. Publishing uses npm Trusted Publishing from `.github/workflows/release.yml`, so the GitHub Actions job authenticates to npm through OIDC instead of an npm token.
TypeScript helpers for signing and verifying air3 edge gateway URLs.
4
4
5
-
This package is published publicly to GitHub Packages as `@terion-name/air3-edgesign`. Configure npm for the `@terion-name` scope, authenticate if GitHub's npm registry requires it, then install:
5
+
This package is published publicly to npmjs as `@terion/air3-edgesign`:
6
6
7
7
```sh
8
-
# One-time user config; alternatively put this line in your project .npmrc.
9
-
npm config set @terion-name:registry https://npm.pkg.github.com
10
-
11
-
# Use a classic PAT with read:packages when prompted.
For CI, set `NODE_AUTH_TOKEN` (for example from `${GITHUB_TOKEN}` in GitHub Actions, or another token with package read access) and add a project `.npmrc` like:
This package is published to GitHub Packages by the tag release workflow. The published runtime entry point is built JavaScript in `dist/` with TypeScript declarations.
15
+
This package is published by the tag release workflow using npm Trusted Publishing from `.github/workflows/release.yml`. The GitHub Actions job authenticates to npm through OIDC instead of an npm token. The published runtime entry point is built JavaScript in `dist/` with TypeScript declarations.
0 commit comments