A free and open source instant messaging and VoIP chat app built for friends, groups, and communities.
docs(readme): document every download and install method (#2861)
Hampus38935c83c58b
diff --git a/README.md b/README.mdindex 96fc03adf..be371bf75 100644--- a/README.md+++ b/README.md@@ -6,10 +6,12 @@</p><p align="center">- <a href="https://fluxer.app/donate">- <img src="https://img.shields.io/badge/Donate-fluxer.app%2Fdonate-brightgreen" alt="Donate" /></a>+ <a href="https://fluxer.app/download">+ <img src="https://img.shields.io/badge/Download-fluxer.app-4641D9" alt="Download" /></a><a href="https://docs.fluxer.app"><img src="https://img.shields.io/badge/Docs-docs.fluxer.app-blue" alt="Documentation" /></a>+ <a href="https://fluxer.app/donate">+ <img src="https://img.shields.io/badge/Donate-fluxer.app%2Fdonate-brightgreen" alt="Donate" /></a><a href="./LICENSE"><img src="https://img.shields.io/badge/License-AGPLv3-purple" alt="AGPLv3 License" /></a></p>@@ -19,5 +21,128 @@Fluxer is a free and open source instant messaging and VoIP chat app built for friends, groups, and communities.<p align="center">- <img src="./fluxer_static/marketing/screenshots/desktop-readme-1920w.png" alt="Fluxer app showcase" width="900">+ <img src="./fluxer_static/marketing/screenshots/desktop-readme-1920w.png" alt="Fluxer running side by side on a desktop monitor and a phone" width="820"></p>++## Download++| Windows | macOS | Linux | Android | iOS |+| --- | --- | --- | --- | --- |+| [Installer (x64)][win-setup-x64] | [Disk image][mac-dmg] | [Flatpak][flatpak-ref] | [APK][android-apk] | [TestFlight][ios-testflight] |+| [Installer (ARM64)][win-setup-arm64] | | [deb (x64)][linux-deb-x64] | [Obtainium][obtainium] | |+| [Portable (x64)][win-portable-x64] | | [deb (ARM64)][linux-deb-arm64] | | |+| [Portable (ARM64)][win-portable-arm64] | | [rpm (x64)][linux-rpm-x64] | | |+| | | [rpm (ARM64)][linux-rpm-arm64] | | |+| | | [AppImage (x64)][linux-appimage-x64] | | |+| | | [AppImage (ARM64)][linux-appimage-arm64] | | |+| | | [tar.gz (x64)][linux-targz-x64] | | |+| | | [tar.gz (ARM64)][linux-targz-arm64] | | |++The macOS disk image is universal and runs on both Apple silicon and Intel. Windows and Linux need the build that matches your processor.++On Linux, prefer a package repository over a file. Fluxer then updates with the rest of your system.++## Linux package repositories++All four repositories serve stable and canary. The package is `fluxer` for stable and `fluxer-canary` for canary.++### Flatpak++Opening [this reference file][flatpak-ref] hands the install to your desktop software manager. Some desktops also accept `flatpak+https://pkgs.fluxer.com/flatpak/fluxer.flatpakref` pasted into the address bar.++From a terminal:++```sh+flatpak install https://pkgs.fluxer.com/flatpak/fluxer.flatpakref+```++### Debian and Ubuntu++```sh+sudo install -d -m 0755 /etc/apt/keyrings+sudo curl -fsSL -o /etc/apt/keyrings/fluxer-archive-keyring.gpg https://pkgs.fluxer.com/keys/fluxer-archive-keyring.gpg+sudo curl -fsSL -o /etc/apt/sources.list.d/fluxer.sources https://pkgs.fluxer.com/deb/fluxer.sources+sudo apt update && sudo apt install fluxer+```++### Fedora and RHEL++```sh+sudo curl -fsSL -o /etc/yum.repos.d/fluxer.repo https://pkgs.fluxer.com/rpm/fluxer.repo+sudo dnf install fluxer+```++RHEL, Rocky, Alma and CentOS Stream need `sudo dnf install epel-release` first, because the base repositories do not ship `libXScrnSaver`. Fedora does not need this.++### Arch Linux++The repository is signed, so pacman needs the key in its own keyring once:++```sh+sudo pacman-key --init+curl -fsSL -o /tmp/fluxer-archive-keyring.asc https://pkgs.fluxer.com/keys/fluxer-archive-keyring.asc+sudo pacman-key --add /tmp/fluxer-archive-keyring.asc+sudo pacman-key --lsign-key 09D01339EE128925F75E675C855C5BDE34D205D2+```++`--lsign-key` is the step that makes pacman trust the key. Then add the repository:++```sh+sudo tee -a /etc/pacman.conf >/dev/null <<'REPO'++[fluxer]+SigLevel = Required TrustedOnly+Server = https://pkgs.fluxer.com/arch/$repo/os/$arch+REPO+sudo pacman -Syu fluxer+```++Write `$repo` and `$arch` literally. Both are pacman variables, not shell ones, which is why the heredoc above is quoted.++Full setup notes, including the canary channel, live in the [Linux repositories documentation][docs-linux].++## Other ways to run it++- [Open Fluxer in a browser](https://web.fluxer.app) with no install at all.+- [Host your own instance][docs-selfhost] from this repository.++## Documentation++- [Documentation home][docs]+- [Downloads][docs-downloads]+- [Self-hosting][docs-selfhost]++## License++The source is licensed under the [AGPL-3.0-or-later](./LICENSE).++Fluxer branding, icons, default avatars, badge artwork, screenshots and marketing+imagery are copyright Fluxer and all rights reserved, as set out in+[fluxer_static/LICENSE](./fluxer_static/LICENSE). Third-party material keeps its+own terms, listed in+[fluxer_static/THIRD_PARTY_LICENSES.md](./fluxer_static/THIRD_PARTY_LICENSES.md).++Public availability of this repository does not grant trademark, brand, or+endorsement rights.++[win-setup-x64]: https://pkgs.fluxer.com/desktop/stable/win32/x64/latest/setup+[win-setup-arm64]: https://pkgs.fluxer.com/desktop/stable/win32/arm64/latest/setup+[win-portable-x64]: https://pkgs.fluxer.com/desktop/stable/win32/x64/latest/portable+[win-portable-arm64]: https://pkgs.fluxer.com/desktop/stable/win32/arm64/latest/portable+[mac-dmg]: https://pkgs.fluxer.com/desktop/stable/darwin/arm64/latest/dmg+[linux-deb-x64]: https://pkgs.fluxer.com/desktop/stable/linux/x64/latest/deb+[linux-deb-arm64]: https://pkgs.fluxer.com/desktop/stable/linux/arm64/latest/deb+[linux-rpm-x64]: https://pkgs.fluxer.com/desktop/stable/linux/x64/latest/rpm+[linux-rpm-arm64]: https://pkgs.fluxer.com/desktop/stable/linux/arm64/latest/rpm+[linux-appimage-x64]: https://pkgs.fluxer.com/desktop/stable/linux/x64/latest/appimage+[linux-appimage-arm64]: https://pkgs.fluxer.com/desktop/stable/linux/arm64/latest/appimage+[linux-targz-x64]: https://pkgs.fluxer.com/desktop/stable/linux/x64/latest/tar_gz+[linux-targz-arm64]: https://pkgs.fluxer.com/desktop/stable/linux/arm64/latest/tar_gz+[flatpak-ref]: https://pkgs.fluxer.com/flatpak/fluxer.flatpakref+[android-apk]: https://github.com/fluxerapp/flutter_client/releases+[obtainium]: https://obtainium.imranr.dev/+[ios-testflight]: https://testflight.apple.com/join/PKZR6pK9+[docs]: https://docs.fluxer.app+[docs-downloads]: https://docs.fluxer.app/downloads/overview/+[docs-linux]: https://docs.fluxer.app/downloads/linux-repositories/+[docs-selfhost]: https://docs.fluxer.app/operator/get-started/