X-Git-Url: http://git.squeep.com/?a=blobdiff_plain;f=docs%2Finstallation%2Farch_linux_en.md;h=dfddfe23c214be7f81361441e8048f2e3ccdb851;hb=3ad3a114de800ac406373693e9ae6a9bdb8b7fca;hp=0eb6d2d5f8dd90762186207e76c4a8bc4d8a2184;hpb=ddf36b096e3f6e2fa1cdca5d59db98ade696df20;p=akkoma diff --git a/docs/installation/arch_linux_en.md b/docs/installation/arch_linux_en.md index 0eb6d2d5f..dfddfe23c 100644 --- a/docs/installation/arch_linux_en.md +++ b/docs/installation/arch_linux_en.md @@ -1,7 +1,10 @@ # Installing on Arch Linux + +{! backend/installation/otp_vs_from_source_source.include !} + ## Installation -This guide will assume that you have administrative rights, either as root or a user with [sudo permissions](https://wiki.archlinux.org/index.php/Sudo). If you want to run this guide with root, ignore the `sudo` at the beginning of the lines, unless it calls a user like `sudo -Hu pleroma`; in this case, use `su -s $SHELL -c 'command'` instead. +This guide will assume that you have administrative rights, either as root or a user with [sudo permissions](https://wiki.archlinux.org/index.php/Sudo). If you want to run this guide with root, ignore the `sudo` at the beginning of the lines, unless it calls a user like `sudo -Hu akkoma`; in this case, use `su -s $SHELL -c 'command'` instead. ### Required packages @@ -56,51 +59,51 @@ sudo -iu postgres initdb -D /var/lib/postgres/data sudo systemctl enable --now postgresql.service ``` -### Install media / graphics packages (optional, see [`docs/installation/optional/media_graphics_packages.md`](docs/installation/optional/media_graphics_packages.md)) +### Install media / graphics packages (optional, see [`docs/installation/optional/media_graphics_packages.md`](../installation/optional/media_graphics_packages.md)) ```shell sudo pacman -S ffmpeg imagemagick perl-image-exiftool ``` -### Install PleromaBE +### Install AkkomaBE -* Add a new system user for the Pleroma service: +* Add a new system user for the Akkoma service: ```shell -sudo useradd -r -s /bin/false -m -d /var/lib/pleroma -U pleroma +sudo useradd -r -s /bin/false -m -d /var/lib/akkoma -U akkoma ``` -**Note**: To execute a single command as the Pleroma system user, use `sudo -Hu pleroma command`. You can also switch to a shell by using `sudo -Hu pleroma $SHELL`. If you don’t have and want `sudo` on your system, you can use `su` as root user (UID 0) for a single command by using `su -l pleroma -s $SHELL -c 'command'` and `su -l pleroma -s $SHELL` for starting a shell. +**Note**: To execute a single command as the Akkoma system user, use `sudo -Hu akkoma command`. You can also switch to a shell by using `sudo -Hu akkoma $SHELL`. If you don’t have and want `sudo` on your system, you can use `su` as root user (UID 0) for a single command by using `su -l akkoma -s $SHELL -c 'command'` and `su -l akkoma -s $SHELL` for starting a shell. -* Git clone the PleromaBE repository and make the Pleroma user the owner of the directory: +* Git clone the AkkomaBE repository and make the Akkoma user the owner of the directory: ```shell -sudo mkdir -p /opt/pleroma -sudo chown -R pleroma:pleroma /opt/pleroma -sudo -Hu pleroma git clone -b stable https://git.pleroma.social/pleroma/pleroma /opt/pleroma +sudo mkdir -p /opt/akkoma +sudo chown -R akkoma:akkoma /opt/akkoma +sudo -Hu akkoma git clone https://akkoma.dev/AkkomaGang/akkoma.git /opt/akkoma ``` * Change to the new directory: ```shell -cd /opt/pleroma +cd /opt/akkoma ``` -* Install the dependencies for Pleroma and answer with `yes` if it asks you to install `Hex`: +* Install the dependencies for Akkoma and answer with `yes` if it asks you to install `Hex`: ```shell -sudo -Hu pleroma mix deps.get +sudo -Hu akkoma mix deps.get ``` -* Generate the configuration: `sudo -Hu pleroma mix pleroma.instance gen` +* Generate the configuration: `sudo -Hu akkoma MIX_ENV=prod mix pleroma.instance gen` * Answer with `yes` if it asks you to install `rebar3`. - * This may take some time, because parts of pleroma get compiled first. + * This may take some time, because parts of akkoma get compiled first. * After that it will ask you a few questions about your instance and generates a configuration file in `config/generated_config.exs`. -* Check the configuration and if all looks right, rename it, so Pleroma will load it (`prod.secret.exs` for productive instance, `dev.secret.exs` for development instances): +* Check the configuration and if all looks right, rename it, so Akkoma will load it (`prod.secret.exs` for productive instance, `dev.secret.exs` for development instances): ```shell -mv config/{generated_config.exs,prod.secret.exs} +sudo -Hu akkoma mv config/{generated_config.exs,prod.secret.exs} ``` * The previous command creates also the file `config/setup_db.psql`, with which you can create the database: @@ -112,18 +115,18 @@ sudo -Hu postgres psql -f config/setup_db.psql * Now run the database migration: ```shell -sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate +sudo -Hu akkoma MIX_ENV=prod mix ecto.migrate ``` -* Now you can start Pleroma already +* Now you can start Akkoma already ```shell -sudo -Hu pleroma MIX_ENV=prod mix phx.server +sudo -Hu akkoma MIX_ENV=prod mix phx.server ``` ### Finalize installation -If you want to open your newly installed instance to the world, you should run nginx or some other webserver/proxy in front of Pleroma and you should consider to create a systemd service file for Pleroma. +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 @@ -165,8 +168,8 @@ If that doesn’t work, make sure, that nginx is not already running. If it stil * Copy the example nginx configuration and activate it: ```shell -sudo cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/sites-available/pleroma.nginx -sudo ln -s /etc/nginx/sites-available/pleroma.nginx /etc/nginx/sites-enabled/pleroma.nginx +sudo cp /opt/akkoma/installation/akkoma.nginx /etc/nginx/sites-available/akkoma.nginx +sudo ln -s /etc/nginx/sites-available/akkoma.nginx /etc/nginx/sites-enabled/akkoma.nginx ``` * Before starting nginx edit the configuration and change it to your needs (e.g. change servername, change cert paths) @@ -184,21 +187,21 @@ sudo certbot certonly --email -d --webroot -w / #### Other webserver/proxies -You can find example configurations for them in `/opt/pleroma/installation/`. +You can find example configurations for them in `/opt/akkoma/installation/`. #### Systemd service * Copy example service file ```shell -sudo cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service +sudo cp /opt/akkoma/installation/akkoma.service /etc/systemd/system/akkoma.service ``` * Edit the service file and make sure that all paths fit your installation -* Enable and start `pleroma.service`: +* Enable and start `akkoma.service`: ```shell -sudo systemctl enable --now pleroma.service +sudo systemctl enable --now akkoma.service ``` #### Create your first user @@ -206,13 +209,12 @@ sudo systemctl enable --now pleroma.service If your instance is up and running, you can create your first user with administrative rights with the following task: ```shell -sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new --admin +sudo -Hu akkoma MIX_ENV=prod mix pleroma.user new --admin ``` #### Further reading {! backend/installation/further_reading.include !} - ## Questions -Questions about the installation or didn’t it work as it should be, ask in [#pleroma:matrix.org](https://matrix.heldscal.la/#/room/#freenode_#pleroma:matrix.org) or IRC Channel **#pleroma** on **Freenode**. +If you encounter any issues or have questions regarding the install process, feel free to ask at [meta.akkoma.dev](https://meta.akkoma.dev/).