AkkomaGang/akkoma
AkkomaGang
/
akkoma
12
63
Fork 83
Code Issues 167 Pull Requests 14 Packages Projects 2 Releases 13 Wiki Activity

Docs: Don't capitalize package names
ci/woodpecker/pr/woodpecker Pipeline is pending Details

This commit is contained in:
solidsanek 2023-04-26 00:03:40 +02:00
parent 457661a316
commit f43b688ae9
5 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/docs/installation/arch_linux_en.md
View File

@ -8,7 +8,7 @@ This guide will assume that you have administrative rights, either as root or a
### Required packages ### Required packages
* `PostgreSQL` * `postgresql`
* `elixir` * `elixir`
* `git` * `git`
* `base-devel` * `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 #### Optional packages used in this guide
* `NGINX` (preferred, example configs for other reverse proxies can be found in the repo) * `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) * `certbot` (or any other ACME client for Let’s Encrypt certificates)
* `ImageMagick` * `imagemagic`
* `FFmpeg` * `ffmpeg`
* `ExifTool` * `exiftool`
### Prepare the system ### Prepare the system

6
docs/docs/installation/openbsd_en.md
View File

@ -21,9 +21,9 @@ Akkoma requires a reverse proxy, OpenBSD has relayd in base (and is used in this
#### Optional software #### Optional software
Per [`docs/installation/optional/media_graphics_packages.md`](../installation/optional/media_graphics_packages.md): Per [`docs/installation/optional/media_graphics_packages.md`](../installation/optional/media_graphics_packages.md):
* ImageMagick * imagemagick
* FFmpeg * ffmpeg
* ExifTool * exiftool
To install the above: To install the above:

16
docs/docs/installation/optional/media_graphics_packages.md
View File

@ -1,33 +1,33 @@
# Optional software packages needed for specific functionality # 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: For specific Pleroma functionality (which is disabled by default) some or all of the below packages are required:
* `ImageMagic` * `imagemagic`
* `ffmpeg` * `ffmpeg`
* `ExifTool` * `exiftool`
Please refer to documentation in `docs/installation` on how to install them on specific OS. Please refer to documentation in `docs/installation` on how to install them on specific OS.
!!! note !!! note
The packages are not required with the current default settings of Pleroma. 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: 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`) * `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`) * 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: It is required for the following Pleroma features:
* Media preview proxy for videos (related config: `media_preview_proxy/enabled` in `config/config.exs`) * 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: It is required for the following Pleroma features:
* `Pleroma.Upload.Filters.Exiftool` upload filter (related config: `Plaroma.Upload/filters` in `config/config.exs`) * `Pleroma.Upload.Filters.Exiftool` upload filter (related config: `Plaroma.Upload/filters` in `config/config.exs`)

12
docs/docs/installation/otp_en.md
View File

@ -36,9 +36,9 @@ Other than things bundled in the OTP release, Akkoma depends on:
* curl (to download the release build) * curl (to download the release build)
* unzip (needed to unpack release builds) * unzip (needed to unpack release builds)
* ncurses (ERTS won't run without it) * ncurses (ERTS won't run without it)
* PostgreSQL (also utilizes extensions in postgresql-contrib) * postgresql (also utilizes extensions in postgresql-contrib)
* NGINX (could be swapped with another reverse proxy, but this guide covers only it) * 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) * certbot (for Let's Encrypt certificates, could be swapped with another ACME client, but this guide covers only it)
* libmagic/file * libmagic/file
=== "Alpine" === "Alpine"
@ -56,9 +56,9 @@ Other than things bundled in the OTP release, Akkoma depends on:
### Installing optional packages ### Installing optional packages
Per [`docs/installation/optional/media_graphics_packages.md`](optional/media_graphics_packages.md): Per [`docs/installation/optional/media_graphics_packages.md`](optional/media_graphics_packages.md):
* ImageMagick * `imagemagick`
* FFmpeg * `ffmpeg`
* ExifTool * `exiftool`
=== "Alpine" === "Alpine"
``` ```

6
docs/docs/installation/otp_redhat_en.md
View File

@ -74,9 +74,9 @@ Other than things bundled in the OTP release, Akkoma depends on:
* curl (to download the release build) * curl (to download the release build)
* ncurses (ERTS won't run without it) * ncurses (ERTS won't run without it)
* PostgreSQL (also utilizes extensions in postgresql-contrib) * postgresql (also utilizes extensions in postgresql-contrib)
* NGINX (could be swapped with another reverse proxy, but this guide covers only it) * 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) * certbot (for Let's Encrypt certificates, could be swapped with another ACME client, but this guide covers only it)
* libmagic/file * libmagic/file
First, update your system, if not already done: First, update your system, if not already done: