From 4e722b47b56e133dc3206d44cf529b33f4939ebc Mon Sep 17 00:00:00 2001 From: KernelDeimos Date: Wed, 3 Apr 2024 22:11:52 -0400 Subject: [PATCH] Document pub_port, which wasn't documented before --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index b83e90954..4f21f8770 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,10 @@ Puter is an advanced, open-source internet operating system designed to be featu ## Getting Started +After reading this section, please proceed to **Self-Hosting** and **Configuration** below. +Read these instructions carefully or you may see errors due to +an invalid setup. + ### Local Development ```bash @@ -71,6 +75,8 @@ See [Configuration](#configuration) for next steps. ## ⚠️ Self-Hosting ⚠️ The self-hosted version of Puter is currently in alpha stage and should not be used in production yet. It is under active development and may contain bugs, other issues. Please exercise caution and use it for testing and evaluation purposes only. +
+ ## Configuration Running the server will generate a configuration file in one of these locations: @@ -91,6 +97,12 @@ this address as well. This domain must be specified in the configuration file See [domain configuration](./doc/self-hosters/domains.md) for more information. +### Configure the Port + +- You can specify a custom port by setting `http_port` to a desired value +- If you're using a reverse-proxy such as nginx or cloudflare, you should + also set `pub_port` to the public (external) port (usually `443`) + ### Default User By default, Puter will create a user called `default_user`.