felddy/starlink-exporter repository overview

⁠starlink-exporter ⭐️🔗🐳

⁠Docker Image

A Starlink⁠ exporter for Prometheus.

⁠Running

⁠Running with Docker

To run the felddy/starlink-exporter image via Docker:

docker run felddy/starlink-exporter:0.0.1

⁠Running with Docker Compose

1. Create a docker-compose.yml file similar to the one below to use Docker Compose⁠.

   ---
   version: "3.7"
   
   services:
     starlink-exporter:
       image: felddy/starlink-exporter:0.0.1
      ports:
         - target: 9817
           published: 9817
           protocol: tcp
   

   Copy

2. Start the container and detach:

   docker-compose up --detach
   

   Copy

⁠Updating your container

⁠Docker Compose

1. Pull the new image from Docker Hub:

   docker-compose pull
   

   Copy

2. Recreate the running container by following the previous instructions⁠:

   docker-compose up --detach
   

   Copy

⁠Docker

1. Stop the running container:

   docker stop <container_id>
   

   Copy

2. Pull the new image:

   docker pull felddy/starlink-exporter:0.0.1
   

   Copy

3. Recreate and run the container by following the previous instructions⁠.

⁠Image tags

The images of this container are tagged with semantic versions⁠ of the underlying starlink-exporter project that they containerize. It is recommended that most users use a version tag (e.g. :0.0.1).

See the tags tab⁠ on Docker Hub for a list of all the supported tags.

⁠Volumes

None

⁠Ports

The following ports are exposed by this container:

The sample Docker composition⁠ publishes the exposed port at 9817.

⁠Environment variables

⁠Required

There are no required environment variables.

⁠Optional

There are no optional environment variables.

⁠Secrets

There are no secrets.

⁠Building from source

Build the image locally using this git repository as the build context⁠:

docker build \
  --build-arg VERSION=0.0.1 \
  --tag felddy/starlink-exporter:0.0.1 \
  https://github.com/felddy/starlink-exporter.git#develop

⁠Cross-platform builds

To create images that are compatible with other platforms, you can use the buildx⁠ feature of Docker:

1. Copy the project to your machine using the Code button above or the command line:

   git clone https://github.com/felddy/starlink-exporter.git
   cd starlink-exporter
   

   Copy

2. Create the Dockerfile-x file with buildx platform support:

   ./buildx-dockerfile.sh
   

   Copy

3. Build the image using buildx:

   docker buildx build \
     --file Dockerfile-x \
     --platform linux/amd64 \
     --build-arg VERSION=0.0.1 \
     --output type=docker \
     --tag felddy/starlink-exporter:0.0.1 .
   

   Copy

⁠Contributing

We welcome contributions! Please see CONTRIBUTING.md⁠ for details.

⁠License

This project is released as open source under the GPLv3⁠.

All contributions to this project will be released under the same GPLv3 license. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.