-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add image metadata, allow flags to be overridden, and tzdata #12
Conversation
That last one was a major omission and would cause the daemon to hang when run in a container.
Reviewer's Guide by SourceryThis pull request adds instructions for running the application under Docker to the README.md file. It provides a simple command to start the daemon in a Docker container, which enhances the project's documentation and makes it easier for users to deploy the application using containerization. File-Level Changes
Tips
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @kgaughan - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 1 issue found
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
To start the daemon in a Docker container, run: | ||
|
||
```sh | ||
docker run -d -p 12300:12300 ghcr.io/kgaughan/nxtp:latest |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion (documentation): Consider adding a brief explanation of the Docker command and port usage.
It might be helpful to explain what the command does and mention if the port number can be changed. This would assist users who are less familiar with Docker or who need to use a different port.
docker run -d -p 12300:12300 ghcr.io/kgaughan/nxtp:latest | |
To start the daemon in a Docker container, run: | |
```sh | |
# Run the NXTP container in detached mode, mapping port 12300 | |
# You can change the first 12300 to use a different host port | |
docker run -d -p 12300:12300 ghcr.io/kgaughan/nxtp:latest |
This command runs the container in detached mode (-d) and maps the container's port 12300 to the host's port 12300.
Summary by Sourcery
Update the README to include instructions for running the daemon in a Docker container.
Documentation: