From a309b49c2d555d4961db443a37bbf02719749a35 Mon Sep 17 00:00:00 2001
From: rinpatch <rinpatch@sdf.org>
Date: Mon, 1 Apr 2019 19:19:06 +0300
Subject: [PATCH] Remove outdated howto change config and port and move it to
 config.md instead

---
 docs/config.md                          | 38 +++++++++++++++++++++++++
 docs/config/howto_change_ip_and_port.md |  7 -----
 2 files changed, 38 insertions(+), 7 deletions(-)
 delete mode 100644 docs/config/howto_change_ip_and_port.md

diff --git a/docs/config.md b/docs/config.md
index 3624e295b..f507d4461 100644
--- a/docs/config.md
+++ b/docs/config.md
@@ -193,6 +193,44 @@ This section is used to configure Pleroma-FE, unless ``:managed_config`` in ``:i
 * `port`: Port to bind to
 * `dstport`: Port advertised in urls (optional, defaults to `port`)
 
+## Pleroma.Web.Endpoint
+`Phoenix` endpoint configuration, all configuration options can be viewed [here](https://hexdocs.pm/phoenix/Phoenix.Endpoint.html#module-dynamic-configuration), only common options are listed here
+* `http` - a list containing http protocol configuration, all configuration options can be viewed [here](https://hexdocs.pm/plug_cowboy/Plug.Cowboy.html#module-options), only common options are listed here
+  - `ip` - a tuple consisting of 4 integers
+  - `port`
+* `url` - a list containing the configuration for generating urls, accepts
+  - `host` - the host without the scheme and a post (e.g `example.com`, not `https://example.com:2020`)
+  - `scheme` - e.g `http`, `https` 
+  - `port`
+  - `path`
+
+
+**Important note: if you modify anything inside these lists, default `config.exs` values will be overwritten, which may result in breakage, to make sure this does not happen please copy the default value for the list from `config.exs` and modify/add only what you need**
+
+Example: 
+```elixir
+config :pleroma, Pleroma.Web.Endpoint,
+  url: [host: "example.com", port: 2020, scheme: "https"],
+  http: [
+    # start copied from config.exs
+    dispatch: [
+      {:_,
+       [
+         {"/api/v1/streaming", Pleroma.Web.MastodonAPI.WebsocketHandler, []},
+         {"/websocket", Phoenix.Endpoint.CowboyWebSocket,
+          {Phoenix.Transports.WebSocket,
+           {Pleroma.Web.Endpoint, Pleroma.Web.UserSocket, websocket_config}}},
+         {:_, Phoenix.Endpoint.Cowboy2Handler, {Pleroma.Web.Endpoint, []}}
+       ]}
+    # end copied from config.exs
+    ],
+    port: 8080,
+    ip: {127, 0, 0, 1}
+  ]
+```
+
+This will make Pleroma listen on `127.0.0.1` port `8080` and generate urls starting with `https://example.com:2020`
+
 ## :activitypub
 * ``accept_blocks``: Whether to accept incoming block activities from other instances
 * ``unfollow_blocked``: Whether blocks result in people getting unfollowed
diff --git a/docs/config/howto_change_ip_and_port.md b/docs/config/howto_change_ip_and_port.md
deleted file mode 100644
index decddd35c..000000000
--- a/docs/config/howto_change_ip_and_port.md
+++ /dev/null
@@ -1,7 +0,0 @@
-# How to change the port or IP Pleroma listens to
-To change the port or IP Pleroma listens to, head over to your generated config inside the Pleroma folder at config/prod.secret.exs and edit the following according to your needs.
-```
-config :pleroma, Pleroma.Web.Endpoint,
-   [...]
-   http: [ip: {127, 0, 0, 1}, port: 4000]
-```
-- 
2.45.2