Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions content/docs/ci-cd.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Installs git-pkgs and initializes the database. The other actions expect this to
```yaml
- uses: git-pkgs/actions/setup@v1
with:
version: "0.1.9" # optional, defaults to latest
version: "0.19.0" # optional, defaults to latest
```

### Dependency diff
Expand Down Expand Up @@ -74,7 +74,7 @@ jobs:
check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v7
with:
fetch-depth: 0

Expand All @@ -100,7 +100,8 @@ If you need more control or use a different CI system, you can install git-pkgs
```yaml
- name: Install git-pkgs
run: |
curl -sfL https://github.com/git-pkgs/git-pkgs/releases/latest/download/git-pkgs_0.1.9_linux_amd64.tar.gz \
v=$(curl -sfL https://api.github.com/repos/git-pkgs/git-pkgs/releases/latest | jq -r .tag_name | sed 's/^v//')
curl -sfL "https://github.com/git-pkgs/git-pkgs/releases/download/v${v}/git-pkgs_${v}_linux_amd64.tar.gz" \
| tar xz -C /usr/local/bin git-pkgs

- name: Initialize database
Expand Down Expand Up @@ -132,7 +133,8 @@ If you maintain [notes](/docs/notes) with a `policy` namespace marking packages
dependency-diff:
stage: test
script:
- curl -sfL https://github.com/git-pkgs/git-pkgs/releases/latest/download/git-pkgs_0.1.9_linux_amd64.tar.gz
- v=$(curl -sfL https://api.github.com/repos/git-pkgs/git-pkgs/releases/latest | jq -r .tag_name | sed 's/^v//')
- curl -sfL "https://github.com/git-pkgs/git-pkgs/releases/download/v${v}/git-pkgs_${v}_linux_amd64.tar.gz"
| tar xz -C /usr/local/bin git-pkgs
- git-pkgs init
- git-pkgs diff origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME..HEAD
Expand Down
11 changes: 5 additions & 6 deletions content/docs/licenses.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,14 @@ jobs:
licenses:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v7
with:
fetch-depth: 0

- name: Install git-pkgs
run: |
curl -sL https://github.com/git-pkgs/git-pkgs/releases/latest/download/git-pkgs-linux-amd64 -o git-pkgs
chmod +x git-pkgs
- uses: git-pkgs/actions/setup@v1

- name: Check licenses
run: ./git-pkgs licenses --allow=MIT,Apache-2.0,BSD-2-Clause,BSD-3-Clause,ISC
run: git-pkgs licenses --allow=MIT,Apache-2.0,BSD-2-Clause,BSD-3-Clause,ISC
```

