merith-tk/forgejo-runner
1
0
Fork 0
Code Issues Pull requests 2 Projects Releases Packages Wiki Activity Actions
forgejo-runner/examples/docker-compose/compose-forgejo-and-runner.yml

89 lines
2.9 KiB
YAML
Raw Normal View History

docker-compose example: documentation updates
2024-04-07 15:53:48 +01:00
# Copyright 2024 The Forgejo Authors.
example docker compose file and test
2023-08-24 11:28:17 +01:00
# SPDX-License-Identifier: MIT
document the secret and how it is different from the token
2023-09-04 17:19:15 +01:00
#
# Create a secret with:
#
# openssl rand -hex 20
#
# Replace all occurences of {SHARED_SECRET} below with the output.
remove rootless dockerfile, updatedate entrypoint, update docker compose Removed the rootless dockerfile as upon further investigation into how a `rootless` container works, the entrypoint that has been written fully accomodates that to reflect this the compose file has had the rootless config removed from it as it is no longer needed to test a seperate container image, added a debug echo function `decho` to the entrypoint, when `DEBUG=true` it will print "[entrypoint] message content" added a 10 second wait to the entrypoint to allow other services such as docker-in-docker and forgejo to finish launching before the runner is launched, this is bypassable by `SKIP_WAIT=true` applied several modifications requested by viceice,
2024-09-26 23:08:31 +01:00
#
document the secret and how it is different from the token
2023-09-04 17:19:15 +01:00
# NOTE: a token obtained from the Forgejo web interface cannot be used
# as a shared secret.
#
update entrypoint and dockerfile, fix test workflow update dockerfile, rework entrypoint execution, update compose and test
2024-09-25 23:21:53 +01:00
# Replace ${RUNNER_TOKEN} with the token obtained from the Forgejo web interface.
document the secret and how it is different from the token
2023-09-04 17:19:15 +01:00
#
push example docker-compose for runner and forgejo
2024-09-25 22:05:56 +01:00
networks:
forgejo:
Fix for using docker inside runner's container (#175) #153 Co-authored-by: zwanto <antoine.hamon@protonmail.com> Reviewed-on: https://code.forgejo.org/forgejo/runner/pulls/175 Reviewed-by: earl-warren <earl-warren@noreply.code.forgejo.org> Co-authored-by: zwanto <zwanto@noreply.code.forgejo.org> Co-committed-by: zwanto <zwanto@noreply.code.forgejo.org>
2024-04-07 17:07:00 +01:00
volumes:
docker_certs:
example docker compose file and test
2023-08-24 11:28:17 +01:00
services:
docker-in-docker:
Use `code.forgejo.org/oci` mirror images
2024-08-13 13:00:37 +01:00
image: code.forgejo.org/oci/docker:dind
remove rootless dockerfile, updatedate entrypoint, update docker compose Removed the rootless dockerfile as upon further investigation into how a `rootless` container works, the entrypoint that has been written fully accomodates that to reflect this the compose file has had the rootless config removed from it as it is no longer needed to test a seperate container image, added a debug echo function `decho` to the entrypoint, when `DEBUG=true` it will print "[entrypoint] message content" added a 10 second wait to the entrypoint to allow other services such as docker-in-docker and forgejo to finish launching before the runner is launched, this is bypassable by `SKIP_WAIT=true` applied several modifications requested by viceice,
2024-09-26 23:08:31 +01:00
# container_name: docker # Must set container_name to docker for both internal DNS and TLS to work
hostname: docker
Use forgejo mirror images
2024-08-13 07:37:52 +01:00
privileged: true
push example docker-compose for runner and forgejo
2024-09-25 22:05:56 +01:00
networks:
- forgejo
Fix for using docker inside runner's container (#175) #153 Co-authored-by: zwanto <antoine.hamon@protonmail.com> Reviewed-on: https://code.forgejo.org/forgejo/runner/pulls/175 Reviewed-by: earl-warren <earl-warren@noreply.code.forgejo.org> Co-authored-by: zwanto <zwanto@noreply.code.forgejo.org> Co-committed-by: zwanto <zwanto@noreply.code.forgejo.org>
2024-04-07 17:07:00 +01:00
environment:
remove rootless dockerfile, updatedate entrypoint, update docker compose Removed the rootless dockerfile as upon further investigation into how a `rootless` container works, the entrypoint that has been written fully accomodates that to reflect this the compose file has had the rootless config removed from it as it is no longer needed to test a seperate container image, added a debug echo function `decho` to the entrypoint, when `DEBUG=true` it will print "[entrypoint] message content" added a 10 second wait to the entrypoint to allow other services such as docker-in-docker and forgejo to finish launching before the runner is launched, this is bypassable by `SKIP_WAIT=true` applied several modifications requested by viceice,
2024-09-26 23:08:31 +01:00
DOCKER_TLS_CERTDIR: "/certs" # set to "" to disable the use of TLS, also manually update existing runner configs to use port 2375
Fix for using docker inside runner's container (#175) #153 Co-authored-by: zwanto <antoine.hamon@protonmail.com> Reviewed-on: https://code.forgejo.org/forgejo/runner/pulls/175 Reviewed-by: earl-warren <earl-warren@noreply.code.forgejo.org> Co-authored-by: zwanto <zwanto@noreply.code.forgejo.org> Co-committed-by: zwanto <zwanto@noreply.code.forgejo.org>
2024-04-07 17:07:00 +01:00
volumes:
- docker_certs:/certs
example docker compose file and test
2023-08-24 11:28:17 +01:00
forgejo:
upgrade docker-compose example Forgejo 1.21 & Forgejo runner 3.3.0
2023-12-04 20:33:21 +00:00
image: codeberg.org/forgejo/forgejo:1.21
remove rootless dockerfile, updatedate entrypoint, update docker compose Removed the rootless dockerfile as upon further investigation into how a `rootless` container works, the entrypoint that has been written fully accomodates that to reflect this the compose file has had the rootless config removed from it as it is no longer needed to test a seperate container image, added a debug echo function `decho` to the entrypoint, when `DEBUG=true` it will print "[entrypoint] message content" added a 10 second wait to the entrypoint to allow other services such as docker-in-docker and forgejo to finish launching before the runner is launched, this is bypassable by `SKIP_WAIT=true` applied several modifications requested by viceice,
2024-09-26 23:08:31 +01:00
hostname: forgejo
push example docker-compose for runner and forgejo
2024-09-25 22:05:56 +01:00
networks:
- forgejo
example docker compose file and test
2023-08-24 11:28:17 +01:00
volumes:
push example docker-compose for runner and forgejo
2024-09-25 22:05:56 +01:00
- ./forgejo:/data
example docker compose file and test
2023-08-24 11:28:17 +01:00
ports:
- 8080:3000
update entrypoint and dockerfile, fix test workflow update dockerfile, rework entrypoint execution, update compose and test
2024-09-25 23:21:53 +01:00
command: >-
bash -c '
/bin/s6-svscan /etc/s6 &
sleep 10 ;
remove rootless dockerfile, updatedate entrypoint, update docker compose Removed the rootless dockerfile as upon further investigation into how a `rootless` container works, the entrypoint that has been written fully accomodates that to reflect this the compose file has had the rootless config removed from it as it is no longer needed to test a seperate container image, added a debug echo function `decho` to the entrypoint, when `DEBUG=true` it will print "[entrypoint] message content" added a 10 second wait to the entrypoint to allow other services such as docker-in-docker and forgejo to finish launching before the runner is launched, this is bypassable by `SKIP_WAIT=true` applied several modifications requested by viceice,
2024-09-26 23:08:31 +01:00
su -c "forgejo admin user create --admin --username root --password examplepassword --email root@example.com" git ;
update entrypoint and dockerfile, fix test workflow update dockerfile, rework entrypoint execution, update compose and test
2024-09-25 23:21:53 +01:00
su -c "forgejo forgejo-cli actions register --secret {SHARED_SECRET}" git ;
sleep infinity
'
example docker compose file and test
2023-08-24 11:28:17 +01:00
remove rootless dockerfile, updatedate entrypoint, update docker compose Removed the rootless dockerfile as upon further investigation into how a `rootless` container works, the entrypoint that has been written fully accomodates that to reflect this the compose file has had the rootless config removed from it as it is no longer needed to test a seperate container image, added a debug echo function `decho` to the entrypoint, when `DEBUG=true` it will print "[entrypoint] message content" added a 10 second wait to the entrypoint to allow other services such as docker-in-docker and forgejo to finish launching before the runner is launched, this is bypassable by `SKIP_WAIT=true` applied several modifications requested by viceice,
2024-09-26 23:08:31 +01:00
# all values that have defaults listed are optional
# only FORGEJO_SECRET or RUNNER_TOKEN is required
# FORGEJO_URL is required if forgejo is in this compose file or docker network
push example docker-compose for runner and forgejo
2024-09-25 22:05:56 +01:00
forgejo-runner:
## TODO: Update image to the the release
## made from this PR: https://code.forgejo.org/forgejo/runner/pulls/283
remove rootless dockerfile, updatedate entrypoint, update docker compose Removed the rootless dockerfile as upon further investigation into how a `rootless` container works, the entrypoint that has been written fully accomodates that to reflect this the compose file has had the rootless config removed from it as it is no longer needed to test a seperate container image, added a debug echo function `decho` to the entrypoint, when `DEBUG=true` it will print "[entrypoint] message content" added a 10 second wait to the entrypoint to allow other services such as docker-in-docker and forgejo to finish launching before the runner is launched, this is bypassable by `SKIP_WAIT=true` applied several modifications requested by viceice,
2024-09-26 23:08:31 +01:00
# image: code.forgejo.org/forgejo/runner:3.4.1
build: ../../
# user: "1000" # set to run rootless, overrides RUNNER_USER and disables automatic file ownership
example docker compose file and test
2023-08-24 11:28:17 +01:00
volumes:
push example docker-compose for runner and forgejo
2024-09-25 22:05:56 +01:00
- ./forgejo-runner:/data
- docker_certs:/certs
networks:
- forgejo
depends_on:
example docker compose file and test
2023-08-24 11:28:17 +01:00
- docker-in-docker
- forgejo
environment:
remove rootless dockerfile, updatedate entrypoint, update docker compose Removed the rootless dockerfile as upon further investigation into how a `rootless` container works, the entrypoint that has been written fully accomodates that to reflect this the compose file has had the rootless config removed from it as it is no longer needed to test a seperate container image, added a debug echo function `decho` to the entrypoint, when `DEBUG=true` it will print "[entrypoint] message content" added a 10 second wait to the entrypoint to allow other services such as docker-in-docker and forgejo to finish launching before the runner is launched, this is bypassable by `SKIP_WAIT=true` applied several modifications requested by viceice,
2024-09-26 23:08:31 +01:00
CONFIG_FILE: config.yml # defaults to /data/config.yml
push example docker-compose for runner and forgejo
2024-09-25 22:05:56 +01:00
remove rootless dockerfile, updatedate entrypoint, update docker compose Removed the rootless dockerfile as upon further investigation into how a `rootless` container works, the entrypoint that has been written fully accomodates that to reflect this the compose file has had the rootless config removed from it as it is no longer needed to test a seperate container image, added a debug echo function `decho` to the entrypoint, when `DEBUG=true` it will print "[entrypoint] message content" added a 10 second wait to the entrypoint to allow other services such as docker-in-docker and forgejo to finish launching before the runner is launched, this is bypassable by `SKIP_WAIT=true` applied several modifications requested by viceice,
2024-09-26 23:08:31 +01:00
DOCKER_HOST: "docker" # defaults to docker
DOCKER_TLS_CERTDIR: "/certs/client" # defaults to /certs/client
DOCKER_TLS_VERIFY: "1" # defaults to 0, set to 1 to enable TLS
update entrypoint and dockerfile, fix test workflow update dockerfile, rework entrypoint execution, update compose and test
2024-09-25 23:21:53 +01:00
remove rootless dockerfile, updatedate entrypoint, update docker compose Removed the rootless dockerfile as upon further investigation into how a `rootless` container works, the entrypoint that has been written fully accomodates that to reflect this the compose file has had the rootless config removed from it as it is no longer needed to test a seperate container image, added a debug echo function `decho` to the entrypoint, when `DEBUG=true` it will print "[entrypoint] message content" added a 10 second wait to the entrypoint to allow other services such as docker-in-docker and forgejo to finish launching before the runner is launched, this is bypassable by `SKIP_WAIT=true` applied several modifications requested by viceice,
2024-09-26 23:08:31 +01:00
FORGEJO_URL: ${FORGEJO_URL} # defaults to http://forgejo:3000
FORGEJO_SECRET: "{SHARED_SECRET}" # shared secret, must match Forgejo's, overrides RUNNER_TOKEN
update entrypoint and dockerfile, fix test workflow update dockerfile, rework entrypoint execution, update compose and test
2024-09-25 23:21:53 +01:00
remove rootless dockerfile, updatedate entrypoint, update docker compose Removed the rootless dockerfile as upon further investigation into how a `rootless` container works, the entrypoint that has been written fully accomodates that to reflect this the compose file has had the rootless config removed from it as it is no longer needed to test a seperate container image, added a debug echo function `decho` to the entrypoint, when `DEBUG=true` it will print "[entrypoint] message content" added a 10 second wait to the entrypoint to allow other services such as docker-in-docker and forgejo to finish launching before the runner is launched, this is bypassable by `SKIP_WAIT=true` applied several modifications requested by viceice,
2024-09-26 23:08:31 +01:00
RUNNER_FILE: .runner # defaults to /data/runner.json
RUNNER_NAME: forgejo-runner # defaults to forgejo-runner, used for registration
RUNNER_TOKEN: "${RUNNER_TOKEN}"
RUNNER_USER: 1000 # defaults to 1000, allows for automatic file ownership
update entrypoint and dockerfile, fix test workflow update dockerfile, rework entrypoint execution, update compose and test
2024-09-25 23:21:53 +01:00
remove rootless dockerfile, updatedate entrypoint, update docker compose Removed the rootless dockerfile as upon further investigation into how a `rootless` container works, the entrypoint that has been written fully accomodates that to reflect this the compose file has had the rootless config removed from it as it is no longer needed to test a seperate container image, added a debug echo function `decho` to the entrypoint, when `DEBUG=true` it will print "[entrypoint] message content" added a 10 second wait to the entrypoint to allow other services such as docker-in-docker and forgejo to finish launching before the runner is launched, this is bypassable by `SKIP_WAIT=true` applied several modifications requested by viceice,
2024-09-26 23:08:31 +01:00
DEBUG: "true" # defaults to false, set to true to enable debug logging
SKIP_WAIT: "false" # defaults to false, set to true to skip the 10 second wait to allow for forgejo and docker-in-docker to start
Reference in a new issue Copy permalink