docs(readme): update

This commit is contained in:
2025-06-10 09:55:08 -07:00
parent fb106a1499
commit 05319b3860

View File

@@ -389,7 +389,7 @@ This repository offers two types of docker image; `stable` and `development`. Yo
| Build | Tags | | Build | Tags |
| ------------------------- | ----------------------------------------------------------------------------- | | ------------------------- | ----------------------------------------------------------------------------- |
| `Stable` | `🔖 tvapp2:latest` <br /> `🔖 tvapp2:1.5.2` <br /> `🔖 tvapp2:1.5` <br /> `🔖 tvapp2:1` | | `Stable` | `🔖 tvapp2:latest` <br /> `🔖 tvapp2:1.5.3` <br /> `🔖 tvapp2:1.5` <br /> `🔖 tvapp2:1` |
| `Development` | `🔖 tvapp2:development` | | `Development` | `🔖 tvapp2:development` |
<br /> <br />
@@ -601,10 +601,10 @@ Creates the TVApp2 `amd64` docker image:
# Build tvapp2 amd64 # Build tvapp2 amd64
docker buildx build \ docker buildx build \
--build-arg ARCH=amd64 \ --build-arg ARCH=amd64 \
--build-arg VERSION=1.5.2 \ --build-arg VERSION=1.5.3 \
--build-arg BUILDDATE=20260812 \ --build-arg BUILDDATE=20260812 \
--build-arg RELEASE=stable \ --build-arg RELEASE=stable \
--tag ghcr.io/thebinaryninja/tvapp2:1.5.2 \ --tag ghcr.io/thebinaryninja/tvapp2:1.5.3 \
--tag ghcr.io/thebinaryninja/tvapp2:1.5 \ --tag ghcr.io/thebinaryninja/tvapp2:1.5 \
--tag ghcr.io/thebinaryninja/tvapp2:1 \ --tag ghcr.io/thebinaryninja/tvapp2:1 \
--tag ghcr.io/thebinaryninja/tvapp2:latest \ --tag ghcr.io/thebinaryninja/tvapp2:latest \
@@ -631,10 +631,10 @@ Creates the TVApp2 `arm64` docker image:
# Build tvapp2 arm64 # Build tvapp2 arm64
docker buildx build \ docker buildx build \
--build-arg ARCH=arm64 \ --build-arg ARCH=arm64 \
--build-arg VERSION=1.5.2 \ --build-arg VERSION=1.5.3 \
--build-arg BUILDDATE=20260812 \ --build-arg BUILDDATE=20260812 \
--build-arg RELEASE=stable \ --build-arg RELEASE=stable \
--tag ghcr.io/thebinaryninja/tvapp2:1.5.2 \ --tag ghcr.io/thebinaryninja/tvapp2:1.5.3 \
--tag ghcr.io/thebinaryninja/tvapp2:1.5 \ --tag ghcr.io/thebinaryninja/tvapp2:1.5 \
--tag ghcr.io/thebinaryninja/tvapp2:1 \ --tag ghcr.io/thebinaryninja/tvapp2:1 \
--tag ghcr.io/thebinaryninja/tvapp2:latest \ --tag ghcr.io/thebinaryninja/tvapp2:latest \
@@ -765,8 +765,8 @@ docker run --privileged --rm tonistiigi/binfmt --install all
Once the emulator is installed; we will now build two images. When building these two images; we will ensure the `--tag` value is different for each one, by adding the architecture to the end. This ensures we don't overwrite one image with the newer one. We need to have two seperate docker images with two different tags. Once the emulator is installed; we will now build two images. When building these two images; we will ensure the `--tag` value is different for each one, by adding the architecture to the end. This ensures we don't overwrite one image with the newer one. We need to have two seperate docker images with two different tags.
- `--tag ghcr.io/thebinaryninja/tvapp2:1.5.2-amd64` - `--tag ghcr.io/thebinaryninja/tvapp2:1.5.3-amd64`
- `--tag ghcr.io/thebinaryninja/tvapp2:1.5.2-arm64` - `--tag ghcr.io/thebinaryninja/tvapp2:1.5.3-arm64`
<br /> <br />
@@ -777,10 +777,10 @@ Once the emulator is installed; we will now build two images. When building thes
> >
> | Registry | Tag | > | Registry | Tag |
> | --- | --- | > | --- | --- |
> | Dockerhub | `--tag thebinaryninja/tvapp2:1.5.2-amd64`<br>`--tag thebinaryninja/tvapp2:1.5.2-arm64` | > | Dockerhub | `--tag thebinaryninja/tvapp2:1.5.3-amd64`<br>`--tag thebinaryninja/tvapp2:1.5.3-arm64` |
> | Github (GHCR) | `--tag ghcr.io/thebinaryninja/tvapp2:1.5.2-amd64`<br>`--tag ghcr.io/thebinaryninja/tvapp2:1.5.2-arm64` | > | Github (GHCR) | `--tag ghcr.io/thebinaryninja/tvapp2:1.5.3-amd64`<br>`--tag ghcr.io/thebinaryninja/tvapp2:1.5.3-arm64` |
> | Registry v2 | `--tag registry.domain.lan/thebinaryninja/tvapp2:1.5.2-amd64`<br>`--tag registry.domain.lan/thebinaryninja/tvapp2:1.5.2-arm64` | > | Registry v2 | `--tag registry.domain.lan/thebinaryninja/tvapp2:1.5.3-amd64`<br>`--tag registry.domain.lan/thebinaryninja/tvapp2:1.5.3-arm64` |
> | Gitea | `--tag git.binaryninja.net/binaryninja/tvapp2:1.5.2-amd64`<br>`--tag git.binaryninja.net/binaryninja/tvapp2:1.5.2-arm64` | > | Gitea | `--tag git.binaryninja.net/binaryninja/tvapp2:1.5.3-amd64`<br>`--tag git.binaryninja.net/binaryninja/tvapp2:1.5.3-arm64` |
<br /> <br />
@@ -801,10 +801,10 @@ Creates the TVApp2 **Stable** release `amd64` docker image:
# Build Tvapp2 amd64 - (stable release) # Build Tvapp2 amd64 - (stable release)
docker buildx build \ docker buildx build \
--build-arg ARCH=amd64 \ --build-arg ARCH=amd64 \
--build-arg VERSION=1.5.2 \ --build-arg VERSION=1.5.3 \
--build-arg BUILDDATE=20260812 \ --build-arg BUILDDATE=20260812 \
--build-arg RELEASE=stable \ --build-arg RELEASE=stable \
--tag ghcr.io/thebinaryninja/tvapp2:1.5.2-amd64 \ --tag ghcr.io/thebinaryninja/tvapp2:1.5.3-amd64 \
--attest type=provenance,disabled=true \ --attest type=provenance,disabled=true \
--attest type=sbom,disabled=true \ --attest type=sbom,disabled=true \
--output type=docker \ --output type=docker \
@@ -829,10 +829,10 @@ Creates the TVApp2 **Stable** release `arm64` docker image:
# Build Tvapp2 arm64 - (stable release) # Build Tvapp2 arm64 - (stable release)
docker buildx build \ docker buildx build \
--build-arg ARCH=arm64 \ --build-arg ARCH=arm64 \
--build-arg VERSION=1.5.2 \ --build-arg VERSION=1.5.3 \
--build-arg BUILDDATE=20260812 \ --build-arg BUILDDATE=20260812 \
--build-arg RELEASE=stable \ --build-arg RELEASE=stable \
--tag ghcr.io/thebinaryninja/tvapp2:1.5.2-arm64 \ --tag ghcr.io/thebinaryninja/tvapp2:1.5.3-arm64 \
--attest type=provenance,disabled=true \ --attest type=provenance,disabled=true \
--attest type=sbom,disabled=true \ --attest type=sbom,disabled=true \
--output type=docker \ --output type=docker \
@@ -857,7 +857,7 @@ Creates the TVApp2 **Development** release `amd64` docker image:
# Build Tvapp2 amd64 - (development release) # Build Tvapp2 amd64 - (development release)
docker buildx build \ docker buildx build \
--build-arg ARCH=amd64 \ --build-arg ARCH=amd64 \
--build-arg VERSION=1.5.2 \ --build-arg VERSION=1.5.3 \
--build-arg BUILDDATE=20260812 \ --build-arg BUILDDATE=20260812 \
--build-arg RELEASE=development \ --build-arg RELEASE=development \
--tag ghcr.io/thebinaryninja/tvapp2:development-amd64 \ --tag ghcr.io/thebinaryninja/tvapp2:development-amd64 \
@@ -885,7 +885,7 @@ Creates the TVApp2 **Development** release `arm64` docker image:
# Build Tvapp2 arm64 - (development release) # Build Tvapp2 arm64 - (development release)
docker buildx build \ docker buildx build \
--build-arg ARCH=arm64 \ --build-arg ARCH=arm64 \
--build-arg VERSION=1.5.2 \ --build-arg VERSION=1.5.3 \
--build-arg BUILDDATE=20260812 \ --build-arg BUILDDATE=20260812 \
--build-arg RELEASE=development \ --build-arg RELEASE=development \
--tag ghcr.io/thebinaryninja/tvapp2:development-arm64 \ --tag ghcr.io/thebinaryninja/tvapp2:development-arm64 \
@@ -907,8 +907,8 @@ docker buildx build \
After completing the `docker buildx` commands above; you should now have a few new images. Each image should have its own separate docker tags which do not conflict. If you decided to not build the **development** releases below; that is fine. After completing the `docker buildx` commands above; you should now have a few new images. Each image should have its own separate docker tags which do not conflict. If you decided to not build the **development** releases below; that is fine.
- `--tag ghcr.io/thebinaryninja/tvapp2:1.5.2-amd64` - `--tag ghcr.io/thebinaryninja/tvapp2:1.5.3-amd64`
- `--tag ghcr.io/thebinaryninja/tvapp2:1.5.2-arm64` - `--tag ghcr.io/thebinaryninja/tvapp2:1.5.3-arm64`
- `--tag ghcr.io/thebinaryninja/tvapp2:development-amd64` - `--tag ghcr.io/thebinaryninja/tvapp2:development-amd64`
- `--tag ghcr.io/thebinaryninja/tvapp2:development-arm64` - `--tag ghcr.io/thebinaryninja/tvapp2:development-arm64`
@@ -934,15 +934,15 @@ You can also get the hash digests by running the commands:
<br /> <br />
```shell ```shell
$ docker buildx imagetools inspect ghcr.io/thebinaryninja/tvapp2:1.5.2-amd64 $ docker buildx imagetools inspect ghcr.io/thebinaryninja/tvapp2:1.5.3-amd64
Name: ghcr.io/thebinaryninja/tvapp2:1.5.2-amd64 Name: ghcr.io/thebinaryninja/tvapp2:1.5.3-amd64
MediaType: application/vnd.docker.distribution.manifest.v2+json MediaType: application/vnd.docker.distribution.manifest.v2+json
Digest: sha256:0abe1b1c119959b3b1ccc23c56a7ee2c4c908c6aaef290d4ab2993859d807a3b Digest: sha256:0abe1b1c119959b3b1ccc23c56a7ee2c4c908c6aaef290d4ab2993859d807a3b
$ docker buildx imagetools inspect ghcr.io/thebinaryninja/tvapp2:1.5.2-arm64 $ docker buildx imagetools inspect ghcr.io/thebinaryninja/tvapp2:1.5.3-arm64
Name: ghcr.io/thebinaryninja/tvapp2:1.5.2-arm64 Name: ghcr.io/thebinaryninja/tvapp2:1.5.3-arm64
MediaType: application/vnd.docker.distribution.manifest.v2+json MediaType: application/vnd.docker.distribution.manifest.v2+json
Digest: sha256:e68b9de8669eac64d4e4d2a8343c56705e05e9a907cf0b542343f9b536d9c473 Digest: sha256:e68b9de8669eac64d4e4d2a8343c56705e05e9a907cf0b542343f9b536d9c473
``` ```
@@ -989,14 +989,14 @@ Digest: sha256:c719ccb034946e3f0625003f25026d001768794e38a1ba8aafc9146291d548
> ```shell > ```shell
> $ docker images --all --no-trunc | grep thebinaryninja > $ docker images --all --no-trunc | grep thebinaryninja
> >
> ghcr.io/thebinaryninja/tvapp2 1.5.2-arm64 sha256:48520ca15fed6483d2d5b79993126c311f833002345b0e12b8eceb5bf9def966 42 minutes ago 46MB > ghcr.io/thebinaryninja/tvapp2 1.5.3-arm64 sha256:48520ca15fed6483d2d5b79993126c311f833002345b0e12b8eceb5bf9def966 42 minutes ago 46MB
> >
> ghcr.io/thebinaryninja/tvapp2 1.5.2-amd64 sha256:54a9b7d390199532d5667fae67120d77e2f459bd6108b27ce94e0cfec8f3c41f 43 minutes ago 45MB > ghcr.io/thebinaryninja/tvapp2 1.5.3-amd64 sha256:54a9b7d390199532d5667fae67120d77e2f459bd6108b27ce94e0cfec8f3c41f 43 minutes ago 45MB
> ``` > ```
> >
> To get the correct sha256 digest, use: > To get the correct sha256 digest, use:
> - `docker buildx imagetools inspect ghcr.io/thebinaryninja/tvapp2:1.5.2-amd64` > - `docker buildx imagetools inspect ghcr.io/thebinaryninja/tvapp2:1.5.3-amd64`
> - `docker buildx imagetools inspect ghcr.io/thebinaryninja/tvapp2:1.5.2-arm64` > - `docker buildx imagetools inspect ghcr.io/thebinaryninja/tvapp2:1.5.3-arm64`
> - `docker buildx imagetools inspect ghcr.io/thebinaryninja/tvapp2:development-amd64` > - `docker buildx imagetools inspect ghcr.io/thebinaryninja/tvapp2:development-amd64`
> - `docker buildx imagetools inspect ghcr.io/thebinaryninja/tvapp2:development-arm64` > - `docker buildx imagetools inspect ghcr.io/thebinaryninja/tvapp2:development-arm64`
> >
@@ -1016,7 +1016,7 @@ For the **stable** releases, use:
# # # #
docker buildx imagetools create \ docker buildx imagetools create \
--tag ghcr.io/thebinaryninja/tvapp2:1.5.2 \ --tag ghcr.io/thebinaryninja/tvapp2:1.5.3 \
--tag ghcr.io/thebinaryninja/tvapp2:1.5 \ --tag ghcr.io/thebinaryninja/tvapp2:1.5 \
--tag ghcr.io/thebinaryninja/tvapp2:1 \ --tag ghcr.io/thebinaryninja/tvapp2:1 \
--tag ghcr.io/thebinaryninja/tvapp2:latest \ --tag ghcr.io/thebinaryninja/tvapp2:latest \
@@ -1027,7 +1027,7 @@ docker buildx imagetools create \
=> [internal] pushing ghcr.io/thebinaryninja/tvapp2:latest 0.2s => [internal] pushing ghcr.io/thebinaryninja/tvapp2:latest 0.2s
=> [internal] pushing ghcr.io/thebinaryninja/tvapp2:1 0.2s => [internal] pushing ghcr.io/thebinaryninja/tvapp2:1 0.2s
=> [internal] pushing ghcr.io/thebinaryninja/tvapp2:1.5 0.2s => [internal] pushing ghcr.io/thebinaryninja/tvapp2:1.5 0.2s
=> [internal] pushing ghcr.io/thebinaryninja/tvapp2:1.5.2 0.2s => [internal] pushing ghcr.io/thebinaryninja/tvapp2:1.5.3 0.2s
``` ```
<br /> <br />
@@ -1073,8 +1073,8 @@ In this example, we take the existing two files we created earlier, and merge th
```shell ```shell
# Example 1 (using tag) # Example 1 (using tag)
docker manifest create ghcr.io/thebinaryninja/tvapp2:latest \ docker manifest create ghcr.io/thebinaryninja/tvapp2:latest \
--amend ghcr.io/thebinaryninja/tvapp2:1.5.2-amd64 \ --amend ghcr.io/thebinaryninja/tvapp2:1.5.3-amd64 \
--amend ghcr.io/thebinaryninja/tvapp2:1.5.2-arm64 --amend ghcr.io/thebinaryninja/tvapp2:1.5.3-arm64
# Example 2 (using sha256 hash) # Example 2 (using sha256 hash)
docker manifest create ghcr.io/thebinaryninja/tvapp2:latest \ docker manifest create ghcr.io/thebinaryninja/tvapp2:latest \
@@ -1115,7 +1115,7 @@ To build the project, `🗔 cd` into the project folder and run the build comman
```shell ```shell
cd /home/docker/tvapp2/ cd /home/docker/tvapp2/
npm run docker:build:amd64 --VERSION=1.5.2 --BUILDDATE=20260812 npm run docker:build:amd64 --VERSION=1.5.3 --BUILDDATE=20260812
``` ```
<br /> <br />