How fargus3222/nn-docker works
Project type and purpose
• This is a Docker‑packaged crypto node (“Nexus Node”) intended to run a Nexus blockchain node inside a container.
• The README makes clear it’s not a full stack web app but a single‑service container image, with supporting scripts, CI/CD pipeline, and orchestration via docker-compose.
File structure
• Top‑level CI/CD:
• .github/workflows/deploy.job.yml – GitHub Actions build & publish
• Build and run scripts:
• Dockerfile – builds the Nexus Node image
• Makefile – developer shortcuts (build, test, push)
• install.sh / run.sh – convenience wrappers
• Runtime orchestration:
• docker-compose.yml – compose definition mounting host volume to container (~/.nexus/)
• Other:
• .gitignore, LICENSE files, CHANGELOG.md
README for insights
• Describes how to pull and run the image, and how to use docker‑compose.
• Mentions the external Nexus network (peer‑to‑peer blockchain).
Main components
a. Host infrastructure:
• Developer/CI server (GitHub Actions)
• Docker registry (Docker Hub)
• Production/edge host (on‑prem or cloud VM)
b. Build pipeline:
• Source repo → GitHub Actions → Docker Hub
c. Runtime components:
• Docker Engine on Host → runs Nexus Node container
• Mounted Host Volume (~/.nexus) for blockchain data persistence
• Nexus Node process inside container
d. External dependencies:
• Nexus P2P network (other nodes)
Relationships and interactions
• Developer pushes code → CI pipeline triggers Docker build → image is pushed to registry
• Host pulls image → Docker Engine instantiates container
• Container reads/writes data from host volume
• Nexus Node in container communicates over the internet with other P2P nodes
Architectural patterns and principles
• Single‑service container (microservice‑style)
• Immutable infrastructure: container image is the deployable artifact
• CI/CD pipeline ensures repeatable builds and versioning
• Data persistence via volume mount (separation of compute and storage)
Relevant technologies
• Docker, Docker Compose
• GitHub Actions
• Bash scripts (install.sh, run.sh)
• Makefile for local automation
• Nexus blockchain node software (inside image)
Detail
• Which scripts (run.sh, install.sh) interact at build or run time
• Call out the Makefile targets (build, push) if relevant to the CI stage