From 3585ba6a24b62c1104eb4a66ae583de4c3b5dc01 Mon Sep 17 00:00:00 2001 From: Mike Ryan Date: Tue, 27 Aug 2024 12:48:19 -0500 Subject: [PATCH] update readme --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f9304e0e..bfbbb1a6 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,11 @@ GitHub Action to run Renovate self-hosted. - [`configurationFile`](#configurationfile) - [`docker-cmd-file`](#docker-cmd-file) - [`docker-network`](#docker-network) + - [`docker-socket-host-path`](#docker-socket-host-path) - [`docker-user`](#docker-user) - [`docker-volumes`](#docker-volumes) - [`env-regex`](#env-regex) - [`mount-docker-socket`](#mount-docker-socket) - - [`docker-socket-host-path`](#docker-socket-host-path) - [`token`](#token) - [`renovate-image`](#renovate-image) - [`renovate-version`](#renovate-version) @@ -114,6 +114,12 @@ Specify a network to run container in. You can use `${{ job.container.network }}` to run renovate container [in the same network as other containers for this job](https://docs.github.com/en/actions/learn-github-actions/contexts#job-context), or set it to `host` to run in the same network as github runner, or specify any custom network. +### `docker-socket-host-path` + +Allows the overriding of the host path for the Docker socket that is mounted into the container. +Useful on systems where the host Docker socket is located somewhere other than `/var/run/docker.sock` (the default). +Only applicable when `mount-docker-socket` is true. + ### `docker-user` Specify a user (or user-id) to run docker command. @@ -158,12 +164,6 @@ inside the renovate container so that the commands can use Docker. Can be useful for `postUpgradeTasks`'s commands. Also add the user inside the renovate container to the docker group for socket permissions. -## `docker-socket-host-path` - -Allows the overriding of the host path for the Docker socket that is mounted into the container. -Useful on systems where the host Docker socket is located somewhere other than `/var/run/docker.sock` (the default). -Only applicable when `mount-docker-socket` is true. - ### `token` [Generate a Personal Access Token (classic)](https://github.com/settings/tokens), with the `repo:public_repo` scope for only public repositories or the `repo` scope for public and private repositories, and add it to _Secrets_ (repository settings) as `RENOVATE_TOKEN`.