From d563fa318411b3e631b030adc88bfc7fae744e8e Mon Sep 17 00:00:00 2001 From: Andy Dunstall Date: Fri, 14 Jun 2024 07:39:42 +0100 Subject: [PATCH] docs: link to server/agent docs --- docs/how-piko-works.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/how-piko-works.md b/docs/how-piko-works.md index 7db70ab..f33ed71 100644 --- a/docs/how-piko-works.md +++ b/docs/how-piko-works.md @@ -2,17 +2,17 @@ This document provides an overview of how Piko works. -The Piko server is a HTTP(S) reverse proxy that forwards requests to upstream -listeners. Unlike a traditional reverse proxy, Piko never opens a connection -directly to your upstream. Instead upstreams listeners open outbound-only -connections to the server and listen on a particular endpoint. The server then -forwards requests to a listening upstream via its outbound connection to the -server. +The [Piko server](./server/server.md) is a HTTP(S) reverse proxy that forwards +requests to upstream listeners. Unlike a traditional reverse proxy, Piko never +opens a connection directly to your upstream. Instead upstreams listeners open +outbound-only connections to the server and listen on a particular endpoint. +The server then forwards requests to a listening upstream via its outbound +connection to the server. This means upstreams can run anywhere without requiring a public route, as long as they can open a connection to the Piko server. -You can create an upstream listener using the Piko agent. +You can create an upstream listener using the [Piko agent](./agent/agent.md). ## Upstream