paolor/nexoctl repository overview

⁠Nexo

S3-compatible object storage server with an embedded web console: a single static binary for a single drive, a single node with several drives (erasure coding) or a distributed cluster.

• Source and issues: https://github.com/R3n3r0/Nexo⁠
• Documentation: https://github.com/R3n3r0/Nexo/tree/main/docs/user⁠
• Helm chart and binaries: attached to every GitHub release⁠

⁠Images

Both are multi-arch (linux/amd64, linux/arm64), signed with cosign keyless and carry SBOM and provenance attestations.

⁠Quick start

docker run -d --name nexo -p 9000:9000 -p 9001:9001 \
  -e NEXO_ROOT_USER=admin -e NEXO_ROOT_PASSWORD=supersecret \
  -v nexo-data:/data docker.io/paolor/nexo:latest server /data

Then open the console at http://localhost:9001⁠ or point any S3 client at http://localhost:9000⁠ with the root credentials. With the CLI:

docker run --rm -it --network host -v nexoctl-config:/home/nonroot/.nexoctl docker.io/paolor/nexoctl \
  alias set local http://localhost:9000 admin supersecret
docker run --rm -it --network host -v nexoctl-config:/home/nonroot/.nexoctl docker.io/paolor/nexoctl ls local

The deployment mode follows the arguments of nexo server: several drives with server /data{1...4} (one volume per drive), a cluster with server http://node{1...4}/data{1...4}.

⁠Tags

⁠Ports and volumes

⁠Environment variables

The complete list is in the configuration reference⁠.

⁠Documentation

• Installation⁠ (Docker, Compose, Swarm, Helm, packages)
• Quick start⁠
• Deployment modes⁠
• Compose files⁠ and Helm chart⁠ (nexo-X.Y.Z.tgz attached to each release⁠)
• Verifying a release⁠ (cosign signatures, SBOM, provenance)

⁠License

Nexo is released under the GNU AGPL-3.0⁠ with the attribution terms of NOTICE⁠; commercial licenses are available, see COMMERCIAL-LICENSE.md⁠. The images contain /LICENSE, /NOTICE and /COMMERCIAL-LICENSE.md.