Skip to content

Commit f27b0b2

Browse files
docs: update README.md
1 parent 3feb924 commit f27b0b2

1 file changed

Lines changed: 9 additions & 7 deletions

File tree

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,45 @@
11
# docker-sourceknight
22

3-
[![Actions Status](https://github.com/srcdslab/docker-sourceknight/workflows/Release/badge.svg)](https://github.com/srcdslab/docker-sourceknight/actions)
4-
53
This repository defines the unofficial [sourceknight](https://github.com/tmick0/sourceknight) docker image.
64

75
* [python 3.10-slim](python/3.10-slim)
86

9-
which are published to [ghcr.io](https://github.com/srcdslab/docker-sourceknight/pkgs/container/sourceknight).
7+
which are published to [ghcr.io](https://github.com/srcdslab/docker-sourceknight/pkgs/container/docker-sourceknight).
108

119

1210
__note__ - requires latest docker to be installed and available
1311

1412
## Using Images
1513

14+
We have two versions of the sourceknight image:
15+
- `root` mainly used for github actions
16+
- `rootless` mainly used to compile locally
17+
1618
### pull docker image
1719

1820
```bash
19-
docker pull ghcr.io/srcdslab/sourceknight:latest
21+
docker pull ghcr.io/srcdslab/docker-sourceknight:0.3.0-rootless
2022
```
2123

2224
### run docker image
2325

2426
```bash
2527
docker run --rm \
26-
ghcr.io/srcdslab/sourceknight:latest \
28+
ghcr.io/srcdslab/docker-sourceknight:0.3.0-rootless \
2729
--help
2830
```
2931

3032
### build plugins
3133
```bash
3234
docker run --rm \
3335
-v $PWD:/app \
34-
ghcr.io/srcdslab/sourceknight:latest \
36+
ghcr.io/srcdslab/docker-sourceknight:0.3.0-rootless \
3537
build
3638
```
3739

3840
### building docker image
3941

4042
```bash
4143
export SOURCEKNIGHT_VERSION="0.3.0"
42-
docker build --build-arg SOURCEKNIGHT_VERSION=$SOURCEKNIGHT_VERSION -t sourceknight:$SOURCEKNIGHT_VERSION python/3.10-slim
44+
docker build --build-arg SOURCEKNIGHT_VERSION=$SOURCEKNIGHT_VERSION -t sourceknight:$SOURCEKNIGHT_VERSION python/3.10-slim --target rootless
4345
```

0 commit comments

Comments
 (0)