feat: add Docker publishing with environment variable conventions#1
Merged
feat: add Docker publishing with environment variable conventions#1
Conversation
- Add GitHub Actions workflow for Docker publishing - Support GitHub Container Registry and private registries - Implement environment variable naming convention (NODE_, NATS_, LOG_, etc.) - Add dynamic port configuration via NODE_PORT - Simplify documentation and remove noise - Support multi-platform builds and security scanning
- Add template detection logic to disable publishing from template repo - Enable publishing only for consuming repositories after customization - Add explicit checks for template indicators in README.md - Update documentation to clarify publishing behavior - Protect template repository from accidental Docker image publishing
0x3bfc
reviewed
Nov 19, 2025
0x3bfc
reviewed
Nov 19, 2025
0x3bfc
reviewed
Nov 19, 2025
| # Set environment variables | ||
| ENV PYTHONPATH=/app | ||
| ENV PYTHONUNBUFFERED=1 | ||
| ENV NODE_PORT=8000 |
Member
There was a problem hiding this comment.
don't hardcode this port in the dockerfile, the compose should handle this.
0x3bfc
reviewed
Nov 19, 2025
0x3bfc
reviewed
Nov 19, 2025
0x3bfc
reviewed
Nov 19, 2025
0x3bfc
reviewed
Nov 19, 2025
0x3bfc
reviewed
Nov 19, 2025
0x3bfc
reviewed
Nov 19, 2025
0x3bfc
reviewed
Nov 19, 2025
Co-authored-by: Ahmed <ahmed.abdullah.ali@protonmail.com>
…ate' into ahmed/feat/docker-registry-template
0x3bfc
reviewed
Nov 19, 2025
0x3bfc
reviewed
Nov 19, 2025
README.md
Outdated
Comment on lines
31
to
53
| ## Configuration | ||
|
|
||
| ```bash | ||
| # Run tests | ||
| PYTHONPATH=src uv run pytest | ||
| ### Node Configuration | ||
|
|
||
| Configure `node.json` with your node metadata. All fields are required: | ||
|
|
||
| - **Identity**: `version`, `node_id`, `name`, `description` | ||
| - **Runtime**: `api_url`, `ip_address`, `docker_image`, `status`, `deployment_location` | ||
| - **Metadata**: `author`, `created_at`, `source_code_location` | ||
| - **Components**: Define your node's functional components | ||
|
|
||
| See [Node Configuration Guide](docs/node-configuration.md) for complete details. | ||
|
|
||
| ### Environment Variables | ||
|
|
||
| Copy `.env.example` to `.env` and configure: | ||
|
|
||
| **Required:** | ||
| - `NODE_NAME` - Node identifier | ||
| - `NODE_PORT` - Port inside container (default: 8000) | ||
| - `NATS_URL` - NATS server URL (default: nats://localhost:4222) | ||
| - `STREAM_NAME` - JetStream name (default: droq-stream) | ||
| - `LOG_LEVEL` - Logging level (default: INFO) |
Member
There was a problem hiding this comment.
All of this already mentioned in the documentation and the .env.example.
Member
Author
There was a problem hiding this comment.
I beleive .env.example is a starter/boilerplate and has nothing to do with documention
0x3bfc
reviewed
Nov 19, 2025
0x3bfc
reviewed
Nov 19, 2025
0x3bfc
reviewed
Nov 19, 2025
0x3bfc
reviewed
Nov 19, 2025
0x3bfc
reviewed
Nov 19, 2025
0x3bfc
reviewed
Nov 19, 2025
0x3bfc
reviewed
Nov 19, 2025
0x3bfc
reviewed
Nov 19, 2025
docs/node-configuration.md
Outdated
| The `docker_image` field should match your Docker publishing configuration: | ||
|
|
||
| ```json | ||
| "docker_image": "ghcr.io/myorg/my-node:latest" |
Member
There was a problem hiding this comment.
update the example with docker image only please default to the known registry. myorg/my-node:latest
0x3bfc
reviewed
Nov 19, 2025
Co-authored-by: Ahmed <ahmed.abdullah.ali@protonmail.com>
Co-authored-by: Ahmed <ahmed.abdullah.ali@protonmail.com>
Co-authored-by: Ahmed <ahmed.abdullah.ali@protonmail.com>
Co-authored-by: Ahmed <ahmed.abdullah.ali@protonmail.com>
Co-authored-by: Ahmed <ahmed.abdullah.ali@protonmail.com>
Co-authored-by: Ahmed <ahmed.abdullah.ali@protonmail.com>
0x3bfc
reviewed
Nov 19, 2025
Member
There was a problem hiding this comment.
Keep this file but don't reference it in the main readme file till we release the registry service.
0x3bfc
reviewed
Nov 19, 2025
Co-authored-by: Ahmed <ahmed.abdullah.ali@protonmail.com>
Co-authored-by: Ahmed <ahmed.abdullah.ali@protonmail.com>
Co-authored-by: Ahmed <ahmed.abdullah.ali@protonmail.com>
Co-authored-by: Ahmed <ahmed.abdullah.ali@protonmail.com>
Co-authored-by: Ahmed <ahmed.abdullah.ali@protonmail.com>
…ate' into ahmed/feat/docker-registry-template # Conflicts: # docs/node-configuration.md
0x3bfc
reviewed
Nov 19, 2025
0x3bfc
approved these changes
Nov 19, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #2 , and defining the registration docs