✏️ Overhaul of the README

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

Fixes #3

README.md

@@ -1,18 +1,31 @@
 # netbox-docker
 
-This repository houses the components needed to build NetBox as a Docker container. It is a work in progress; please submit a bug report for any issues you encounter.
+This repository houses the components needed to build NetBox as a Docker container.
+Images built using this code are released to [Docker Hub](https://hub.docker.com/r/ninech/netbox) every night.
 
 ## Quickstart
 
 To get NetBox up and running:
 
 ```
-# git clone -b master https://github.com/digitalocean/netbox-docker.git
-# cd netbox-docker
-# docker-compose up -d
+$ git clone -b master https://github.com/digitalocean/netbox-docker.git
+$ cd netbox-docker
+$ docker-compose up -d
 ```
 
-The application will be available on http://localhost/ after a few minutes.
+The application will be available after a few minutes.
+Use `docker-compose port nginx 80` to find out where to connect to.
+
+```
+$ echo "http://$(docker-compose port nginx 80)/"
+http://0.0.0.0:32768/
+
+# Open netbox in your default browser on macOS:
+$ open "http://$(docker-compose port nginx 80)/"
+
+# Open netbox in your default browser on (most) linuxes:
+$ xdg-open "http://$(docker-compose port nginx 80)/" &>/dev/null &
+```
 
 Default credentials:
 
@@ -21,41 +34,43 @@ Default credentials:
 
 ## Configuration
 
-You can configure the app at runtime using variables (see `docker-compose.yml`). Possible environment variables include:
-
-* SUPERUSER_NAME
-* SUPERUSER_EMAIL
-* SUPERUSER_PASSWORD
-* ALLOWED_HOSTS
-* DB_NAME
-* DB_USER
-* DB_PASSWORD
-* DB_HOST
-* DB_PORT
-* SECRET_KEY
-* EMAIL_SERVER
-* EMAIL_PORT
-* EMAIL_USERNAME
-* EMAIL_PASSWORD
-* EMAIL_TIMEOUT
-* EMAIL_FROM
-* LOGIN_REQUIRED
-* MAINTENANCE_MODE
-* NETBOX_USERNAME
-* NETBOX_PASSWORD
-* PAGINATE_COUNT
-* TIME_ZONE
-* DATE_FORMAT
-* SHORT_DATE_FORMAT
-* TIME_FORMAT
-* SHORT_TIME_FORMAT
-* DATETIME_FORMAT
-* SHORT_DATETIME_FORMAT
+You can configure the app using environment variables. These are defined in `netbox.env`.
+
+## Rebuilding & Publishing images
+
+`./build.sh` is used to rebuild the Docker image:
+
+```
+$ ./build.sh --help
+Usage: ./build.sh <branch> [--push]
+  branch  The branch or tag to build. Required.
+  --push  Pushes built Docker image to docker hub.
+
+You can use the following ENV variables to customize the build:
+  BRANCH   The branch to build.
+           Also used for tagging the image.
+  DOCKER_REPO The Docker registry (i.e. hub.docker.com/r/DOCKER_REPO/netbox)
+           Also used for tagging the image.
+           Default: ninech
+  SRC_REPO Which fork of netbox to use (i.e. github.com/<SRC_REPO>/netbox).
+           Default: digitalocean
+  URL      Where to fetch the package from.
+           Must be a tar.gz file of the source code.
+           Default: https://github.com/${SRC_REPO}/netbox/archive/$BRANCH.tar.gz
+```
 
 ## Tests
 
 To run the bundled test, use the `docker-compose.test.yml` file.
 
 ```
-# docker-compose -f docker-compose.test.yml run --rm app
+$ docker-compose -f docker-compose.test.yml run --rm app
 ```
+
+## About
+
+This repository is currently maintained by [nine.ch](https://nine.ch).
+
+[![nine.ch Logo](https://blog.nine.ch/assets/logo.png)](https://nine.ch)
+
+We run your Linux server infrastructure – without interruptions, around the clock.

build.sh

@@ -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