mirror of
https://github.com/getnora-io/nora.git
synced 2026-04-12 06:50:31 +00:00
docs: add Go module proxy support to README (#62)
* docs: add Go module proxy to README, update dashboard GIF - Add Go Modules to supported registries table - Add Go usage example (GOPROXY) - Add Go config.toml example - Add /go/ endpoint to endpoints table - Update dashboard GIF with 6 registry cards in one row - Fix registries count: 6 package registries * feat(ui): add Raw storage to dashboard, sidebar, and list pages - Raw Storage card on dashboard with file count and size - Raw in sidebar navigation with file icon - Raw list and detail pages (/ui/raw) - Raw mount point in mount points table - Grid updated to 7 columns for all registry cards - README: 7 registries, add Go module proxy docs * docs: add product badges (release, image size, downloads)
This commit is contained in:
21
README.md
21
README.md
@@ -15,10 +15,15 @@ Open [http://localhost:4000/ui/](http://localhost:4000/ui/) — your registry is
|
||||
## Why NORA
|
||||
|
||||
- **Zero-config** — single 32 MB binary, no database, no dependencies. `docker run` and it works.
|
||||
- **Production-tested** — Docker, Maven, npm, PyPI, Cargo, Raw. Used in real CI/CD with ArgoCD, Buildx cache, and air-gapped environments.
|
||||
- **Production-tested** — Docker, Maven, npm, PyPI, Cargo, Go, Raw. Used in real CI/CD with ArgoCD, Buildx cache, and air-gapped environments.
|
||||
- **Secure by default** — [OpenSSF Scorecard](https://scorecard.dev/viewer/?uri=github.com/getnora-io/nora), signed releases, SBOM, fuzz testing, 200+ unit tests.
|
||||
|
||||
**32 MB** binary | **< 100 MB** RAM | **3s** startup | **6** registries
|
||||
[](https://github.com/getnora-io/nora/releases)
|
||||
[](https://github.com/getnora-io/nora/pkgs/container/nora)
|
||||
[](https://github.com/getnora-io/nora/releases)
|
||||
[](LICENSE)
|
||||
|
||||
**32 MB** binary | **< 100 MB** RAM | **3s** startup | **7** registries
|
||||
|
||||
> Used in production at [DevIT Academy](https://github.com/devitway) since January 2026 for Docker images, Maven artifacts, and npm packages.
|
||||
|
||||
@@ -31,6 +36,7 @@ Open [http://localhost:4000/ui/](http://localhost:4000/ui/) — your registry is
|
||||
| npm | `/npm/` | npmjs.org, custom | ✓ |
|
||||
| Cargo | `/cargo/` | — | ✓ |
|
||||
| PyPI | `/simple/` | pypi.org, custom | ✓ |
|
||||
| Go Modules | `/go/` | proxy.golang.org, custom | ✓ |
|
||||
| Raw files | `/raw/` | — | ✓ |
|
||||
|
||||
## Quick Start
|
||||
@@ -82,6 +88,12 @@ npm config set registry http://localhost:4000/npm/
|
||||
npm publish
|
||||
```
|
||||
|
||||
### Go Modules
|
||||
|
||||
```bash
|
||||
GOPROXY=http://localhost:4000/go go get golang.org/x/text@latest
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
- **Web UI** — dashboard with search, browse, i18n (EN/RU)
|
||||
@@ -154,6 +166,9 @@ proxy_timeout = 60
|
||||
|
||||
[[docker.upstreams]]
|
||||
url = "https://registry-1.docker.io"
|
||||
|
||||
[go]
|
||||
proxy = "https://proxy.golang.org"
|
||||
```
|
||||
|
||||
## CLI Commands
|
||||
@@ -181,6 +196,7 @@ nora mirror # Sync packages for offline use
|
||||
| `/npm/` | npm |
|
||||
| `/cargo/` | Cargo |
|
||||
| `/simple/` | PyPI |
|
||||
| `/go/` | Go Modules |
|
||||
|
||||
## TLS / HTTPS
|
||||
|
||||
@@ -220,7 +236,6 @@ See [CHANGELOG.md](CHANGELOG.md) for release history.
|
||||
[](https://www.bestpractices.dev/projects/12207)
|
||||
[](https://github.com/getnora-io/nora/actions/workflows/ci.yml)
|
||||
[](https://github.com/getnora-io/nora/actions)
|
||||
[](LICENSE)
|
||||
|
||||
- **Signed releases** — every release is signed with [cosign](https://github.com/sigstore/cosign)
|
||||
- **SBOM** — SPDX + CycloneDX in every release
|
||||
|
||||
Reference in New Issue
Block a user