2 Commits

Author SHA1 Message Date
7682224e45 docs: fix env vars, ports, remove stale docs/, unify with getnora.dev
- README: NORA_DOCKER_UPSTREAMS -> NORA_DOCKER_PROXIES, remove phantom NORA_LOG_LEVEL/FORMAT, add NORA_AUTH_ANONYMOUS_READ, NORA_RATE_LIMIT_ENABLED, nora gc, Documentation section
- SECURITY: add 0.4.x, 0.5.x to supported versions
- COMPAT: /swagger-ui/ -> /api-docs
- llms.txt: fix env vars (RUST_LOG, NORA_DOCKER_PROXIES), rate limit default true
- docker-compose: add NORA_HOST=0.0.0.0
- docs-ru: getnora.io -> getnora.dev, fix download URL, NORA_DOCKER_PROXIES
- tests count: 460+ -> 570+
2026-04-12 17:30:06 +00:00
09155c7df3 docs: add llms.txt for AI agent discoverability (#129)
Structured project description optimized for LLM consumption.
Served at getnora.dev/llms.txt and in repo root.
2026-04-12 15:50:43 +03:00
7 changed files with 25 additions and 14 deletions

View File

@@ -141,7 +141,7 @@ Helm charts are stored as OCI artifacts via the Docker registry endpoints. `helm
| Rate limiting | Full | `tower_governor`, per-IP | | Rate limiting | Full | `tower_governor`, per-IP |
| Prometheus metrics | Full | `/metrics` endpoint | | Prometheus metrics | Full | `/metrics` endpoint |
| Health check | Full | `/health` | | Health check | Full | `/health` |
| Swagger/OpenAPI | Full | `/swagger-ui/` | | Swagger/OpenAPI | Full | `/api-docs` |
| S3 backend | Full | AWS, MinIO, any S3-compatible | | S3 backend | Full | AWS, MinIO, any S3-compatible |
| Local filesystem backend | Full | Default, content-addressable | | Local filesystem backend | Full | Default, content-addressable |
| Activity log | Full | Recent push/pull in dashboard | | Activity log | Full | Recent push/pull in dashboard |

View File

@@ -16,7 +16,7 @@ Open [http://localhost:4000/ui/](http://localhost:4000/ui/) — your registry is
- **Zero-config** — single 32 MB binary, no database, no dependencies. `docker run` and it works. - **Zero-config** — single 32 MB binary, no database, no dependencies. `docker run` and it works.
- **Production-tested** — Docker (+ Helm OCI), Maven, npm, PyPI, Cargo, Go, Raw. Used in real CI/CD with ArgoCD, Buildx cache, and air-gapped environments. - **Production-tested** — Docker (+ Helm OCI), 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, 460+ tests. - **Secure by default** — [OpenSSF Scorecard](https://scorecard.dev/viewer/?uri=github.com/getnora-io/nora), signed releases, SBOM, fuzz testing, 570+ tests.
[![Release](https://img.shields.io/github/v/release/getnora-io/nora)](https://github.com/getnora-io/nora/releases) [![Release](https://img.shields.io/github/v/release/getnora-io/nora)](https://github.com/getnora-io/nora/releases)
[![Image Size](https://img.shields.io/badge/image-32%20MB-blue)](https://github.com/getnora-io/nora/pkgs/container/nora) [![Image Size](https://img.shields.io/badge/image-32%20MB-blue)](https://github.com/getnora-io/nora/pkgs/container/nora)
@@ -143,10 +143,10 @@ See [Authentication guide](https://getnora.dev/configuration/authentication/) fo
| `NORA_PORT` | 4000 | Port | | `NORA_PORT` | 4000 | Port |
| `NORA_STORAGE_MODE` | local | `local` or `s3` | | `NORA_STORAGE_MODE` | local | `local` or `s3` |
| `NORA_AUTH_ENABLED` | false | Enable authentication | | `NORA_AUTH_ENABLED` | false | Enable authentication |
| `NORA_DOCKER_UPSTREAMS` | `https://registry-1.docker.io` | Docker upstreams (`url\|user:pass,...`) | | `NORA_AUTH_ANONYMOUS_READ` | false | Allow unauthenticated read access |
| `NORA_LOG_LEVEL` | info | Log level: trace, debug, info, warn, error | | `NORA_DOCKER_PROXIES` | `https://registry-1.docker.io` | Docker upstreams (`url\|user:pass,...`) |
| `NORA_LOG_FORMAT` | text | Log format: `text` (human) or `json` (structured) |
| `NORA_PUBLIC_URL` | — | Public URL for rewriting artifact links | | `NORA_PUBLIC_URL` | — | Public URL for rewriting artifact links |
| `NORA_RATE_LIMIT_ENABLED` | true | Enable rate limiting |
See [full configuration reference](https://getnora.dev/configuration/settings/) for all options. See [full configuration reference](https://getnora.dev/configuration/settings/) for all options.
### config.toml ### config.toml
@@ -182,6 +182,7 @@ nora serve # Start server (explicit)
nora backup -o backup.tar.gz nora backup -o backup.tar.gz
nora restore -i backup.tar.gz nora restore -i backup.tar.gz
nora migrate --from local --to s3 nora migrate --from local --to s3
nora gc # Garbage collect orphaned blobs
nora mirror # Sync packages for offline use nora mirror # Sync packages for offline use
``` ```
@@ -249,6 +250,14 @@ See [CHANGELOG.md](CHANGELOG.md) for release history.
See [SECURITY.md](SECURITY.md) for vulnerability reporting. See [SECURITY.md](SECURITY.md) for vulnerability reporting.
## Documentation
Full documentation: **https://getnora.dev**
> The `docs/` directory has been removed. All documentation lives on getnora.dev.
> Configuration reference: [getnora.dev/configuration/settings](https://getnora.dev/configuration/settings/)
> Source of truth for env vars: `nora-registry/src/config.rs` → `apply_env_overrides()`
## Author ## Author
Created and maintained by [DevITWay](https://github.com/devitway) Created and maintained by [DevITWay](https://github.com/devitway)

View File

@@ -4,6 +4,8 @@
| Version | Supported | | Version | Supported |
| ------- | ------------------ | | ------- | ------------------ |
| 0.5.x | :white_check_mark: |
| 0.4.x | :white_check_mark: |
| 0.3.x | :white_check_mark: | | 0.3.x | :white_check_mark: |
| 0.2.x | :white_check_mark: | | 0.2.x | :white_check_mark: |
| < 0.2 | :x: | | < 0.2 | :x: |

View File

@@ -7,6 +7,7 @@ services:
- nora-data:/data - nora-data:/data
environment: environment:
- RUST_LOG=info - RUST_LOG=info
- NORA_HOST=0.0.0.0
- NORA_AUTH_ENABLED=false - NORA_AUTH_ENABLED=false
restart: unless-stopped restart: unless-stopped

View File

@@ -38,7 +38,7 @@ NORA — многопротокольный реестр артефактов,
### 2.1. Автоматическая установка ### 2.1. Автоматическая установка
```bash ```bash
curl -fsSL https://getnora.io/install.sh | bash curl -fsSL https://getnora.dev/install.sh | bash
``` ```
Скрипт выполняет следующие действия: Скрипт выполняет следующие действия:
@@ -54,7 +54,7 @@ curl -fsSL https://getnora.io/install.sh | bash
```bash ```bash
# Загрузка # Загрузка
wget https://github.com/getnora-io/nora/releases/download/v1.0.0/nora-linux-x86_64 wget https://github.com/getnora-io/nora/releases/latest/download/nora-linux-amd64
chmod +x nora-linux-x86_64 chmod +x nora-linux-x86_64
mv nora-linux-x86_64 /usr/local/bin/nora mv nora-linux-x86_64 /usr/local/bin/nora
@@ -122,7 +122,7 @@ htpasswd -Bc /etc/nora/users.htpasswd admin
| `NORA_NPM_METADATA_TTL` | TTL кэша метаданных (секунды) | `300` | | `NORA_NPM_METADATA_TTL` | TTL кэша метаданных (секунды) | `300` |
| `NORA_PYPI_PROXY` | URL PyPI-реестра | `https://pypi.org/simple/` | | `NORA_PYPI_PROXY` | URL PyPI-реестра | `https://pypi.org/simple/` |
| `NORA_MAVEN_PROXIES` | Список Maven-репозиториев через запятую | `https://repo1.maven.org/maven2` | | `NORA_MAVEN_PROXIES` | Список Maven-репозиториев через запятую | `https://repo1.maven.org/maven2` |
| `NORA_DOCKER_UPSTREAMS` | Docker-реестры, формат: `url\|auth,url2` | `https://registry-1.docker.io` | | `NORA_DOCKER_PROXIES` | Docker-реестры, формат: `url\|auth,url2` | `https://registry-1.docker.io` |
### 3.4. Ограничение частоты запросов ### 3.4. Ограничение частоты запросов

View File

@@ -156,7 +156,7 @@
**Торговая марка:** АРТАИС **Торговая марка:** АРТАИС
**Сайт продукта:** https://getnora.io **Сайт продукта:** https://getnora.dev
**Документация:** https://getnora.dev **Документация:** https://getnora.dev

View File

@@ -163,11 +163,10 @@ nora mirror maven --registry http://localhost:4000 --artifact org.slf4j:slf4j-ap
| `NORA_STORAGE_MODE` | `local` | `local` or `s3` | | `NORA_STORAGE_MODE` | `local` | `local` or `s3` |
| `NORA_AUTH_ENABLED` | `false` | Enable authentication | | `NORA_AUTH_ENABLED` | `false` | Enable authentication |
| `NORA_AUTH_ANONYMOUS_READ` | `false` | Allow pull without auth | | `NORA_AUTH_ANONYMOUS_READ` | `false` | Allow pull without auth |
| `NORA_DOCKER_UPSTREAMS` | Docker Hub | Upstream registries | | `NORA_DOCKER_PROXIES` | Docker Hub | Upstream registries (deprecated: `NORA_DOCKER_UPSTREAMS`) |
| `NORA_LOG_LEVEL` | `info` | trace, debug, info, warn, error | | `RUST_LOG` | `info` | Logging filter: trace, debug, info, warn, error |
| `NORA_LOG_FORMAT` | `text` | `text` or `json` |
| `NORA_PUBLIC_URL` | — | Public URL for artifact links | | `NORA_PUBLIC_URL` | — | Public URL for artifact links |
| `NORA_RATE_LIMIT_ENABLED` | `false` | Enable rate limiting | | `NORA_RATE_LIMIT_ENABLED` | `true` | Enable rate limiting |
## Endpoints ## Endpoints
@@ -286,7 +285,7 @@ Q: Can NORA run on Astra Linux or RED OS?
A: Yes. Every release includes Docker images built on Astra Linux SE and RED OS base images, alongside the standard Alpine image. A: Yes. Every release includes Docker images built on Astra Linux SE and RED OS base images, alongside the standard Alpine image.
Q: How do I monitor NORA? Q: How do I monitor NORA?
A: Prometheus metrics at `/metrics`, health check at `/health`, readiness probe at `/ready`. Structured JSON logging available with `NORA_LOG_FORMAT=json`. A: Prometheus metrics at `/metrics`, health check at `/health`, readiness probe at `/ready`. Structured JSON logging available with `RUST_LOG=info (or debug, trace etc.)`.
Q: How do I backup NORA? Q: How do I backup NORA?
A: `nora backup -o backup.tar.gz` creates a full backup. `nora restore -i backup.tar.gz` restores it. For S3 backends, use your S3 backup tooling. A: `nora backup -o backup.tar.gz` creates a full backup. `nora restore -i backup.tar.gz` restores it. For S3 backends, use your S3 backup tooling.