aboutsummaryrefslogtreecommitdiff
path: root/docs/Github_runner_setup.md
diff options
context:
space:
mode:
authorStefan Boberg <[email protected]>2024-03-12 17:25:20 +0000
committerGitHub Enterprise <[email protected]>2024-03-12 18:25:20 +0100
commiteea170ac33e81e1dba885526905e3709fbf2118e (patch)
tree8283a5b3ff934f60fffa0e0ef7b4e6f3ede309a5 /docs/Github_runner_setup.md
parenthttp request parser safety (#664) (diff)
downloadzen-eea170ac33e81e1dba885526905e3709fbf2118e.tar.xz
zen-eea170ac33e81e1dba885526905e3709fbf2118e.zip
workflow fixes (#1)
* update validate action for enterprise github * updated runner setup options * updated release workflow for enterprise github
Diffstat (limited to 'docs/Github_runner_setup.md')
-rw-r--r--docs/Github_runner_setup.md20
1 files changed, 13 insertions, 7 deletions
diff --git a/docs/Github_runner_setup.md b/docs/Github_runner_setup.md
index 6d949629d..42b2b1a01 100644
--- a/docs/Github_runner_setup.md
+++ b/docs/Github_runner_setup.md
@@ -2,14 +2,20 @@
## Windows
-See https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners for basic instructions.
+A Hyper-V "Quick Create" of a `Windows 11 dev environment` can give you a head start when setting up an instance for testing purposes. The following
+instructions should be sufficient to set up a completely clean Windows install.
-A Hyper-V "Quick Create" of a `Windows 11 dev environment` can give you a head start when setting up an instance for testing purposes.
-
-Beyond the basic install, I needed to:
-
-* Install git using `winget install git.git`
-* Install VS Pro using the instructions in [README.md](/README.md)
+* For Windows Server, some gymnastics are required to get `winget` installed
+ * run `irm winget.pro | iex` in an Administrator Powershell window to automate this process (see https://github.com/asheroto/winget-install for other options)
+* Install git using `winget install git.git` (alternate: https://git-scm.com/download/win)
+* Install VS Pro using winget by following the relevant instructions in [README.md](/README.md) (note: ONLY Visual Studio)
* Enable scripting using `Set-ExecutionPolicy -ExecutionPolicy Unrestricted` in an admin PowerShell instance
* In the same admin PowerShell instance, disable firewall with `netsh advfirewall set currentprofile state off` to allow tests to run without firewall popups (TODO: research better options here as this does not seem ideal)
+* See https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners for basic instructions on setting up the runner
* Remember to close the Terminal window after installing the above and open a new window to invoke `run.cmd`
+
+## Linux
+
+* Install docker (`sudo apt-get install docker.io`)
+ * Make sure runner user is allowed to use docker (add user to docker group using `sudo usermod -aG docker ${USER}` note that you will need to log out before running the runner script as this change is not applied directly)
+* Install development tools and utilities (`sudo apt install git build-essential curl zip unzip tar pkg-config`)