## Options
Expand Down
2 changes: 1 addition & 1 deletion content/docs/modules/forge.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ go get github.com/git-pkgs/forge
```

```bash
brew install git-pkgs/git-pkgs/forge
brew install git-pkgs-forge
# or
go install github.com/git-pkgs/forge/cmd/forge@latest
```
Expand Down
2 changes: 1 addition & 1 deletion content/docs/modules/manifests.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ for _, dep := range result.Dependencies {

## Supported ecosystems

alpine, arch, asdf, bazel, bower, brew, cargo, carthage, clojars, cocoapods, composer, conan, conda, cpan, cran, crystal, deno, docker, dub, elm, gem, git, github-actions, golang, guix, hackage, haxelib, hex, julia, lean, luarocks, maven, nimble, nix, npm, nuget, pre-commit, pub, pypi, rpm, swift, vcpkg.
alpine, arch, asdf, bazel, bower, brew, cargo, carthage, chef, clojars, cocoapods, composer, conan, conda, cpan, cran, crystal, deno, docker, dub, elm, gem, git, github-actions, golang, guix, hackage, haxelib, helm, hex, ips, julia, lean, luarocks, maven, nimble, nix, npm, nuget, opam, pre-commit, pub, pypi, rpm, swift, vagrant, vcpkg.

## Types

Expand Down
11 changes: 5 additions & 6 deletions content/docs/sbom.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,14 @@ jobs:
sbom:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v7
with:
fetch-depth: 0

- name: Install git-pkgs
run: |
curl -sL https://github.com/git-pkgs/git-pkgs/releases/latest/download/git-pkgs-linux-amd64 -o git-pkgs
chmod +x git-pkgs
- uses: git-pkgs/actions/setup@v1

- name: Generate SBOM
run: ./git-pkgs sbom --name=${{ github.repository }} > sbom.json
run: git-pkgs sbom --name=${{ github.repository }} > sbom.json

- name: Upload to release
uses: softprops/action-gh-release@v1
Expand Down
2 changes: 1 addition & 1 deletion content/docs/tools/brief.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ r, _ := detect.New(knowledgeBase, "/path/to/project").Run()
## Installation

```bash
brew install git-pkgs/git-pkgs/brief
brew install git-pkgs-brief
# or
go install github.com/git-pkgs/brief/cmd/brief@latest
```
Expand Down
4 changes: 3 additions & 1 deletion content/docs/tools/pin.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,9 @@ The `assets` sub-package is the runtime helper a Go web app uses to consume the
## Installation

```bash
brew install git-pkgs/git-pkgs/pin
brew tap git-pkgs/git-pkgs
brew trust --tap git-pkgs/git-pkgs
brew install pin
# or
go install github.com/git-pkgs/pin/cmd/pin@latest
```
Expand Down
32 changes: 27 additions & 5 deletions content/docs/tools/proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: proxy
A caching proxy for package registries. Speeds up installs by caching artifacts locally, and can hide newly published versions until they've aged past a configurable cooldown so automated pipelines aren't first in line for a malicious release.

```bash
brew install git-pkgs/git-pkgs/proxy
brew install git-pkgs-proxy
proxy -listen :8080
```

Expand All @@ -24,22 +24,44 @@ cooldown:

When enabled the proxy strips versions from metadata responses until they've aged past the threshold. Resolution order is package PURL, then ecosystem, then global default. The implementation is the [cooldown](../modules/cooldown/) module.

## Artifact scanning

Cooldown gates on age; scanning gates on content. When enabled, each artifact is staged, handed to one or more external scanners over a small HTTP contract, and only committed to the cache if none of the `block`-mode scanners reject it.

```yaml
scanning:
enabled: true
scanners:
- name: clamav
url: http://clamav-adapter:8080/scan
mode: block
- name: trivy
url: http://trivy-adapter:8081/scan
mode: monitor
```

Scanners receive package metadata and a short-lived signed URL, then pull the bytes themselves; the proxy never uploads artifact content to a scanner.

## Supported registries

npm, Cargo, RubyGems, Go modules, Hex, pub.dev, PyPI, Maven, Gradle build cache, NuGet, Composer, Conan, Conda, CRAN, Julia, OCI/Docker, Debian/APT, RPM. Cooldown is available wherever the upstream metadata exposes publish timestamps.
npm, Cargo, RubyGems, Go modules, Hex, pub.dev, PyPI, Maven, Gradle build cache, NuGet, Composer, Conan, Conda, CRAN, Julia, Swift, Helm, Homebrew, OCI/Docker, Alpine APK, Debian/APT, RPM, and a generic HTTP-download endpoint for GitHub release assets and tools like mise or aqua. Cooldown is available wherever the upstream metadata exposes publish timestamps. OCI upstreams can use static credentials or ECR's 12-hour tokens with automatic refresh.

## What else it does

The root URL serves a dashboard with cache stats, a package browser, archive source viewer, and version diff. `proxy mirror` pre-populates the cache from PURLs or an SBOM. `/metrics` exposes Prometheus counters. `/api/package`, `/api/vulns`, `/api/outdated`, and `/api/bulk` provide a JSON enrichment API over the same data git-pkgs uses.
The root URL serves a dashboard with cache stats, a package browser, archive source viewer, and version diff. `proxy mirror` pre-populates the cache from PURLs or an SBOM. `/metrics` exposes Prometheus counters and `/health` reports upstream circuit-breaker state. `/api/package`, `/api/vulns`, `/api/outdated`, and `/api/bulk` provide a JSON enrichment API over the same data git-pkgs uses. `access_log.path` writes one JSONL line per request.

Storage is local filesystem by default, S3 or any S3-compatible service via `storage.url`. Metadata lives in SQLite by default or Postgres for multi-node setups.
Storage is local filesystem by default; `storage.url` accepts `s3://` (or any S3-compatible endpoint), `gs://`, or `azblob://`. Metadata lives in SQLite by default or Postgres for multi-node setups.

## Installation

```bash
brew install git-pkgs/git-pkgs/proxy
brew install git-pkgs-proxy
# or
go install github.com/git-pkgs/proxy/cmd/proxy@latest
# or
docker run -p 8080:8080 ghcr.io/git-pkgs/proxy:latest
# or
helm install proxy oci://ghcr.io/git-pkgs/charts/proxy
```

[View on GitHub](https://github.com/git-pkgs/proxy)
2 changes: 2 additions & 0 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@ module github.com/git-pkgs/website
go 1.26

toolchain go1.26.7

require github.com/imfing/hextra v0.12.3 // indirect
2 changes: 2 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
github.com/imfing/hextra v0.12.3 h1:DZHY2rUWYteyzjlHi9r4n7Bb5e2Q+6LXe4C1Dqn0ZjM=
github.com/imfing/hextra v0.12.3/go.mod h1:vi+yhpq8YPp/aghvJlNKVnJKcPJ/VyAEcfC1BSV9ARo=