git.squeep.com Git - akkoma/blob - docs/docs/installation/migrating_to_akkoma.md

   1 # Migrating to Akkoma
   2
   3 **Akkoma does not currently have a stable release, until 3.0, all builds should be considered "develop"**
   4
   5 ## Why should you migrate?
   6
   7 aside from actually responsive maintainer(s)? let's lookie here, we've got:
   8
   9 - custom emoji reactions
  10 - misskey markdown (MFM) rendering and posting support
  11 - elasticsearch support (because pleroma search is GARBAGE)
  12 - latest develop pleroma-fe additions
  13 - local-only posting
  14 - probably more, this is like 3.5 years of IHBA additions finally compiled
  15
  16 ## Actually migrating
  17
  18 Let's say you're very cool and have decided to move to the cooler
  19 fork of Akkoma - luckily this isn't very hard.
  20
  21 You'll need to update the backend, then possibly the frontend, depending
  22 on your setup.
  23
  24 ## From Source
  25
  26 If you're running the source Akkoma install, you'll need to set the
  27 upstream git URL then just rebuild - that'll be:
  28
  29 ```bash
  30 git remote set-url origin https://akkoma.dev/AkkomaGang/akkoma.git/
  31 git fetch origin
  32 git pull -r
  33 # or, if you're on an instance-specific branch, you may want
  34 # to run "git merge stable" instead (or develop if you want)
  35 ```
  36
  37 Then compile, migrate and restart as usual.
  38
  39 ## From OTP
  40
  41 This will just be setting the update URL - find your flavour from the [mapping on the install guide](../otp_en/#detecting-flavour) first.
  42
  43 ```bash
  44 export FLAVOUR=[the flavour you found above]
  45
  46 ./bin/pleroma_ctl update --zip-url https://akkoma-updates.s3-website.fr-par.scw.cloud/develop/akkoma-$FLAVOUR.zip
  47 ./bin/pleroma_ctl migrate
  48 ```
  49
  50 Then restart. When updating in the future, you canjust use
  51
  52 ```bash
  53 ./bin/pleroma_ctl update --branch develop
  54 ```
  55
  56 ## Frontend changes
  57
  58 Akkoma comes with a few frontend changes as well as backend ones,
  59 your upgrade path here depends on your setup
  60
  61 ### I just run with the built-in frontend
  62
  63 You'll need to run a single command,
  64
  65 ```bash
  66 # From source
  67 mix pleroma.frontend install pleroma-fe
  68 # OTP
  69 ./bin/pleroma_ctl frontend install pleroma-fe
  70 ```
  71
  72 ### I've run the mix task to install a frontend
  73
  74 Hooray, just run it again to update the frontend to the latest build.
  75 See above for that command.
  76
  77 ### I compile the JS from source
  78
  79 Your situation will likely be unique - you'll need the changes in the
  80 [forked pleroma-fe repository](https://akkoma.dev/AkkomaGang/pleroma-fe),
  81 and either merge or cherry-pick from there depending on how you've got
  82 things.