From e4e7917eb3390eed77f30c2faecfd765d6d31bd5 Mon Sep 17 00:00:00 2001 From: Earl Warren Date: Tue, 25 Feb 2025 11:05:19 +0000 Subject: [PATCH] chore(docs): warning about the docker-compose example purpose (#489) Fixes forgejo/runner#484 Reviewed-on: https://code.forgejo.org/forgejo/runner/pulls/489 Reviewed-by: Michael Kriese Co-authored-by: Earl Warren Co-committed-by: Earl Warren --- examples/docker-compose/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/examples/docker-compose/README.md b/examples/docker-compose/README.md index ccb0f72..104a8fe 100644 --- a/examples/docker-compose/README.md +++ b/examples/docker-compose/README.md @@ -1,5 +1,7 @@ ## Docker compose with docker-in-docker +> **Warning** this example is just what it is: an example. It is not fit to be used in production. It shows how Forgejo, the Forgejo runner can work together with Docker in Docker. It is [tested to work in the CI](../../.forgejo/workflows/example-docker-compose.yml) and is best used as a reference, a source of inspiration. + The `compose-forgejo-and-runner.yml` compose file runs a Forgejo instance and registers a `Forgejo runner`. A docker server is also launched within a container (using