about summary refs log tree commit diff
diff options
context:
space:
mode:
authorgennyble <gen@nyble.dev>2025-03-11 17:34:44 -0500
committergennyble <gen@nyble.dev>2025-03-11 17:34:44 -0500
commit098a0ae0b666e23c1e3c54fa6f87c01170471535 (patch)
treefb1759b06516c0138903f85e4cda234c54dca740
parent110c56b72d54770962dd41ac0f12b350cf47754f (diff)
downloadcorgi-098a0ae0b666e23c1e3c54fa6f87c01170471535.tar.gz
corgi-098a0ae0b666e23c1e3c54fa6f87c01170471535.zip
add currently set envvars to readme
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md
index 09b2e8c..3b6b0df 100644
--- a/README.md
+++ b/README.md
@@ -8,4 +8,12 @@ Script <path-to-cgi-script>
 	Environment
 		HTTP_HOST <hostname>
 		ENV_KEY <some-env-value>
-```
\ No newline at end of file
+```
+
+Sets the following environmental variables for the CGI script, many following [RFC 3875][rfc]:
+- **`GATEWAY_INTERFACE`** to the fixed value `CGI/1.1`
+- **`PATH_INFO`** to the HTTP path the client requested
+- **`QUERY_STRING`** to the query part of the URI
+- **`REQUEST_METHOD`** to the HTTP request method
+
+[rfc]: https://datatracker.ietf.org/doc/html/rfc3875
\ No newline at end of file