From 873f57690a9f1f06486a31dcf7b9ba4ee9f5c359 Mon Sep 17 00:00:00 2001 From: solidsanek Date: Sat, 10 May 2025 14:49:38 +0200 Subject: [PATCH] docs: consistenly spell nginx using lowercase This matches the spelling used by the nginx project (which differs from the spelling used by the NGINX corporation) --- docs/docs/administration/backup.md | 2 +- docs/docs/configuration/howto_search_cjk.md | 2 +- docs/docs/configuration/i2p.md | 4 ++-- docs/docs/configuration/onion_federation.md | 6 +++--- docs/docs/configuration/optimisation/varnish_cache.md | 2 +- docs/docs/configuration/storing_remote_media.md | 4 ++-- docs/docs/installation/alpine_linux_en.md | 2 +- docs/docs/installation/arch_linux_en.md | 2 +- docs/docs/installation/debian_based_en.md | 2 +- docs/docs/installation/fedora_based_en.md | 2 +- docs/docs/installation/gentoo_en.md | 4 ++-- 11 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/docs/administration/backup.md b/docs/docs/administration/backup.md index 08f9fed5e..a95e5d55c 100644 --- a/docs/docs/administration/backup.md +++ b/docs/docs/administration/backup.md @@ -23,7 +23,7 @@ 8. If you installed a newer Akkoma version, you should run the database migrations `./bin/pleroma_ctl migrate`[²]. 9. Restart the Akkoma service. 10. Run `sudo -Hu postgres vacuumdb --all --analyze-in-stages`. This will quickly generate the statistics so that postgres can properly plan queries. -11. If setting up on a new server, configure Nginx by using the `installation/nginx/akkoma.nginx` configuration sample or reference the Akkoma installation guide which contains the Nginx configuration instructions. +11. If setting up on a new server, configure nginx by using the `installation/nginx/akkoma.nginx` configuration sample or reference the Akkoma installation guide which contains the nginx configuration instructions. [¹]: We assume the database name and user are both "akkoma". If not, you can find the correct name in your configuration files. [²]: If you have a from source installation, the command is `MIX_ENV=prod mix ecto.migrate`. Note that we prefix with `MIX_ENV=prod` to use the `config/prod.secret.exs` configuration file. diff --git a/docs/docs/configuration/howto_search_cjk.md b/docs/docs/configuration/howto_search_cjk.md index ba5863451..9c0352f62 100644 --- a/docs/docs/configuration/howto_search_cjk.md +++ b/docs/docs/configuration/howto_search_cjk.md @@ -15,7 +15,7 @@ In most cases, you would need an extension installed to support parsing CJK text Once you have the new search config , make sure you test it with the `pleroma` user in PostgreSQL (change `YOUR.CONFIG` to your real configuration name) ``` -SELECT ts_debug('YOUR.CONFIG', '安装和配置Nginx, ElixirとErlangをインストールします'); +SELECT ts_debug('YOUR.CONFIG', '安装和配置nginx, ElixirとErlangをインストールします'); ``` Check output of the query, and see if it matches your expectation. diff --git a/docs/docs/configuration/i2p.md b/docs/docs/configuration/i2p.md index 1fb18d1c0..cfab02dcf 100644 --- a/docs/docs/configuration/i2p.md +++ b/docs/docs/configuration/i2p.md @@ -130,7 +130,7 @@ config :pleroma, :http_security, enabled: false ``` -In the Nginx config, add the following into the `location /` block: +In the nginx config, add the following into the `location /` block: ```nginx add_header X-XSS-Protection "0"; add_header X-Permitted-Cross-Domain-Policies none; @@ -146,7 +146,7 @@ listen 127.0.0.1:14447; Set `server_name` to your i2p address. -Reload Nginx: +Reload nginx: ``` systemctl restart i2pd.service --no-block systemctl reload nginx.service diff --git a/docs/docs/configuration/onion_federation.md b/docs/docs/configuration/onion_federation.md index 26efbae42..1e44488dc 100644 --- a/docs/docs/configuration/onion_federation.md +++ b/docs/docs/configuration/onion_federation.md @@ -5,7 +5,7 @@ In addition, federating with such instances will also help furthering that goal. This is a guide to show you how it can be easily done. This guide assumes you already got Akkoma working, and that it's running on the default port 4000. -This guide also assumes you're using Nginx as the reverse proxy. +This guide also assumes you're using nginx as the reverse proxy. To install Tor on Debian / Ubuntu: ``` @@ -74,7 +74,7 @@ config :pleroma, :http_security, enabled: false ``` -In the Nginx config, add the following into the `location /` block: +In the nginx config, add the following into the `location /` block: ```nginx add_header X-XSS-Protection "0"; add_header X-Permitted-Cross-Domain-Policies none; @@ -90,7 +90,7 @@ listen 127.0.0.1:8099; Set the `server_name` to your onion address. -Reload Nginx: +Reload nginx: ``` systemctl reload nginx ``` diff --git a/docs/docs/configuration/optimisation/varnish_cache.md b/docs/docs/configuration/optimisation/varnish_cache.md index 1598354f5..7754e6f82 100644 --- a/docs/docs/configuration/optimisation/varnish_cache.md +++ b/docs/docs/configuration/optimisation/varnish_cache.md @@ -26,7 +26,7 @@ akkoma javascript. Once that's out of the way, we can point our webserver at varnish. This -=== "Nginx" +=== "nginx" upstream phoenix { server 127.0.0.1:6081 max_fails=5 fail_timeout=60s; diff --git a/docs/docs/configuration/storing_remote_media.md b/docs/docs/configuration/storing_remote_media.md index a0f099a87..fb6a15513 100644 --- a/docs/docs/configuration/storing_remote_media.md +++ b/docs/docs/configuration/storing_remote_media.md @@ -1,10 +1,10 @@ # Storing Remote Media -Akkoma does not store remote/federated media by default. The best way to achieve this is to change Nginx to keep its reverse proxy cache +Akkoma does not store remote/federated media by default. The best way to achieve this is to change nginx to keep its reverse proxy cache for a year and to activate the `MediaProxyWarmingPolicy` MRF policy in Akkoma which will automatically fetch all media through the proxy as soon as the post is received by your instance. -## Nginx +## nginx The following are excerpts from the [suggested nginx config](https://akkoma.dev/AkkomaGang/akkoma/src/branch/develop/installation/nginx/akkoma.nginx) that demonstrates the necessary config for the media proxy to work. diff --git a/docs/docs/installation/alpine_linux_en.md b/docs/docs/installation/alpine_linux_en.md index e5f88ac30..ad865d7ec 100644 --- a/docs/docs/installation/alpine_linux_en.md +++ b/docs/docs/installation/alpine_linux_en.md @@ -137,7 +137,7 @@ doas -u akkoma env MIX_ENV=prod mix phx.server If you want to open your newly installed instance to the world, you should run nginx or some other webserver/proxy in front of Akkoma and you should consider to create an OpenRC service file for Akkoma. -#### Nginx +#### nginx * Install nginx, if not already done: diff --git a/docs/docs/installation/arch_linux_en.md b/docs/docs/installation/arch_linux_en.md index 3e6476a94..bf7bea1c0 100644 --- a/docs/docs/installation/arch_linux_en.md +++ b/docs/docs/installation/arch_linux_en.md @@ -130,7 +130,7 @@ sudo -Hu akkoma MIX_ENV=prod mix phx.server If you want to open your newly installed instance to the world, you should run nginx or some other webserver/proxy in front of Akkoma and you should consider to create a systemd service file for Akkoma. -#### Nginx +#### nginx * Install nginx, if not already done: diff --git a/docs/docs/installation/debian_based_en.md b/docs/docs/installation/debian_based_en.md index 83c979d2e..61e04975d 100644 --- a/docs/docs/installation/debian_based_en.md +++ b/docs/docs/installation/debian_based_en.md @@ -144,7 +144,7 @@ sudo -Hu akkoma MIX_ENV=prod mix phx.server If you want to open your newly installed instance to the world, you should run nginx or some other webserver/proxy in front of Akkoma and you should consider to create a systemd service file for Akkoma. -#### Nginx +#### nginx * Install nginx, if not already done: diff --git a/docs/docs/installation/fedora_based_en.md b/docs/docs/installation/fedora_based_en.md index 40cdaf19a..78102a15e 100644 --- a/docs/docs/installation/fedora_based_en.md +++ b/docs/docs/installation/fedora_based_en.md @@ -127,7 +127,7 @@ sudo -Hu akkoma MIX_ENV=prod mix phx.server If you want to open your newly installed instance to the world, you should run nginx or some other webserver/proxy in front of Akkoma and you should consider to create a systemd service file for Akkoma. -#### Nginx +#### nginx * Install nginx, if not already done: diff --git a/docs/docs/installation/gentoo_en.md b/docs/docs/installation/gentoo_en.md index 0e54a3e32..a7dd464ee 100644 --- a/docs/docs/installation/gentoo_en.md +++ b/docs/docs/installation/gentoo_en.md @@ -181,7 +181,7 @@ It probably won't work over the public internet quite yet, however, as we still Assuming you want to open your newly installed federated social network to, well, the federation, you should run nginx or some other webserver/proxy in front of Akkoma. It is also a good idea to set up Akkoma to run as a system service. -#### Nginx +#### nginx * Install nginx, if not already done: @@ -197,7 +197,7 @@ Assuming you want to open your newly installed federated social network to, well * Append the following line at the end of the `http` block in `/etc/nginx/nginx.conf`: -```Nginx +```nginx include sites-enabled/*; ```