diff --git a/CONFIGURATION.md b/CONFIGURATION.md new file mode 100644 index 0000000..a890ff2 --- /dev/null +++ b/CONFIGURATION.md @@ -0,0 +1,68 @@ +#Environment Variables +##Required global variables +* GW_TYPE required +* GW_ID required +* GW_KEY required +* GW_CONTACT_EMAIL required - default an empty string + The gateway owner's contact information. + +##Optional global variables +* GW_GPS optional - default False + * If True, use the hardware GPS. + * If False, + use either fake gps if a location was configured in the TTN console, + otherwise try using fake gps with the reference location as set via environment variables, + otherwise don't send coordinates. +* GW_GPS_PORT optional - default /dev/ttyAMA0 + The UART to which the hardware GPS is connected to. +* GW_REF_LATITUDE optional - default 0 + The latitude to use for fake gps if the coordinates are not set in the TTN console. +* GW_REF_LONGITUDE optional - default 0 + The longitude to use for fake gps if the coordinates are not set in the TTN console. +* GW_REF_ALTITUDE optional - default 0 + The altitude to use for fake gps if the coordinates are not set in the TTN console. + +##Server variables +All server variables are optional, but when a server is enabled, it is recommended to set all variables to configure it completely. +* SERVER_TTN optional - default True + Should the gateway connect to the TTN backend + +* SERVER_1_ENABLED optional - default false +* SERVER_1_TYPE - default "semtech" +* SERVER_1_ADDRESS +* SERVER_1_PORTUP - only when using type semtech +* SERVER_1_PORTDOWN - only when using type semtech +* SERVER_1_GWID +* SERVER_1_GWKEY +* SERVER_1_DOWNLINK - default false + +* SERVER_2_ENABLED optional - default false +* SERVER_2_TYPE - default "semtech" +* SERVER_2_ADDRESS +* SERVER_2_PORTUP - only when using type semtech +* SERVER_2_PORTDOWN - only when using type semtech +* SERVER_2_GWID +* SERVER_2_GWKEY +* SERVER_2_DOWNLINK - default false + +* SERVER_3_ENABLED optional - default false +* SERVER_3_TYPE - default "semtech" +* SERVER_3_ADDRESS +* SERVER_3_PORTUP - only when using type semtech +* SERVER_3_PORTDOWN - only when using type semtech +* SERVER_3_GWID +* SERVER_3_GWKEY +* SERVER_3_DOWNLINK - default false + +#Logal debugging +``` +docker run --device /dev/ttyAMA0:/dev/ttyAMA0 --device /dev/mem:/dev/mem --privileged -e GW_TYPE="imst-ic880a-spi" -e GW_DESCRIPTION="test gateway" -e GW_CONTACT_EMAIL="" -e GW_ID="" -e GW_KEY="" newforwarder + + +``` +Make a copy of `Dockerfile.template` to `Dockerfile`. +``` +FROM resin/raspberrypi-buildpack-deps +... +CMD ["bash"] +``` diff --git a/Dockerfile b/Dockerfile index 96af98d..9f5ae2c 100644 --- a/Dockerfile +++ b/Dockerfile @@ -7,11 +7,6 @@ FROM resin/raspberrypi-buildpack-deps ENV RESIN_ARCH %%RESIN_ARCH%% ENV RESIN_MACHINE_NAME %%RESIN_MACHINE_NAME%% -# Version number of gateway software. -# (Incrementing this simply forces Docker to flush its cache -# and thus forces a full rebuild. Not used outside of Dockerfile.) -ENV TTN_GATEWAY_SOFTWARE 51 - # Copy the build and run environment COPY . /opt/ttn-gateway/ WORKDIR /opt/ttn-gateway/ @@ -20,4 +15,4 @@ WORKDIR /opt/ttn-gateway/ RUN ./dev/build.sh && rm -rf ./dev # Start it up -CMD ["sh", "-c", "./run.sh"] +CMD ["sh", "-c", "./run.py"] diff --git a/Dockerfile.template b/Dockerfile.template index bdaa938..4c149bc 100644 --- a/Dockerfile.template +++ b/Dockerfile.template @@ -7,11 +7,6 @@ ENV INITSYSTEM on ENV RESIN_ARCH %%RESIN_ARCH%% ENV RESIN_MACHINE_NAME %%RESIN_MACHINE_NAME%% -# Version number of gateway software. -# (Incrementing this simply forces Docker to flush its cache -# and thus forces a full rebuild. Not used outside of Dockerfile.) -ENV TTN_GATEWAY_SOFTWARE 51 - # Copy the build and run environment COPY . /opt/ttn-gateway/ WORKDIR /opt/ttn-gateway/ @@ -20,4 +15,4 @@ WORKDIR /opt/ttn-gateway/ RUN ./dev/build.sh && rm -rf ./dev # Start it up -CMD ["sh", "-c", "./run.sh"] +CMD ["sh", "-c", "./run.py"]