Installation#
System package manager installation#
Arch Linux#
You can either install the
platypush
package (for the
latest stable version) or the
platypush-git
package
(for the latest git version) through your favourite AUR package manager. For
example, using yay
:
$ yay platypush
# Or
$ yay platypush-git
The Arch Linux packages on AUR are automatically updated upon new git commits or tags.
Debian/Ubuntu#
Currently the following releases are supported:
The current Debian
stable
Debian
oldstable
Ubuntu supported to be added soon.
Add the Platypush APT key to your trusted keyring:
# wget -q -O \
/etc/apt/trusted.gpg.d/platypush.asc \
https://apt.platypush.tech/pubkey.txt
Add the Platypush repository to your APT sources:
# wget -q -O \
/etc/apt/sources.list.d/platypush.list \
https://apt.platypush.tech/lists/platypush-<deb_version>-<branch>.list
Where:
deb_version
can be either stable (for the current Debian stable version) or oldstable (for the previous Debian stable version)branch
can be either main (for the latest releases) or dev (for a package that is always in sync with the git version)
For example, to install the latest stable tags on Debian stable:
# wget -q -O \
/etc/apt/sources.list.d/platypush.list \
https://apt.platypush.tech/lists/platypush-stable-main.list
Update your repos and install Platypush:
# apt update
# apt install platypush
Fedora#
RPM builds targeting the latest Fedora release are automatically built on every push pipeline.
To install Platypush via RPM on Fedora:
Add the Platypush RPM repository configuration to the package manager:
# yum config-manager --add-repo https://rpm.platypush.tech/platypush.repo
Install Platypush, either the latest stable release or the rolling release updated on every commit to the main branch:
# yum install platypush
# Or
# yum install platypush-git
pip
#
$ pip install platypush
Or, for the latest git version:
# Official repo
$ pip install git+https://git.platypush.tech/platypush/platypush
# Github mirror
$ pip install git+https://github.com/blacklight/platypush
Docker#
$ git clone https://git.platypush.tech/platypush/platypush.git
$ cd platypush
# Copy .env.example to .env and edit docker-compose.yml if required.
# In particular, you may want /etc/platypush and /var/lib/platypush
# to point to directories on your hosts
$ docker compose up
Note that the default Dockerfile
uses Alpine, but in docker-compose.yml
you
can also specify an alternative Dockerfile
- Debian, Ubuntu and Fedora are
supported.
Manual installation#
$ git clone https://git.platypush.tech/platypush/platypush.git
$ cd platypush
$ pip install .