forked from AkkomaGang/akkoma
Docs: change FE names to be more consistent
This commit is contained in:
parent
f43b688ae9
commit
c7b0a6a44d
|
@ -19,7 +19,7 @@ You can give all the options directly on the command line, but missing informati
|
|||
Currently, known `<frontend>` values are:
|
||||
|
||||
- [admin-fe](https://akkoma.dev/AkkomaGang/admin-fe)
|
||||
- [mastodon-fe](https://akkoma.dev/AkkomaGang/masto-fe)
|
||||
- [masto-fe](https://akkoma.dev/AkkomaGang/masto-fe)
|
||||
- [pleroma-fe](https://akkoma.dev/AkkomaGang/pleroma-fe)
|
||||
|
||||
You can still install frontends that are not configured, see below.
|
||||
|
|
|
@ -312,11 +312,11 @@ relates to mascots on the Mastodon frontend
|
|||
* `mascots`: KeywordList of mascots, each element __MUST__ contain both a `url` and a
|
||||
`mime_type` key.
|
||||
* `default_mascot`: An element from `mascots` - This will be used as the default mascot
|
||||
on MastoFE (default: `:pleroma_fox_tan`).
|
||||
on Masto-fe (default: `:pleroma_fox_tan`).
|
||||
|
||||
### :manifest
|
||||
|
||||
This section describes PWA manifest instance-specific values. Currently, this option relates only to MastoFE.
|
||||
This section describes PWA manifest instance-specific values. Currently, this option relates only to Masto-fe.
|
||||
|
||||
* `icons`: Describe the icons of the app, this is a list of maps describing icons in the same way as the
|
||||
[spec](https://www.w3.org/TR/appmanifest/#imageresource-and-its-members) describes it.
|
||||
|
|
|
@ -34,9 +34,9 @@ If you choose not to install a frontend for whatever reason, it is recommended t
|
|||
|
||||
You can also replace the default "no frontend" page by placing an `index.html` file under your `instance/static/` directory.
|
||||
|
||||
## Mastodon-FE
|
||||
## Masto-fe
|
||||
|
||||
Akkoma supports both [glitchsoc](https://github.com/glitch-soc/mastodon)'s more "vanilla" mastodon frontend,
|
||||
Akkoma supports both [glitch-soc](https://github.com/glitch-soc/mastodon)'s more "vanilla" mastodon frontend,
|
||||
as well as [fedibird](https://github.com/fedibird/mastodon)'s extended frontend which has near-feature-parity with akkoma (with quoting and reactions).
|
||||
|
||||
To enable either one, you must run the `frontend.install` task for either `mastodon-fe` or `fedibird-fe` (both `--ref akkoma`), then make sure
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# How to activate Akkoma in-database configuration
|
||||
## Explanation
|
||||
|
||||
The configuration of Akkoma (and Pleroma) has traditionally been managed with a config file, e.g. `config/prod.secret.exs`. This method requires a restart of the application for any configuration changes to take effect. We have made it possible to control most settings in the AdminFE interface after running a migration script.
|
||||
The configuration of Akkoma (and Pleroma) has traditionally been managed with a config file, e.g. `config/prod.secret.exs`. This method requires a restart of the application for any configuration changes to take effect. We have made it possible to control most settings in the Admin-fe interface after running a migration script.
|
||||
|
||||
## Migration to database config
|
||||
|
||||
|
@ -75,7 +75,7 @@ The configuration of Akkoma (and Pleroma) has traditionally been managed with a
|
|||
config :pleroma, configurable_from_database: true
|
||||
```
|
||||
|
||||
5. Restart your instance, and you can now access the Settings tab in AdminFE.
|
||||
5. Restart your instance, and you can now access the Settings tab in admin-fe.
|
||||
|
||||
## Reverting back from database config
|
||||
|
||||
|
@ -130,7 +130,7 @@ You can clear the database config with the following command:
|
|||
Additionally, every time you migrate the configuration to the database, the config table is automatically truncated to ensure a clean migration.
|
||||
|
||||
### Manually removing a setting
|
||||
If you encounter a situation where the server cannot run properly because of an invalid setting in the database and this is preventing you from accessing AdminFE, you can manually remove the offending setting if you know which one it is.
|
||||
If you encounter a situation where the server cannot run properly because of an invalid setting in the database and this is preventing you from accessing admin-fe, you can manually remove the offending setting if you know which one it is.
|
||||
|
||||
e.g., here is an example showing the removal of the `config :pleroma, :instance` settings:
|
||||
|
||||
|
|
|
@ -124,7 +124,7 @@ Please note that the Akkoma developers consider custom MRF policy modules to fal
|
|||
|
||||
### MRF policies descriptions
|
||||
|
||||
If MRF policy depends on config, it can be added into MRF tab to AdminFE by adding `config_description/0` method, which returns a map with a specific structure. See existing MRF's like `lib/pleroma/web/activity_pub/mrf/activity_expiration_policy.ex` for examples. Note that more complex inputs, like tuples or maps, may need extra changes in the adminFE and just adding it to `config_description/0` may not be enough to get these inputs working from the AdminFE.
|
||||
If MRF policy depends on config, it can be added into MRF tab to Admin-fe by adding `config_description/0` method, which returns a map with a specific structure. See existing MRF's like `lib/pleroma/web/activity_pub/mrf/activity_expiration_policy.ex` for examples. Note that more complex inputs, like tuples or maps, may need extra changes in the Admin-fe and just adding it to `config_description/0` may not be enough to get these inputs working from the Admin-fe.
|
||||
|
||||
Example:
|
||||
|
||||
|
|
|
@ -73,7 +73,7 @@ doas rc-update add postgresql
|
|||
doas apk add ffmpeg imagemagick exiftool
|
||||
```
|
||||
|
||||
### Install AkkomaBE
|
||||
### Install Akkoma-be
|
||||
|
||||
* Add a new system user for the Akkoma service:
|
||||
|
||||
|
@ -84,7 +84,7 @@ 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 from stable-branch and make the Akkoma user the owner of the directory:
|
||||
* Git clone the akkoma-be repository from stable-branch and make the Akkoma user the owner of the directory:
|
||||
|
||||
```shell
|
||||
doas mkdir -p /opt/akkoma
|
||||
|
|
|
@ -65,7 +65,7 @@ sudo systemctl enable --now postgresql.service
|
|||
sudo pacman -S ffmpeg imagemagick perl-image-exiftool
|
||||
```
|
||||
|
||||
### Install AkkomaBE
|
||||
### Install Akkoma-be
|
||||
|
||||
* Add a new system user for the Akkoma service:
|
||||
|
||||
|
@ -75,7 +75,7 @@ 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 from stable-branch and make the Akkoma user the owner of the directory:
|
||||
* Git clone the akkoma-be repository from stable-branch and make the Akkoma user the owner of the directory:
|
||||
|
||||
```shell
|
||||
sudo mkdir -p /opt/akkoma
|
||||
|
|
|
@ -38,7 +38,7 @@ sudo apt install elixir erlang-dev erlang-nox
|
|||
sudo apt install imagemagick ffmpeg libimage-exiftool-perl
|
||||
```
|
||||
|
||||
### Install AkkomaBE
|
||||
### Install Akkoma-be
|
||||
|
||||
* Add a new system user for the Akkoma service:
|
||||
|
||||
|
@ -48,7 +48,7 @@ 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 from stable-branch and make the Akkoma user the owner of the directory:
|
||||
* Git clone the akkoma-be repository from stable-branch and make the Akkoma user the owner of the directory:
|
||||
|
||||
```shell
|
||||
sudo mkdir -p /opt/akkoma
|
||||
|
|
|
@ -61,7 +61,7 @@ sudo dnf install ImageMagick perl-Image-ExifTool
|
|||
```
|
||||
|
||||
|
||||
### Install AkkomaBE
|
||||
### Install Akkoma-be
|
||||
|
||||
* Add a new system user for the Akkoma service:
|
||||
|
||||
|
@ -71,7 +71,7 @@ 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 from stable-branch and make the Akkoma user the owner of the directory:
|
||||
* Git clone the akkoma-be repository from stable-branch and make the Akkoma user the owner of the directory:
|
||||
|
||||
```shell
|
||||
sudo mkdir -p /opt/akkoma
|
||||
|
|
|
@ -104,7 +104,7 @@ 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
|
||||
```
|
||||
|
||||
### Install AkkomaBE
|
||||
### Install Akkoma-be
|
||||
|
||||
* Add a new system user for the Akkoma service and set up default directories:
|
||||
|
||||
|
@ -118,7 +118,7 @@ Optional: If you are using sudo, review your sudo setup to ensure it works for y
|
|||
|
||||
**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 or want `sudo` or would like to use the system as the `akkoma` user for instance maintenance tasks, you can simply use `su - akkoma` to switch to the `akkoma` user.
|
||||
|
||||
* Git clone the AkkomaBE repository and make the Akkoma user the owner of the directory:
|
||||
* Git clone the akkoma-be 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://akkoma.dev/AkkomaGang/akkoma.git` will work here.
|
||||
|
||||
|
|
|
@ -241,7 +241,7 @@ At this point if you open your (sub)domain in a browser you should see a 502 err
|
|||
systemctl enable akkoma
|
||||
```
|
||||
|
||||
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 errors.
|
||||
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 errors.
|
||||
|
||||
{! support.include !}
|
||||
|
||||
|
|
|
@ -31,7 +31,7 @@ sudo dnf install git gcc g++ erlang elixir erlang-os_mon erlang-eldap erlang-xme
|
|||
|
||||
### Preparing the project files
|
||||
|
||||
* Git clone the AkkomaBE repository. This can be done anywhere:
|
||||
* Git clone the Akkoma-be repository. This can be done anywhere:
|
||||
|
||||
```shell
|
||||
cd ~
|
||||
|
@ -207,7 +207,7 @@ sudo systemctl start akkoma
|
|||
sudo systemctl enable akkoma
|
||||
```
|
||||
|
||||
If everything worked, you should see a response from Akkoma-BE when visiting your domain. You may need to install frontends like Akkoma-FE and Admin-FE; refer to [this guide](../administration/CLI_tasks/frontend.md) on how to install them.
|
||||
If everything worked, you should see a response from akkoma-be when visiting your domain. You may need to install frontends like akkoma-fe and admin-fe; refer to [this guide](../administration/CLI_tasks/frontend.md) on how to install them.
|
||||
|
||||
If that didn't happen, try reviewing the installation steps, starting Akkoma in the foreground and seeing if there are any errors.
|
||||
|
||||
|
|
Loading…
Reference in New Issue