Skip to content
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

Docker image docs could use some improvements #410

Open
lfmunoz opened this issue Sep 12, 2023 · 0 comments
Open

Docker image docs could use some improvements #410

lfmunoz opened this issue Sep 12, 2023 · 0 comments

Comments

@lfmunoz
Copy link

lfmunoz commented Sep 12, 2023

Learned about this project, but had a difficult time getting it running. Mostly because really basic simple information wasn't easily available.

1 Document how to run docker container

I should be able to just copy paste 1 command it should work , instead of me figuring it out. Should cover the most common use case.

From top of my head it would be:

docker run --rm --name dynamo-ui -it --net=host aaronshaf/dynamodb-admin

but what about environment variables? I have to read through code to figure this out.

After reading code / documentation:

docker run --rm --name dynamoui --net=host -it  aaronshaf/dynamodb-admin /bin/sh -c "DYNAMO_ENDPOINT=http://localhost:4566 node bin/dynamodb-admin.js --port 8001"

2 Ctrl+C doesn't kill docker container

Add entrypoint to allow this

#!/bin/bash

# entrypoint.sh
# start program
node bin/dynamodb-admin.js

# Store the PID of the background process in the variable PID
PID=$!

echo "STARTED SSHD PID=${PID}"

# Run a foreground process that waits for signals
trap 'kill -TERM $PID' TERM INT
wait $PID
# ...
# scroll to bottom of code
COPY entrypoint.sh /entrypoint.sh
ENTRYPOINT ["/entrypoint.sh"]

3 Docker hub webpage should have link to github.

i.e, if docker container doesn't work have to go read code

@lfmunoz lfmunoz changed the title Docker image docs could use a lot of improvements Docker image docs could use some improvements Sep 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant