Installation on Arch Linux#

Note

Arch only includes the latest version of Python 3 (to date, 3.14).

You should use the AUR or build 3.11 from source yourself if you want to install this software.

Required dependencies#

  • PostgreSQL >= 11.0
  • Python >= 3.8 (supported: <3.12)
  • Redis (or Valkey)
  • git

Prepare the system#

Note

The yay helper is mentioned here, but feel free to use the AUR helper of your choice.

# pacman -Syu
# pacman -S postgresql valkey nodejs-lts-jod git
$ yay -S python311

Creating dedicated user#

Note

User creation commands may vary between operating systems

Warning

You should not run this as the system superuser, thus, creating a separate unprivileged user is mandatory

# useradd -r -d /srv/funquail -m -s /bin/sh -U funquail

Setting up directories#

# cd /srv/funquail
# for i in data/media data/music data/static; do mkdir -p $i && chown -R funquail $i; done

Obtaining the software#

FunQuail comes in two parts, the backend (written in Python), and the frontend (written in TypeScript).

Note

This section is a stub