From f27b0b27e2213f8fcf0ad289b2e0c15d712cb7c3 Mon Sep 17 00:00:00 2001 From: maxime1907 <19607336+maxime1907@users.noreply.github.com> Date: Wed, 19 Jul 2023 22:47:07 +0200 Subject: [PATCH] docs: update README.md --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5deec39..26d2b2b 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,31 @@ # docker-sourceknight -[![Actions Status](https://github.com/srcdslab/docker-sourceknight/workflows/Release/badge.svg)](https://github.com/srcdslab/docker-sourceknight/actions) - This repository defines the unofficial [sourceknight](https://github.com/tmick0/sourceknight) docker image. * [python 3.10-slim](python/3.10-slim) -which are published to [ghcr.io](https://github.com/srcdslab/docker-sourceknight/pkgs/container/sourceknight). +which are published to [ghcr.io](https://github.com/srcdslab/docker-sourceknight/pkgs/container/docker-sourceknight). __note__ - requires latest docker to be installed and available ## Using Images +We have two versions of the sourceknight image: +- `root` mainly used for github actions +- `rootless` mainly used to compile locally + ### pull docker image ```bash -docker pull ghcr.io/srcdslab/sourceknight:latest +docker pull ghcr.io/srcdslab/docker-sourceknight:0.3.0-rootless ``` ### run docker image ```bash docker run --rm \ - ghcr.io/srcdslab/sourceknight:latest \ + ghcr.io/srcdslab/docker-sourceknight:0.3.0-rootless \ --help ``` @@ -31,7 +33,7 @@ docker run --rm \ ```bash docker run --rm \ -v $PWD:/app \ - ghcr.io/srcdslab/sourceknight:latest \ + ghcr.io/srcdslab/docker-sourceknight:0.3.0-rootless \ build ``` @@ -39,5 +41,5 @@ docker run --rm \ ```bash export SOURCEKNIGHT_VERSION="0.3.0" -docker build --build-arg SOURCEKNIGHT_VERSION=$SOURCEKNIGHT_VERSION -t sourceknight:$SOURCEKNIGHT_VERSION python/3.10-slim +docker build --build-arg SOURCEKNIGHT_VERSION=$SOURCEKNIGHT_VERSION -t sourceknight:$SOURCEKNIGHT_VERSION python/3.10-slim --target rootless ```