AkkomaGang/akkoma
AkkomaGang/akkoma
15
67
Fork 93
Code Issues 176 Pull requests 15 Projects 2 Releases 16 Packages Wiki Activity

clean-up docs to avoid version-mismatches in BE and FE in new installs (for develop) #377

Closed
stefan230 wants to merge 1 commit from (deleted):develop into develop
pull from: (deleted):develop
merge into: AkkomaGang:develop
Conversation 6 Commits 1 Files changed 9 +25 -25
9 changed files with 25 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/docs/administration/CLI_tasks/frontend.md
View file

@ -24,20 +24,20 @@ Currently, known `<frontend>` values are:
You can still install frontends that are not configured, see below.
## Example installations for a known frontend
## Example installations for a known frontend (Development-Version)
For a frontend configured under the `available` key, it's enough to install it by name.
=== "OTP"
```sh
./bin/pleroma_ctl frontend install pleroma-fe
./bin/pleroma_ctl frontend install pleroma-fe --ref develop
```
=== "From Source"
```sh
mix pleroma.frontend install pleroma-fe
mix pleroma.frontend install pleroma-fe --ref develop
```
This will download the latest build for the pre-configured `ref` and install it. It can then be configured as the one of the served frontends in the config file (see `primary` or `admin`).

12
docs/docs/administration/updating.md
View file

@ -17,8 +17,8 @@ su -s "$SHELL" akkoma
## For OTP installations
```sh
# Download latest stable release
./bin/pleroma_ctl update --branch stable
# Download latest develop release
./bin/pleroma_ctl update --branch develop
# Stop akkoma
./bin/pleroma stop # or using the system service manager (e.g. systemctl stop akkoma)
@ -26,8 +26,8 @@ su -s "$SHELL" akkoma
# Run database migrations
./bin/pleroma_ctl migrate
# Update frontend(s). See Frontend Configuration doc for more information.
./bin/pleroma_ctl frontend install pleroma-fe --ref stable
# Update Pleroma-FE frontend to latest develop. For other Frontends see Frontend Configration doc for more information.
./bin/pleroma_ctl frontend install pleroma-fe --ref develop
# Start akkoma
./bin/pleroma daemon # or using the system service manager (e.g. systemctl start akkoma)
@ -57,8 +57,8 @@ sudo systemctl stop akkoma
# Run database migrations
mix ecto.migrate
# Update frontend(s). See Frontend Configration doc for more information.
mix pleroma.frontend install pleroma-fe --ref stable
# Update Pleroma-FE frontend to latest develop. For other Frontends see Frontend Configration doc for more information.
mix pleroma.frontend install pleroma-fe --ref develop
# Start akkoma (replace with your system service manager's equivalent if different)
sudo systemctl start akkoma

4
docs/docs/installation/alpine_linux_en.md
View file

@ -84,12 +84,12 @@ doas adduser -S -s /bin/false -h /opt/akkoma -H -G akkoma akkoma
**Note**: To execute a single command as the Akkoma system user, use `doas -u akkoma command`. You can also switch to a shell by using `doas -su akkoma`. If you don’t have and want `doas` 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 AkkomaBE repository and make the Akkoma user the owner of the directory:
* Git clone the AkkomaBE repository from development-branch and make the Akkoma user the owner of the directory:
```shell
doas mkdir -p /opt/akkoma
doas chown -R akkoma:akkoma /opt/akkoma
doas -u akkoma git clone https://akkoma.dev/AkkomaGang/akkoma.git /opt/akkoma
doas -u akkoma git clone https://akkoma.dev/AkkomaGang/akkoma.git -b develop /opt/akkoma
```
* Change to the new directory:

4
docs/docs/installation/arch_linux_en.md
View file

@ -75,12 +75,12 @@ sudo useradd -r -s /bin/false -m -d /var/lib/akkoma -U akkoma
**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 AkkomaBE repository and make the Akkoma user the owner of the directory:
* Git clone the AkkomaBE repository from development-branch and make the Akkoma user the owner of the directory:
```shell
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
sudo -Hu akkoma git clone https://akkoma.dev/AkkomaGang/akkoma.git -b develop /opt/akkoma
```
* Change to the new directory:

4
docs/docs/installation/debian_based_en.md
View file

@ -49,12 +49,12 @@ sudo useradd -r -s /bin/false -m -d /var/lib/akkoma -U akkoma
**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 AkkomaBE repository and make the Akkoma user the owner of the directory:
* Git clone the AkkomaBE repository from development-branch and make the Akkoma user the owner of the directory:
```shell
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
sudo -Hu akkoma git clone https://akkoma.dev/AkkomaGang/akkoma.git -b develop /opt/akkoma
```
* Change to the new directory:

4
docs/docs/installation/fedora_based_en.md
View file

@ -74,12 +74,12 @@ sudo useradd -r -s /bin/false -m -d /var/lib/akkoma -U akkoma
**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 AkkomaBE repository and make the Akkoma user the owner of the directory:
* Git clone the AkkomaBE repository from development-branch and make the Akkoma user the owner of the directory:
```shell
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
sudo -Hu akkoma git clone https://akkoma.dev/AkkomaGang/akkoma.git -b develop /opt/akkoma
```
* Change to the new directory:

2
docs/docs/installation/gentoo_en.md
View file

@ -124,7 +124,7 @@ It is highly recommended you use your own fork for the `https://path/to/repo` pa
```shell
akkoma$ cd ~
akkoma$ git clone -b stable https://path/to/repo
akkoma$ git clone -b develop https://path/to/repo
```
* Change to the new directory:

2
docs/docs/installation/otp_redhat_en.md
View file

@ -37,7 +37,7 @@ sudo dnf install git gcc g++ erlang elixir erlang-os_mon erlang-eldap erlang-xme
```shell
cd ~
git clone https://akkoma.dev/AkkomaGang/akkoma.git
git clone https://akkoma.dev/AkkomaGang/akkoma.git -b develop
```
* Change to the new directory:

12
docs/docs/installation/verifying_otp_releases.md
View file

@ -1,10 +1,10 @@
# Verifying OTP release integrity
All stable OTP releases are cryptographically signed, to allow
All develop OTP releases are cryptographically signed, to allow
you to verify the integrity if you choose to.
Releases are signed with [Signify](https://man.openbsd.org/signify.1),
with [the public key in the main repository](https://akkoma.dev/AkkomaGang/akkoma/src/branch/stable/SIGNING_KEY.pub)
with [the public key in the main repository](https://akkoma.dev/AkkomaGang/akkoma/src/branch/develop/SIGNING_KEY.pub)
Release URLs will always be of the form
@ -12,13 +12,13 @@ Release URLs will always be of the form
https://akkoma-updates.s3-website.fr-par.scw.cloud/{branch}/akkoma-{flavour}.zip
```
Where branch is usually `stable` or `develop`, and `flavour` is
Where branch is usually `develop`, and `flavour` is
the one [that you detect on install](../otp_en/#detecting-flavour).
So, for an AMD64 stable install, your update URL will be
So, for an AMD64 develop install, your update URL will be
```
https://akkoma-updates.s3-website.fr-par.scw.cloud/stable/akkoma-amd64.zip
https://akkoma-updates.s3-website.fr-par.scw.cloud/develop/akkoma-amd64.zip
```
To verify the integrity of this file, we have two helper files
@ -38,7 +38,7 @@ Thus, to upgrade manually, with integrity checking, consider the following scrip
set -eo pipefail
export FLAVOUR=amd64
export BRANCH=stable
export BRANCH=develop
# Fetch signing key
curl --silent https://akkoma.dev/AkkomaGang/akkoma/raw/branch/$BRANCH/SIGNING_KEY.pub -o AKKOMA_SIGNING_KEY.pub