Install

Newt can be used as either a static binary executable or a Docker container.

Configuration

Configuration is passed in as CLI args in both the binary and the Docker container. In order to run Newt and have it connect to something you must first create a site and copy the newt config in Pangolin.

Binary

Binaries for Linux, MacOS, and Windows can be found in the Github releases for ARM and AMD64 (x86_64) versions of Newt. It should be as simple as downloading for your respective platform, making sure it is executable, and running it with the correct CLI args.

On Linux for example:

Download Newt with either wget or curl or from your browser and make it executable:

wget -O newt "https://github.com/fosrl/newt/releases/download/1.0.0-beta.4/newt_linux_amd64" && chmod +x ./newt

curl -L -o newt "https://github.com/fosrl/newt/releases/download/1.0.0-beta.4/newt_linux_amd64" && chmod +x ./newt

And run it:

./newt \
--id 31frd0uzbjvp721 \
--secret h51mmlknrvrwv8s4r1i210azhumt6isgbpyavxodibx1k2d6 \
--endpoint https://example.com

To install permanently to your PATH (may need to run as root):

mv ./newt /usr/local/bin

Docker

You can find the built docker container on Docker hub.

To pull it:

docker pull fosrl/newt:latest

Then to run it from the command line with args from Pangolin:

docker run -it fosrl/newt --id 31frd0uzbjvp721 \
--secret h51mmlknrvrwv8s4r1i210azhumt6isgbpyavxodibx1k2d6 \
--endpoint https://example.com

You can also run it with Docker compose. For example, a service in your docker-compose.yml might look like this using environment vars (recommended):

services:
  newt:
    image: fosrl/newt
    container_name: newt
    restart: unless-stopped
    environment:
      - PANGOLIN_ENDPOINT=https://example.com
      - NEWT_ID=2ix2t8xk22ubpfy 
      - NEWT_SECRET=nnisrfsdfc7prqsp9ewo1dvtvci50j5uiqotez00dgap0ii2

You can also pass the CLI args to the container:

services:
  newt:
    image: fosrl/newt
    container_name: newt
    restart: unless-stopped
    command:
        - --id 31frd0uzbjvp721
        - --secret h51mmlknrvrwv8s4r1i210azhumt6isgbpyavxodibx1k2d6
        - --endpoint https://example.com

Unraid

Newt is available in the Unraid Community Applications store. You can install it by searching for Newt in the store and following the prompts. Enter in the ID, secret, and endpoint from Pangolin in the template fields.

Newt on CA

Portainer, and other UIs

These container management UIs typically allow for passing commands and environment vars to the container similar to Docker compose. Look for a commands or arguments box and follow relevant guides.

And you could start it by simply running:

docker compose up -d

We intend to create more extensive documentation on this in the future. If you would like to contribute, please do!

3.1 KiB Raw Blame History