2022-06-29 11:05:59 +00:00
|
|
|
# Migrating to Akkoma
|
|
|
|
|
|
|
|
## Why should you migrate?
|
|
|
|
|
2022-06-29 11:12:48 +00:00
|
|
|
aside from actually responsive maintainer(s)? let's lookie here, we've got:
|
|
|
|
|
2022-06-29 11:05:59 +00:00
|
|
|
- custom emoji reactions
|
|
|
|
- misskey markdown (MFM) rendering and posting support
|
|
|
|
- elasticsearch support (because pleroma search is GARBAGE)
|
|
|
|
- latest develop pleroma-fe additions
|
|
|
|
- local-only posting
|
2022-08-30 09:56:33 +00:00
|
|
|
- automatic post translation
|
|
|
|
- the mastodon frontend back in all its glory
|
2022-06-29 11:05:59 +00:00
|
|
|
- probably more, this is like 3.5 years of IHBA additions finally compiled
|
|
|
|
|
|
|
|
## Actually migrating
|
|
|
|
|
|
|
|
Let's say you're very cool and have decided to move to the cooler
|
2022-07-02 21:00:01 +00:00
|
|
|
fork of Akkoma - luckily this isn't very hard.
|
2022-06-29 11:05:59 +00:00
|
|
|
|
|
|
|
You'll need to update the backend, then possibly the frontend, depending
|
|
|
|
on your setup.
|
|
|
|
|
|
|
|
## From Source
|
|
|
|
|
2022-07-02 21:00:01 +00:00
|
|
|
If you're running the source Akkoma install, you'll need to set the
|
2022-06-29 11:05:59 +00:00
|
|
|
upstream git URL then just rebuild - that'll be:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
git remote set-url origin https://akkoma.dev/AkkomaGang/akkoma.git/
|
|
|
|
git fetch origin
|
|
|
|
git pull -r
|
2022-07-28 10:36:51 +00:00
|
|
|
# or, if you're on an instance-specific branch, you may want
|
|
|
|
# to run "git merge stable" instead (or develop if you want)
|
2022-06-29 11:05:59 +00:00
|
|
|
```
|
|
|
|
|
2022-11-07 00:08:20 +00:00
|
|
|
### WARNING - Migrating from Pleroma Develop
|
|
|
|
If you are on pleroma develop, and have updated since 2022-08, you may have issues with database migrations.
|
|
|
|
|
|
|
|
Please roll back the given migrations:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
MIX_ENV=prod mix ecto.rollback --migrations-path priv/repo/optional_migrations/pleroma_develop_rollbacks -n3
|
|
|
|
```
|
|
|
|
|
2022-06-29 11:05:59 +00:00
|
|
|
Then compile, migrate and restart as usual.
|
|
|
|
|
|
|
|
## From OTP
|
|
|
|
|
2022-07-28 10:36:51 +00:00
|
|
|
This will just be setting the update URL - find your flavour from the [mapping on the install guide](../otp_en/#detecting-flavour) first.
|
2022-06-29 11:05:59 +00:00
|
|
|
|
|
|
|
```bash
|
2022-07-28 10:36:51 +00:00
|
|
|
export FLAVOUR=[the flavour you found above]
|
2022-06-29 11:05:59 +00:00
|
|
|
|
2022-08-30 09:56:33 +00:00
|
|
|
./bin/pleroma_ctl update --zip-url https://akkoma-updates.s3-website.fr-par.scw.cloud/stable/akkoma-$FLAVOUR.zip
|
2022-06-29 11:05:59 +00:00
|
|
|
./bin/pleroma_ctl migrate
|
|
|
|
```
|
|
|
|
|
|
|
|
Then restart. When updating in the future, you canjust use
|
|
|
|
|
|
|
|
```bash
|
2022-08-30 09:56:33 +00:00
|
|
|
./bin/pleroma_ctl update --branch stable
|
2022-06-29 11:05:59 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
## Frontend changes
|
|
|
|
|
|
|
|
Akkoma comes with a few frontend changes as well as backend ones,
|
|
|
|
your upgrade path here depends on your setup
|
|
|
|
|
|
|
|
### I just run with the built-in frontend
|
|
|
|
|
2022-08-05 16:30:33 +00:00
|
|
|
You'll need to run a couple of commands,
|
2022-06-29 11:05:59 +00:00
|
|
|
|
2022-08-30 09:56:33 +00:00
|
|
|
=== "OTP"
|
|
|
|
```sh
|
|
|
|
./bin/pleroma_ctl frontend install pleroma-fe --ref stable
|
|
|
|
# and also, if desired
|
|
|
|
./bin/pleroma_ctl frontend install admin-fe --ref stable
|
|
|
|
```
|
|
|
|
|
|
|
|
=== "From Source"
|
|
|
|
```sh
|
|
|
|
mix pleroma.frontend install pleroma-fe --ref stable
|
|
|
|
mix pleroma.frontend install admin-fe --ref stable
|
|
|
|
```
|
2022-06-29 11:05:59 +00:00
|
|
|
|
|
|
|
### I've run the mix task to install a frontend
|
|
|
|
|
|
|
|
Hooray, just run it again to update the frontend to the latest build.
|
|
|
|
See above for that command.
|
|
|
|
|
|
|
|
### I compile the JS from source
|
|
|
|
|
|
|
|
Your situation will likely be unique - you'll need the changes in the
|
|
|
|
[forked pleroma-fe repository](https://akkoma.dev/AkkomaGang/pleroma-fe),
|
|
|
|
and either merge or cherry-pick from there depending on how you've got
|
|
|
|
things.
|
2022-11-20 21:44:32 +00:00
|
|
|
|
|
|
|
## Common issues
|
|
|
|
|
|
|
|
### The frontend doesn't show after installing it
|
|
|
|
|
|
|
|
This may occur if you are using database configuration.
|
|
|
|
|
|
|
|
Sometimes the config in your database will cause akkoma to still report
|
|
|
|
that there's no frontend, even when you've run the install.
|
|
|
|
|
|
|
|
To fix this, run:
|
|
|
|
|
|
|
|
=== "OTP"
|
|
|
|
```sh
|
|
|
|
./bin/pleroma_ctl config delete pleroma frontends
|
|
|
|
```
|
|
|
|
|
|
|
|
=== "From Source"
|
|
|
|
```sh
|
|
|
|
mix pleroma.config delete pleroma frontends
|
|
|
|
```
|
|
|
|
|
|
|
|
which will remove the config from the database. Things should work now.
|