From 8a2e0ea320b8901121d85ff7fde62c89d935f8ef Mon Sep 17 00:00:00 2001 From: Marin Minnerly Date: Tue, 5 Mar 2024 14:20:06 -0800 Subject: [PATCH] Update README --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f65febb..45786d1 100644 --- a/README.md +++ b/README.md @@ -30,15 +30,15 @@ If not specified the root job folder will be used. #### `allow-external-github-orgs` (optional) A boolean value to allow external github orgs in the foreman manifest file. -#### `github-api-url` (optional) +If not specified, external github orgs will not be allowed. +#### `github-api-url` (optional) Override for the GitHub API URL. By default GitHub Actions will supply this value as the current environment, which will usually be `https://api.github.com`. -You shouldn't need to change unless working in GitHub Enterprise or a similar -self-hosted environment. +This parameter exists primarily to allow GitHub Enterprise to point back to +GitHub Cloud to install publicly hosted tools. -If not specified, external github orgs will not be allowed. ## License setup-foreman is available under the MIT license. See [LICENSE.txt](LICENSE.txt) or for details.