From 2dcdf049a83b58db729571f2d8337b2195f339a6 Mon Sep 17 00:00:00 2001 From: Bryan MacFarlane Date: Wed, 12 Feb 2020 09:26:59 -0500 Subject: [PATCH] proxy guidance --- README.md | 6 ++++++ docs/proxy-support.md | 10 ++++++++++ 2 files changed, 16 insertions(+) create mode 100644 docs/proxy-support.md diff --git a/README.md b/README.md index a4ec4b70..c58f1b13 100644 --- a/README.md +++ b/README.md @@ -92,6 +92,12 @@ Problem Matchers are a way to scan the output of actions for a specified regex p

+:warning: [Proxy Server Support](docs/proxy-support.md) + +Self-hosted runners can be configured to run behind proxy servers. +
+
+

Hello World JavaScript Action

Illustrates how to create a simple hello world javascript action. diff --git a/docs/proxy-support.md b/docs/proxy-support.md new file mode 100644 index 00000000..b00ef0a3 --- /dev/null +++ b/docs/proxy-support.md @@ -0,0 +1,10 @@ +# Proxy Server Support + +Self-hosted runners [can be configured](https://help.github.com/en/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners) to run behind a proxy server in enterprises. + +For actions to **just work** behind a proxy server: + + 1. Use [tool-cache] version >= 1.3.1 + 2. Optionally use [actions/http-client](https://github.com/actions/http-client) + +If you are using other http clients, refer to the [environment variables set by the runner](https://help.github.com/en/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners). \ No newline at end of file