Skip to content

Commit

Permalink
docs: document the use of the docker image
Browse files Browse the repository at this point in the history
  • Loading branch information
mborne committed Jul 15, 2024
1 parent 6389e2c commit 8c5aaf7
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ bin/satis-gitlab gitlab-to-config https://github.com $SATIS_GITHUB_TOKEN --orgs
bin/satis-gitlab build --skip-errors satis.json web
```

(Note that GITHUB_TOKEN is required to avoid rate request limitation)
(Note that SATIS_GITHUB_TOKEN is required to avoid rate request limitation)


### Mirror dependencies
Expand Down Expand Up @@ -123,6 +123,10 @@ Some command line options provide a basic customization options. You may also us

[default-template.json](src/MBO/SatisGitlab/Resources/default-template.json)

## Usage with docker

See [docs/docker.md](docs/docker.md).

## Testing

```bash
Expand Down
2 changes: 2 additions & 0 deletions docs/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Provide a docker image for satis-gitlab to :

## Build image

> Alternative : use [ghcr.io/mborne/satis-gitlab:master](https://github.com/mborne/satis-gitlab/pkgs/container/satis-gitlab) instead of satis-gitlab bellow.
```bash
docker build -t satis-gitlab .
```
Expand Down

0 comments on commit 8c5aaf7

Please sign in to comment.