From f43b688ae9c8d7eeef1cc03f8464a1d80064e28b Mon Sep 17 00:00:00 2001 From: solidsanek Date: Wed, 26 Apr 2023 00:03:40 +0200 Subject: [PATCH] Docs: Don't capitalize package names --- docs/docs/installation/arch_linux_en.md | 12 ++++++------ docs/docs/installation/openbsd_en.md | 6 +++--- .../optional/media_graphics_packages.md | 16 ++++++++-------- docs/docs/installation/otp_en.md | 12 ++++++------ docs/docs/installation/otp_redhat_en.md | 6 +++--- 5 files changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/docs/installation/arch_linux_en.md b/docs/docs/installation/arch_linux_en.md index 048b7a5b1..2135c04d7 100644 --- a/docs/docs/installation/arch_linux_en.md +++ b/docs/docs/installation/arch_linux_en.md @@ -8,7 +8,7 @@ This guide will assume that you have administrative rights, either as root or a ### Required packages -* `PostgreSQL` +* `postgresql` * `elixir` * `git` * `base-devel` @@ -17,11 +17,11 @@ This guide will assume that you have administrative rights, either as root or a #### Optional packages used in this guide -* `NGINX` (preferred, example configs for other reverse proxies can be found in the repo) -* `Certbot` (or any other ACME client for Let’s Encrypt certificates) -* `ImageMagick` -* `FFmpeg` -* `ExifTool` +* `nginx` (preferred, example configs for other reverse proxies can be found in the repo) +* `certbot` (or any other ACME client for Let’s Encrypt certificates) +* `imagemagic` +* `ffmpeg` +* `exiftool` ### Prepare the system diff --git a/docs/docs/installation/openbsd_en.md b/docs/docs/installation/openbsd_en.md index 7932c35e3..e5ac83462 100644 --- a/docs/docs/installation/openbsd_en.md +++ b/docs/docs/installation/openbsd_en.md @@ -21,9 +21,9 @@ Akkoma requires a reverse proxy, OpenBSD has relayd in base (and is used in this #### Optional software Per [`docs/installation/optional/media_graphics_packages.md`](../installation/optional/media_graphics_packages.md): - * ImageMagick - * FFmpeg - * ExifTool + * imagemagick + * ffmpeg + * exiftool To install the above: diff --git a/docs/docs/installation/optional/media_graphics_packages.md b/docs/docs/installation/optional/media_graphics_packages.md index 04a26b052..956680b5c 100644 --- a/docs/docs/installation/optional/media_graphics_packages.md +++ b/docs/docs/installation/optional/media_graphics_packages.md @@ -1,33 +1,33 @@ # Optional software packages needed for specific functionality For specific Pleroma functionality (which is disabled by default) some or all of the below packages are required: - * `ImageMagic` + * `imagemagic` * `ffmpeg` - * `ExifTool` + * `exiftool` Please refer to documentation in `docs/installation` on how to install them on specific OS. !!! note The packages are not required with the current default settings of Pleroma. -## `ImageMagick` +## `imagemagic` -`ImageMagick` is a set of tools to create, edit, compose, or convert bitmap images. +`imagemagic` is a set of tools to create, edit, compose, or convert bitmap images. It is required for the following Pleroma features: * `Pleroma.Upload.Filters.Mogrify`, `Pleroma.Upload.Filters.Mogrifun` upload filters (related config: `Plaroma.Upload/filters` in `config/config.exs`) * Media preview proxy for still images (related config: `media_preview_proxy/enabled` in `config/config.exs`) -## `FFmpeg` +## `ffmpeg` -`FFmpeg` is software to record, convert and stream audio and video. +`ffmpeg` is a software to record, convert and stream audio and video. It is required for the following Pleroma features: * Media preview proxy for videos (related config: `media_preview_proxy/enabled` in `config/config.exs`) -## `ExifTool` +## `exiftool` -`ExifTool` is media files metadata reader/writer. +`exiftool` is media files metadata reader/writer. It is required for the following Pleroma features: * `Pleroma.Upload.Filters.Exiftool` upload filter (related config: `Plaroma.Upload/filters` in `config/config.exs`) diff --git a/docs/docs/installation/otp_en.md b/docs/docs/installation/otp_en.md index f760f4892..b2fe410a5 100644 --- a/docs/docs/installation/otp_en.md +++ b/docs/docs/installation/otp_en.md @@ -36,9 +36,9 @@ Other than things bundled in the OTP release, Akkoma depends on: * curl (to download the release build) * unzip (needed to unpack release builds) * ncurses (ERTS won't run without it) -* PostgreSQL (also utilizes extensions in postgresql-contrib) -* NGINX (could be swapped with another reverse proxy, but this guide covers only it) -* Certbot (for Let's Encrypt certificates, could be swapped with another ACME client, but this guide covers only it) +* postgresql (also utilizes extensions in postgresql-contrib) +* nginx (could be swapped with another reverse proxy, but this guide covers only it) +* certbot (for Let's Encrypt certificates, could be swapped with another ACME client, but this guide covers only it) * libmagic/file === "Alpine" @@ -56,9 +56,9 @@ Other than things bundled in the OTP release, Akkoma depends on: ### Installing optional packages Per [`docs/installation/optional/media_graphics_packages.md`](optional/media_graphics_packages.md): - * ImageMagick - * FFmpeg - * ExifTool + * `imagemagick` + * `ffmpeg` + * `exiftool` === "Alpine" ``` diff --git a/docs/docs/installation/otp_redhat_en.md b/docs/docs/installation/otp_redhat_en.md index 8ab949716..db039aa8b 100644 --- a/docs/docs/installation/otp_redhat_en.md +++ b/docs/docs/installation/otp_redhat_en.md @@ -74,9 +74,9 @@ Other than things bundled in the OTP release, Akkoma depends on: * curl (to download the release build) * ncurses (ERTS won't run without it) -* PostgreSQL (also utilizes extensions in postgresql-contrib) -* NGINX (could be swapped with another reverse proxy, but this guide covers only it) -* Certbot (for Let's Encrypt certificates, could be swapped with another ACME client, but this guide covers only it) +* postgresql (also utilizes extensions in postgresql-contrib) +* nginx (could be swapped with another reverse proxy, but this guide covers only it) +* certbot (for Let's Encrypt certificates, could be swapped with another ACME client, but this guide covers only it) * libmagic/file First, update your system, if not already done: