Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
maxime1907 committed Jul 19, 2023
1 parent 3feb924 commit f27b0b2
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,45 @@
# 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
```

### build plugins
```bash
docker run --rm \
-v $PWD:/app \
ghcr.io/srcdslab/sourceknight:latest \
ghcr.io/srcdslab/docker-sourceknight:0.3.0-rootless \
build
```

### building docker image

```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
```

0 comments on commit f27b0b2

Please sign in to comment.