Skip to content

Commit de984eb

Browse files
alexei-ledMarvin
andcommitted
docs: update README — GHCR only, deprecate Docker Hub
Docker Hub has introduced rate limits, image retention limits, and removed free Team organizations. Moved exclusively to GHCR. Also updated CI/CD section to reflect current workflows. Co-authored-by: Marvin <[email protected]>
1 parent 2580e21 commit de984eb

1 file changed

Lines changed: 17 additions & 16 deletions

File tree

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,29 @@
11
# nsenter
22

33
[![CI](https://github.com/alexei-led/nsenter/actions/workflows/ci.yaml/badge.svg)](https://github.com/alexei-led/nsenter/actions/workflows/ci.yaml)
4-
[![Release](https://github.com/alexei-led/nsenter/actions/workflows/release.yaml/badge.svg)](https://github.com/alexei-led/nsenter/actions/workflows/release.yaml)
5-
![Docker Pulls](https://img.shields.io/docker/pulls/alexeiled/nsenter.svg?style=popout)
4+
[![Build and Release](https://github.com/alexei-led/nsenter/actions/workflows/build-release.yaml/badge.svg)](https://github.com/alexei-led/nsenter/actions/workflows/build-release.yaml)
65

76
## Overview
87

98
Minimal `scratch`-based Docker image (~400KB) containing a single statically linked `nsenter` binary, built from [util-linux](https://github.com/util-linux/util-linux) sources.
109

11-
Automatically updated weekly when new util-linux versions are released.
10+
## Docker Image
1211

13-
## Docker Images
12+
```bash
13+
docker pull ghcr.io/alexei-led/nsenter
14+
```
1415

15-
| Registry | Image | Pull Command |
16-
|----------|-------|-------------|
17-
| **GHCR** (default) | `ghcr.io/alexei-led/nsenter` | `docker pull ghcr.io/alexei-led/nsenter` |
18-
| DockerHub | `alexeiled/nsenter` | `docker pull alexeiled/nsenter` |
16+
Multi-arch: `linux/amd64` and `linux/arm64` (built natively, no QEMU emulation).
1917

20-
Both registries provide multi-arch images for `linux/amd64` and `linux/arm64`.
18+
> **Note:** Docker Hub images (`alexeiled/nsenter`) are deprecated and no longer updated.
19+
> Docker Hub has introduced increasingly restrictive policies for open-source projects —
20+
> including rate limits, image retention limits for free accounts, and removal of
21+
> free Team organizations. We've moved exclusively to GitHub Container Registry (GHCR),
22+
> which offers unlimited pulls for public packages with no retention restrictions.
2123
2224
## Usage
2325

24-
Read the official `nsenter` [documentation](http://man7.org/linux/man-pages/man1/nsenter.1.html).
26+
Read the official `nsenter` [man page](http://man7.org/linux/man-pages/man1/nsenter.1.html).
2527

2628
### Enter a Docker container's namespaces
2729

@@ -62,19 +64,18 @@ The script creates a temporary pod with `hostPID`, `hostNetwork`, and toleration
6264
## Building
6365

6466
```sh
65-
# Build with a specific util-linux version
6667
docker build --build-arg UTIL_LINUX_VER=2.41.3 -t nsenter .
6768
```
6869

6970
## CI/CD
7071

7172
| Workflow | Trigger | What it does |
7273
|----------|---------|-------------|
73-
| `ci.yaml` | Push / PR | Hadolint + ShellCheck + build + integration tests |
74-
| `release.yaml` | Tag push | Multi-arch build → GHCR + DockerHub + GitHub Release |
75-
| `cron.yaml` | Weekly (Monday) | Check for new util-linux → auto-tag → triggers release |
74+
| **CI** | Push / PR | Hadolint + ShellCheck + build + integration tests |
75+
| **Build and Release** | Tag push | Native multi-arch build → GHCR + GitHub Release |
7676

77-
## License
77+
Releases are triggered by pushing a version tag (e.g., `2.41.3`) matching the upstream [util-linux](https://github.com/util-linux/util-linux/releases) version.
7878

79-
[MIT](LICENSE)
79+
## License
8080

81+
[GPL-2.0](LICENSE)

0 commit comments

Comments
 (0)