AkkomaGang/akkoma
AkkomaGang/akkoma
15
65
Fork 92
Code Issues 177 Pull requests 24 Projects 2 Releases 14 Packages Wiki Activity

Update git repo URLs

Browse source 
Akkoma currently doesn't have a stable release, so all git clone
commands will currently pull in the `develop` branch.
This commit is contained in:
Norm 2022-07-02 12:51:16 -04:00
parent a40bf8be5e
commit df95007f02
12 changed files with 73 additions and 73 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/installation/alpine_linux_en.md
View file

@ -71,18 +71,18 @@ sudo rc-update add postgresql
sudo apk add ffmpeg imagemagick exiftool sudo apk add ffmpeg imagemagick exiftool
``` ```
### Install PleromaBE ### Install AkkomaBE
* Add a new system user for the Pleroma service: * Add a new system user for the Akkoma service:
```shell ```shell
sudo addgroup pleroma sudo addgroup pleroma
sudo adduser -S -s /bin/false -h /opt/pleroma -H -G pleroma pleroma sudo adduser -S -s /bin/false -h /opt/pleroma -H -G pleroma pleroma
``` ```
**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 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.
* 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 ```shell
sudo mkdir -p /opt/pleroma sudo mkdir -p /opt/pleroma
@ -96,7 +96,7 @@ sudo -Hu pleroma git clone -b stable https://git.pleroma.social/pleroma/pleroma
cd /opt/pleroma cd /opt/pleroma
``` ```
* 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 ```shell
sudo -Hu pleroma mix deps.get sudo -Hu pleroma mix deps.get
@ -107,7 +107,7 @@ sudo -Hu pleroma mix deps.get
* This may take some time, because parts of pleroma get compiled first. * This may take some time, because parts of pleroma 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`. * 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 ```shell
sudo -Hu pleroma mv config/{generated_config.exs,prod.secret.exs} sudo -Hu pleroma mv config/{generated_config.exs,prod.secret.exs}
@ -125,7 +125,7 @@ sudo -Hu postgres psql -f config/setup_db.psql
sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate
``` ```
* Now you can start Pleroma already * Now you can start Akkoma already
```shell ```shell
sudo -Hu pleroma MIX_ENV=prod mix phx.server sudo -Hu pleroma MIX_ENV=prod mix phx.server
@ -133,7 +133,7 @@ sudo -Hu pleroma MIX_ENV=prod mix phx.server
### Finalize installation ### 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 an OpenRC 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 an OpenRC service file for Akkoma.
#### Nginx #### Nginx

16
docs/installation/arch_linux_en.md
View file

