Mascali/netbox-docker
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

✏️ Overhaul of the README

Browse source 
Plus some adjustment to the `build.sh` help text.

Fixes #3
This commit is contained in:
Christian Mäder 2017-09-11 15:30:52 +02:00
parent dd5da7afbc
commit e5e5f0204d
No known key found for this signature in database
GPG key ID: 92FFD0A711F196BB
2 changed files with 58 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

13
build.sh
View file

@ -4,17 +4,20 @@ set -e
if [ "${1}x" == "x" ] || [ "${1}" == "--help" ] || [ "${1}" == "-h" ]; then
echo "Usage: ${0} <branch> [--push]"
echo " branch The branch or tag to build"
echo " --push Push built Docker files to docker hub"
echo " branch The branch or tag to build. Required."
echo " --push Pushes built Docker image to docker hub."
echo ""
echo "You can use the following ENV variables to customize the build:"
echo " SRC_REPO The Github repository (i.e. github.com/SRC_REPO/netbox) of netbox."
echo " DOCKER_REPO The Docker repository (i.e. hub.docker.com/r/DOCKER_REPO/netbox) "
echo " Also used for tagging the image."
echo " BRANCH The branch to build."
echo " Also used for tagging the image."
echo " DOCKER_REPO The Docker registry (i.e. hub.docker.com/r/DOCKER_REPO/netbox) "
echo " Also used for tagging the image."
echo " Default: ninech"
echo " SRC_REPO Which fork of netbox to use (i.e. github.com/<SRC_REPO>/netbox)."
echo " Default: digitalocean"
echo " URL Where to fetch the package from."
echo " Must be a tar.gz file of the source code."
echo " Default: https://github.com/\${SRC_REPO}/netbox/archive/\$BRANCH.tar.gz"
if [ "${1}x" == "x" ]; then
exit 1