From 8c5aaf7ea3fcdf25bd1bd48424aeba81016df41f Mon Sep 17 00:00:00 2001 From: mborne Date: Mon, 15 Jul 2024 13:36:18 +0200 Subject: [PATCH] docs: document the use of the docker image --- README.md | 6 +++++- docs/docker.md | 2 ++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6bfb92f..5afe760 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 diff --git a/docs/docker.md b/docs/docker.md index e48761d..2c1a008 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -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 . ```