@ -65,17 +65,17 @@ sudo systemctl enable --now postgresql.service
sudo pacman -S ffmpeg imagemagick perl-image-exiftool 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 ```shell
sudo useradd -r -s /bin/false -m -d /var/lib/pleroma -U pleroma sudo useradd -r -s /bin/false -m -d /var/lib/pleroma -U pleroma
``` ```
**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 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.
* 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 ```shell
sudo mkdir -p /opt/pleroma sudo mkdir -p /opt/pleroma
@ -89,7 +89,7 @@ sudo -Hu pleroma git clone -b stable https://git.pleroma.social/pleroma/pleroma
cd /opt/pleroma cd /opt/pleroma
``` ```
* 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 ```shell
sudo -Hu pleroma mix deps.get sudo -Hu pleroma mix deps.get
@ -100,7 +100,7 @@ sudo -Hu pleroma mix deps.get
* This may take some time, because parts of pleroma get compiled first. * This may take some time, because parts of pleroma 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`. * 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 ```shell
sudo -Hu pleroma mv config/{generated_config.exs,prod.secret.exs} sudo -Hu pleroma mv config/{generated_config.exs,prod.secret.exs}
@ -118,7 +118,7 @@ sudo -Hu postgres psql -f config/setup_db.psql
sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate
``` ```
* Now you can start Pleroma already * Now you can start Akkoma already
```shell ```shell
sudo -Hu pleroma MIX_ENV=prod mix phx.server sudo -Hu pleroma MIX_ENV=prod mix phx.server
@ -126,7 +126,7 @@ sudo -Hu pleroma MIX_ENV=prod mix phx.server
### Finalize installation ### 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 #### Nginx

16
docs/installation/debian_based_en.md
View file

@ -39,17 +39,17 @@ sudo apt install elixir erlang-dev erlang-nox
sudo apt install imagemagick ffmpeg libimage-exiftool-perl sudo apt install imagemagick ffmpeg libimage-exiftool-perl
``` ```
### Install PleromaBE ### Install AkkomaBE
* Add a new system user for the Pleroma service: * Add a new system user for the Akkoma service:
```shell ```shell
sudo useradd -r -s /bin/false -m -d /var/lib/pleroma -U pleroma sudo useradd -r -s /bin/false -m -d /var/lib/pleroma -U pleroma
``` ```
**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 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.
* 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 ```shell
sudo mkdir -p /opt/pleroma sudo mkdir -p /opt/pleroma
@ -63,7 +63,7 @@ sudo -Hu pleroma git clone -b stable https://git.pleroma.social/pleroma/pleroma
cd /opt/pleroma cd /opt/pleroma
``` ```
* 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 ```shell
sudo -Hu pleroma mix deps.get sudo -Hu pleroma mix deps.get
@ -74,7 +74,7 @@ sudo -Hu pleroma mix deps.get
* This may take some time, because parts of pleroma get compiled first. * This may take some time, because parts of pleroma 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`. * 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 ```shell
sudo -Hu pleroma mv config/{generated_config.exs,prod.secret.exs} sudo -Hu pleroma mv config/{generated_config.exs,prod.secret.exs}
@ -93,7 +93,7 @@ sudo -Hu postgres psql -f config/setup_db.psql
sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate
``` ```
* Now you can start Pleroma already * Now you can start Akkoma already
```shell ```shell
sudo -Hu pleroma MIX_ENV=prod mix phx.server sudo -Hu pleroma MIX_ENV=prod mix phx.server
@ -101,7 +101,7 @@ sudo -Hu pleroma MIX_ENV=prod mix phx.server
### Finalize installation ### 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 #### Nginx

14
docs/installation/debian_based_jp.md
View file

@ -1,4 +1,4 @@
# Pleromaの入れ方 # Akkomaの入れ方
## 日本語訳について ## 日本語訳について
この記事は [Installing on Debian based distributions](Installing on Debian based distributions) の日本語訳です。何かがおかしいと思ったら、原文を見てください。 この記事は [Installing on Debian based distributions](Installing on Debian based distributions) の日本語訳です。何かがおかしいと思ったら、原文を見てください。
@ -60,15 +60,15 @@ sudo apt install elixir erlang-dev erlang-nox
sudo apt install imagemagick ffmpeg libimage-exiftool-perl sudo apt install imagemagick ffmpeg libimage-exiftool-perl
``` ```
### Pleroma BE (バックエンド) をインストールします ### Akkoma BE (バックエンド) をインストールします
* Pleroma用に新しいユーザーを作ります。 * Akkoma用に新しいユーザーを作ります。
``` ```
sudo useradd -r -s /bin/false -m -d /var/lib/pleroma -U pleroma sudo useradd -r -s /bin/false -m -d /var/lib/pleroma -U pleroma
``` ```
**注意**: Pleromaユーザとして単発のコマンドを実行したい場合はは、`sudo -Hu pleroma command` を使ってください。シェルを使いたい場合は `sudo -Hu pleroma $SHELL`です。もし `sudo` を使わない場合は、rootユーザで `su -l pleroma -s $SHELL -c 'command'` とすることでコマンドを、`su -l pleroma -s $SHELL` とすることでシェルを開始できます。 **注意**: Akkomaユーザとして単発のコマンドを実行したい場合はは、`sudo -Hu pleroma command` を使ってください。シェルを使いたい場合は `sudo -Hu pleroma $SHELL`です。もし `sudo` を使わない場合は、rootユーザで `su -l pleroma -s $SHELL -c 'command'` とすることでコマンドを、`su -l pleroma -s $SHELL` とすることでシェルを開始できます。
* Gitリポジトリをクローンします。 * Gitリポジトリをクローンします。
``` ```
@ -82,7 +82,7 @@ sudo -Hu pleroma git clone -b stable https://git.pleroma.social/pleroma/pleroma
cd /opt/pleroma cd /opt/pleroma
``` ```
* Pleromaが依存するパッケージをインストールします。Hexをインストールしてもよいか聞かれたら、yesを入力してください。 * Akkomaが依存するパッケージをインストールします。Hexをインストールしてもよいか聞かれたら、yesを入力してください。
``` ```
sudo -Hu pleroma mix deps.get sudo -Hu pleroma mix deps.get
``` ```
@ -111,14 +111,14 @@ sudo -Hu pleroma MIX_ENV=prod mix pleroma.instance gen
sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate
``` ```
* これでPleromaを起動できるようになりました。 * これでAkkomaを起動できるようになりました。
``` ```
sudo -Hu pleroma MIX_ENV=prod mix phx.server sudo -Hu pleroma MIX_ENV=prod mix phx.server
``` ```
### インストールの最終段階 ### インストールの最終段階
あなたの新しいインスタンスを世界に向けて公開するには、nginx等のWebサーバやプロキシサーバをPleromaの前段に使用する必要があります。また、Pleroma のためにシステムサービスファイルを作成する必要があります。 あなたの新しいインスタンスを世界に向けて公開するには、nginx等のWebサーバやプロキシサーバをAkkomaの前段に使用する必要があります。また、Akkoma のためにシステムサービスファイルを作成する必要があります。
#### Nginx #### Nginx

12
docs/installation/freebsd_en.md
View file

@ -34,9 +34,9 @@ Setup the required services to automatically start at boot, using `sysrc(8)`.
# pkg install imagemagick ffmpeg p5-Image-ExifTool # pkg install imagemagick ffmpeg p5-Image-ExifTool
``` ```
## Configuring Pleroma ## Configuring Akkoma
Create a user for Pleroma: Create a user for Akkoma:
``` ```
# pw add user pleroma -m # pw add user pleroma -m
@ -48,10 +48,10 @@ Clone the repository:
``` ```
$ cd $HOME # Should be the same as /home/pleroma $ cd $HOME # Should be the same as /home/pleroma
$ git clone -b stable https://git.pleroma.social/pleroma/pleroma.git $ git clone https://akkoma.dev/AkkomaGang/akkoma.git
``` ```
Configure Pleroma. Note that you need a domain name at this point: Configure Akkoma. Note that you need a domain name at this point:
``` ```
$ cd /home/pleroma/pleroma $ cd /home/pleroma/pleroma
@ -173,9 +173,9 @@ Edit the defaults of `/usr/local/etc/nginx/sites-available/pleroma.nginx`:
* Change `ssl_certificate_key` to `/var/db/acme/certs/example.tld/example.tld.key`. * Change `ssl_certificate_key` to `/var/db/acme/certs/example.tld/example.tld.key`.
* Change all references of `example.tld` to your instance's domain name. * Change all references of `example.tld` to your instance's domain name.
## Creating a startup script for Pleroma ## Creating a startup script for Akkoma
Pleroma will need to compile when it initially starts, which typically takes a longer Akkoma will need to compile when it initially starts, which typically takes a longer
period of time. Therefore, it is good practice to initially run pleroma from the period of time. Therefore, it is good practice to initially run pleroma from the
command-line before utilizing the rc.d script. That is done as follows: command-line before utilizing the rc.d script. That is done as follows:

22
docs/installation/gentoo_en.md
View file

@ -88,9 +88,9 @@ The output from emerging postgresql should give you a command for initializing t
### A note on licenses, the AGPL, and deployment procedures ### A note on licenses, the AGPL, and deployment procedures
If you do not plan to make any modifications to your Pleroma instance, cloning directly from the main repo will get you what you need. However, if you plan on doing any contributions to upstream development, making changes or modifications to your instance, making custom themes, or want to play around--and let's be honest here, if you're using Gentoo that is most likely you--you will save yourself a lot of headache later if you take the time right now to fork the Pleroma repo and use that in the following section. If you do not plan to make any modifications to your Akkoma instance, cloning directly from the main repo will get you what you need. However, if you plan on doing any contributions to upstream development, making changes or modifications to your instance, making custom themes, or want to play around--and let's be honest here, if you're using Gentoo that is most likely you--you will save yourself a lot of headache later if you take the time right now to fork the Akkoma repo and use that in the following section.
Not only does this make it much easier to deploy changes you make, as you can commit and pull from upstream and all that good stuff from the comfort of your local machine then simply `git pull` on your instance server when you're ready to deploy, it also ensures you are compliant with the Affero General Public Licence that Pleroma is licenced under, which stipulates that all network services provided with modified AGPL code must publish their changes on a publicly available internet service and for free. It also makes it much easier to ask for help from and provide help to your fellow Pleroma admins if your public repo always reflects what you are running because it is part of your deployment procedure. Not only does this make it much easier to deploy changes you make, as you can commit and pull from upstream and all that good stuff from the comfort of your local machine then simply `git pull` on your instance server when you're ready to deploy, it also ensures you are compliant with the Affero General Public Licence that Akkoma is licenced under, which stipulates that all network services provided with modified AGPL code must publish their changes on a publicly available internet service and for free. It also makes it much easier to ask for help from and provide help to your fellow Akkoma admins if your public repo always reflects what you are running because it is part of your deployment procedure.
### 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`](docs/installation/optional/media_graphics_packages.md))
@ -98,9 +98,9 @@ Not only does this make it much easier to deploy changes you make, as you can co
# emerge --ask media-video/ffmpeg media-gfx/imagemagick media-libs/exiftool # emerge --ask media-video/ffmpeg media-gfx/imagemagick media-libs/exiftool
``` ```
### Install PleromaBE ### Install AkkomaBE
* Add a new system user for the Pleroma service and set up default directories: * Add a new system user for the Akkoma service and set up default directories:
Remove `,wheel` if you do not want this user to be able to use `sudo`, however note that being able to `sudo` as the `pleroma` user will make finishing the insallation and common maintenence tasks somewhat easier: Remove `,wheel` if you do not want this user to be able to use `sudo`, however note that being able to `sudo` as the `pleroma` user will make finishing the insallation and common maintenence tasks somewhat easier:
@ -110,9 +110,9 @@ Remove `,wheel` if you do not want this user to be able to use `sudo`, however n
Optional: If you are using sudo, review your sudo setup to ensure it works for you. The `/etc/sudoers` file has a lot of options and examples to help you, and [the Gentoo sudo guide](https://wiki.gentoo.org/wiki/Sudo) has more information. Finishing this installation will be somewhat easier if you have a way to sudo from the `pleroma` user, but it might be best to not allow that user to sudo during normal operation, and as such there will be a reminder at the end of this guide to double check if you would like to lock down the `pleroma` user after initial setup. Optional: If you are using sudo, review your sudo setup to ensure it works for you. The `/etc/sudoers` file has a lot of options and examples to help you, and [the Gentoo sudo guide](https://wiki.gentoo.org/wiki/Sudo) has more information. Finishing this installation will be somewhat easier if you have a way to sudo from the `pleroma` user, but it might be best to not allow that user to sudo during normal operation, and as such there will be a reminder at the end of this guide to double check if you would like to lock down the `pleroma` user after initial setup.
**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 or want `sudo` or would like to use the system as the `pleroma` user for instance maintenance tasks, you can simply use `su - pleroma` to switch to the `pleroma` user. **Note**: To execute a single command as the Akkoma 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 or want `sudo` or would like to use the system as the `pleroma` user for instance maintenance tasks, you can simply use `su - pleroma` to switch to the `pleroma` user.
* 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:
It is highly recommended you use your own fork for the `https://path/to/repo` part below, however if you foolishly decide to forego using your own fork, the primary repo `https://git.pleroma.social/pleroma/pleroma` will work here. It is highly recommended you use your own fork for the `https://path/to/repo` part below, however if you foolishly decide to forego using your own fork, the primary repo `https://git.pleroma.social/pleroma/pleroma` will work here.
@ -127,7 +127,7 @@ It is highly recommended you use your own fork for the `https://path/to/repo` pa
pleroma$ cd ~/pleroma pleroma$ cd ~/pleroma
``` ```
* 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 ```shell
pleroma$ mix deps.get pleroma$ mix deps.get
@ -141,7 +141,7 @@ pleroma$ MIX_ENV=prod mix pleroma.instance gen
* Answer with `yes` if it asks you to install `rebar3`. * Answer with `yes` if it asks you to install `rebar3`.
* This part precompiles some parts of Pleroma, so it might take a few moments * This part precompiles some parts of Akkoma, so it might take a few moments
* After that it will ask you a few questions about your instance and generates a configuration file in `config/generated_config.exs`. * After that it will ask you a few questions about your instance and generates a configuration file in `config/generated_config.exs`.
@ -163,7 +163,7 @@ pleroma$ sudo -Hu postgres psql -f config/setup_db.psql
pleroma$ MIX_ENV=prod mix ecto.migrate pleroma$ MIX_ENV=prod mix ecto.migrate
``` ```
* Now you can start Pleroma already * Now you can start Akkoma already
```shell ```shell
pleroma$ MIX_ENV=prod mix phx.server pleroma$ MIX_ENV=prod mix phx.server
@ -173,7 +173,7 @@ It probably won't work over the public internet quite yet, however, as we still
### Finalize installation ### Finalize installation
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 Pleroma. It is also a good idea to set up Pleroma to run as a system service. 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
@ -258,7 +258,7 @@ If you would like to use other webservers or proxies, there are example configur
#### Create the uploads folder #### Create the uploads folder
Even if you are using S3, Pleroma needs someplace to store media posted on your instance. If you are using the `/home/pleroma/pleroma` root folder suggested by this guide, simply: Even if you are using S3, Akkoma needs someplace to store media posted on your instance. If you are using the `/home/pleroma/pleroma` root folder suggested by this guide, simply:
```shell ```shell
pleroma$ mkdir -p ~/pleroma/uploads pleroma$ mkdir -p ~/pleroma/uploads

6
docs/installation/migrating_from_source_otp_en.md
View file

@ -20,9 +20,9 @@ The system needs to have `curl` and `unzip` installed for downloading and unpack
``` ```
## Moving content out of the application directory ## Moving content out of the application directory
When using OTP releases the application directory changes with every version so it would be a bother to keep content there (and also dangerous unless `--no-rm` option is used when updating). Fortunately almost all paths in Pleroma are configurable, so it is possible to move them out of there. When using OTP releases the application directory changes with every version so it would be a bother to keep content there (and also dangerous unless `--no-rm` option is used when updating). Fortunately almost all paths in Akkoma are configurable, so it is possible to move them out of there.
Pleroma should be stopped before proceeding. Akkoma should be stopped before proceeding.
### Moving uploads/custom public files directory ### Moving uploads/custom public files directory
@ -64,7 +64,7 @@ Note that globs have been replaced with `pack_extensions`, so if your emojis are
### Moving the config ### Moving the config
```sh ```sh
# Create the config directory # Create the config directory
# The default path for Pleroma config is /etc/pleroma/config.exs # The default path for Akkoma config is /etc/pleroma/config.exs
# but it can be set via PLEROMA_CONFIG_PATH environment variable # but it can be set via PLEROMA_CONFIG_PATH environment variable
mkdir -p /etc/pleroma mkdir -p /etc/pleroma

4
docs/installation/migrating_to_akkoma.md
View file

@ -16,14 +16,14 @@ aside from actually responsive maintainer(s)? let's lookie here, we've got:
## Actually migrating ## Actually migrating
Let's say you're very cool and have decided to move to the cooler Let's say you're very cool and have decided to move to the cooler
fork of Pleroma - luckily this isn't very hard. fork of Akkoma - luckily this isn't very hard.
You'll need to update the backend, then possibly the frontend, depending You'll need to update the backend, then possibly the frontend, depending
on your setup. on your setup.
## From Source ## From Source
If you're running the source Pleroma install, you'll need to set the If you're running the source Akkoma install, you'll need to set the
upstream git URL then just rebuild - that'll be: upstream git URL then just rebuild - that'll be:
```bash ```bash

14
docs/installation/netbsd_en.md
View file

@ -8,7 +8,7 @@ pkgin should have been installed by the NetBSD installer if you selected
the right options. If it isn't installed, install it using pkg_add. the right options. If it isn't installed, install it using pkg_add.
Note that `postgresql11-contrib` is needed for the Postgres extensions Note that `postgresql11-contrib` is needed for the Postgres extensions
Pleroma uses. Akkoma uses.
The `mksh` shell is needed to run the Elixir `mix` script. The `mksh` shell is needed to run the Elixir `mix` script.
@ -50,9 +50,9 @@ First, run `# /etc/rc.d/pgsql start`. Then, `$ sudo -Hu pgsql -g pgsql createdb`
`# pkgin install ImageMagick ffmpeg4 p5-Image-ExifTool` `# pkgin install ImageMagick ffmpeg4 p5-Image-ExifTool`
## Configuring Pleroma ## Configuring Akkoma
Create a user for Pleroma: Create a user for Akkoma:
``` ```
# groupadd pleroma # groupadd pleroma
@ -65,10 +65,10 @@ Clone the repository:
``` ```
$ cd /home/pleroma $ cd /home/pleroma
$ git clone -b stable https://git.pleroma.social/pleroma/pleroma.git $ git clone https://akkoma.dev/AkkomaGang/akkoma.git
``` ```
Configure Pleroma. Note that you need a domain name at this point: Configure Akkoma. Note that you need a domain name at this point:
``` ```
$ cd /home/pleroma/pleroma $ cd /home/pleroma/pleroma
@ -172,7 +172,7 @@ Let's add auto-renewal to `/etc/daily.local`
--stateless --stateless
``` ```
## Creating a startup script for Pleroma ## Creating a startup script for Akkoma
Copy the startup script to the correct location and make sure it's executable: Copy the startup script to the correct location and make sure it's executable:
@ -189,7 +189,7 @@ pleroma_home="/home/pleroma"
pleroma_user="pleroma" pleroma_user="pleroma"
``` ```
Run `# /etc/rc.d/pleroma start` to start Pleroma. Run `# /etc/rc.d/pleroma start` to start Akkoma.
## Conclusion ## Conclusion

8
docs/installation/openbsd_en.md
View file

@ -15,7 +15,7 @@ To install them, run the following command (with doas or as root):
pkg_add elixir gmake git postgresql-server postgresql-contrib cmake ffmpeg ImageMagick pkg_add elixir gmake git postgresql-server postgresql-contrib cmake ffmpeg ImageMagick
``` ```
Pleroma requires a reverse proxy, OpenBSD has relayd in base (and is used in this guide) and packages/ports are available for nginx (www/nginx) and apache (www/apache-httpd). Independently of the reverse proxy, [acme-client(1)](https://man.openbsd.org/acme-client) can be used to get a certificate from Let's Encrypt. Akkoma requires a reverse proxy, OpenBSD has relayd in base (and is used in this guide) and packages/ports are available for nginx (www/nginx) and apache (www/apache-httpd). Independently of the reverse proxy, [acme-client(1)](https://man.openbsd.org/acme-client) can be used to get a certificate from Let's Encrypt.
#### Optional software #### Optional software
@ -31,7 +31,7 @@ pkg_add ImageMagick ffmpeg p5-Image-ExifTool
``` ```
#### Creating the pleroma user #### Creating the pleroma user
Pleroma will be run by a dedicated user, \_pleroma. Before creating it, insert the following lines in login.conf: Akkoma will be run by a dedicated user, \_pleroma. Before creating it, insert the following lines in login.conf:
``` ```
pleroma:\ pleroma:\
:datasize-max=1536M:\ :datasize-max=1536M:\
@ -43,7 +43,7 @@ This creates a "pleroma" login class and sets higher values than default for dat
Create the \_pleroma user, assign it the pleroma login class and create its home directory (/home/\_pleroma/): `useradd -m -L pleroma _pleroma` Create the \_pleroma user, assign it the pleroma login class and create its home directory (/home/\_pleroma/): `useradd -m -L pleroma _pleroma`
#### Clone pleroma's directory #### Clone pleroma's directory
Enter a shell as the \_pleroma user. As root, run `su _pleroma -;cd`. Then clone the repository with `git clone -b stable https://git.pleroma.social/pleroma/pleroma.git`. Pleroma is now installed in /home/\_pleroma/pleroma/, it will be configured and started at the end of this guide. Enter a shell as the \_pleroma user. As root, run `su _pleroma -;cd`. Then clone the repository with `git clone https://akkoma.dev/AkkomaGang/akkoma.git`. Akkoma is now installed in /home/\_pleroma/pleroma/, it will be configured and started at the end of this guide.
#### PostgreSQL #### PostgreSQL
Start a shell as the \_postgresql user (as root run `su _postgresql -` then run the `initdb` command to initialize postgresql: Start a shell as the \_postgresql user (as root run `su _postgresql -` then run the `initdb` command to initialize postgresql:
@ -170,7 +170,7 @@ http protocol plerup { # Protocol for upstream pleroma server
match request header append "Connection" value "upgrade" match request header append "Connection" value "upgrade"
#match response header append "Strict-Transport-Security" value "max-age=31536000; includeSubDomains" # Uncomment this only after you get HTTPS working. #match response header append "Strict-Transport-Security" value "max-age=31536000; includeSubDomains" # Uncomment this only after you get HTTPS working.
# If you do not want remote frontends to be able to access your Pleroma backend server, comment these lines # If you do not want remote frontends to be able to access your Akkoma backend server, comment these lines
match response header append "Access-Control-Allow-Origin" value "*" match response header append "Access-Control-Allow-Origin" value "*"
match response header append "Access-Control-Allow-Methods" value "POST, PUT, DELETE, GET, PATCH, OPTIONS" match response header append "Access-Control-Allow-Methods" value "POST, PUT, DELETE, GET, PATCH, OPTIONS"
match response header append "Access-Control-Allow-Headers" value "Authorization, Content-Type, Idempotency-Key" match response header append "Access-Control-Allow-Headers" value "Authorization, Content-Type, Idempotency-Key"

4
docs/installation/openbsd_fi.md
View file

@ -1,4 +1,4 @@
# Pleroman asennus OpenBSD:llä # Akkoman asennus OpenBSD:llä
Tarvitset: Tarvitset:
* Oman domainin * Oman domainin
@ -55,7 +55,7 @@ Vaihda pleroma-käyttäjään ja mene kotihakemistoosi:
Lataa pleroman lähdekoodi: Lataa pleroman lähdekoodi:
`$ git clone -b stable https://git.pleroma.social/pleroma/pleroma.git` `$ git clone https://akkoma.dev/AkkomaGang/akkoma.git`
`$ cd pleroma` `$ cd pleroma`

14
docs/installation/otp_en.md
View file

@ -2,7 +2,7 @@
{! backend/installation/otp_vs_from_source.include !} {! backend/installation/otp_vs_from_source.include !}
This guide covers a installation using an OTP release. To install Pleroma from source, please check out the corresponding guide for your distro. This guide covers a installation using an OTP release. To install Akkoma from source, please check out the corresponding guide for your distro.
## Pre-requisites ## Pre-requisites
* A machine running Linux with GNU (e.g. Debian, Ubuntu) or musl (e.g. Alpine) libc and `x86_64`, `aarch64` or `armv7l` CPU, you have root access to. If you are not sure if it's compatible see [Detecting flavour section](#detecting-flavour) below * A machine running Linux with GNU (e.g. Debian, Ubuntu) or musl (e.g. Alpine) libc and `x86_64`, `aarch64` or `armv7l` CPU, you have root access to. If you are not sure if it's compatible see [Detecting flavour section](#detecting-flavour) below
@ -23,7 +23,7 @@ If your platform is supported the output will contain the flavour string, you wi
### Installing the required packages ### Installing the required packages
Other than things bundled in the OTP release Pleroma depends on: 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)
@ -104,9 +104,9 @@ Restart PostgreSQL to apply configuration changes:
systemctl restart postgresql systemctl restart postgresql
``` ```
### Installing Pleroma ### Installing Akkoma
```sh ```sh
# Create a Pleroma user # Create a Akkoma user
adduser --system --shell /bin/false --home /opt/pleroma pleroma adduser --system --shell /bin/false --home /opt/pleroma pleroma
# Set the flavour environment variable to the string you got in Detecting flavour section. # Set the flavour environment variable to the string you got in Detecting flavour section.
@ -169,7 +169,7 @@ su pleroma -s $SHELL -lc "./bin/pleroma stop"
certbot certonly --standalone --preferred-challenges http -d yourinstance.tld certbot certonly --standalone --preferred-challenges http -d yourinstance.tld
``` ```
#### Copy Pleroma nginx configuration to the nginx folder #### Copy Akkoma nginx configuration to the nginx folder
The location of nginx configs is dependent on the distro The location of nginx configs is dependent on the distro
@ -209,7 +209,7 @@ nginx -t
systemctl start nginx systemctl start nginx
``` ```
At this point if you open your (sub)domain in a browser you should see a 502 error, that's because Pleroma is not started yet. At this point if you open your (sub)domain in a browser you should see a 502 error, that's because Akkoma is not started yet.
### Setting up a system service ### Setting up a system service
@ -233,7 +233,7 @@ At this point if you open your (sub)domain in a browser you should see a 502 err
systemctl enable pleroma systemctl enable pleroma
``` ```
If everything worked, you should see Pleroma-FE when visiting your domain. If that didn't happen, try reviewing the installation steps, starting Pleroma in the foreground and seeing if there are any errrors. If everything worked, you should see Akkoma-FE when visiting your domain. If that didn't happen, try reviewing the installation steps, starting Akkoma in the foreground and seeing if there are any errrors.
Questions about the installation or didn’t it work as it should be, ask in [#pleroma:libera.chat](https://matrix.to/#/#pleroma:libera.chat) via Matrix or **#pleroma** on **libera.chat** via IRC, you can also [file an issue on our Gitlab](https://git.pleroma.social/pleroma/pleroma-support/issues/new). Questions about the installation or didn’t it work as it should be, ask in [#pleroma:libera.chat](https://matrix.to/#/#pleroma:libera.chat) via Matrix or **#pleroma** on **libera.chat** via IRC, you can also [file an issue on our Gitlab](https://git.pleroma.social/pleroma/pleroma-support/issues/new).