From 88494cd15f59b4031e6cb080d236be70c21f4aa0 Mon Sep 17 00:00:00 2001 From: James Swineson Date: Sat, 14 May 2022 18:44:25 +0800 Subject: [PATCH] update instructions for registering the probe --- README.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 786e0f5..770fc33 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ This is the [RIPE Atlas software probe](https://atlas.ripe.net/docs/software-pro ## Tags -The following prebuilt tags are available at [Docker Hub](https://hub.docker.com/r/jamesits/ripe-atlas). Just use `latest` tag and Docker will select image variant automatically. +The following prebuilt tags are available at [Docker Hub](https://hub.docker.com/r/jamesits/ripe-atlas). The `latest` tag supports [multi-arch](https://www.docker.com/blog/multi-arch-build-and-images-the-simple-way/), and should be used by default. * **`latest`: For all supported devices listed below (multi-arch)** * `latest-arm64`: For arm64 (aarch64) devices @@ -41,14 +41,6 @@ docker run --detach --restart=always \ jamesits/ripe-atlas:latest ``` -Then we fetch the generated public key: - -```shell -cat /var/atlas-probe/etc/probe_key.pub -``` - -[Register](https://atlas.ripe.net/apply/swprobe/) the probe with your public key. After the registration being manually processed, you'll see your new probe in your account. - ### Using Docker Compose An example [`docker-compose.yaml`](/docker-compose.yaml) is provided. @@ -60,8 +52,20 @@ docker-compose pull docker-compose up -d ``` +## Registering the Probe + +Fetch the generated public key: + +```shell +cat /var/atlas-probe/etc/probe_key.pub +``` + +[Register](https://atlas.ripe.net/apply/swprobe/) the probe with your public key. After the registration being manually processed, you'll see your new probe in your account. + ## Building +If you don't want to use the prebuilt image hosted on the Docker Hub, you can build your own image. + ```shell DOCKER_BUILDKIT=1 docker build -t ripe-atlas . ```