README.md 2.16 KB
Newer Older
Philipp Hörist's avatar
Philipp Hörist committed
1 2 3 4 5
# Welcome to Gajim


### Runtime Requirements

6
- python3.5 or higher
Philipp Hörist's avatar
Philipp Hörist committed
7 8
- python3-gi
- python3-gi-cairo
9
- gir1.2-gtk-3.0 (>=3.22)
Philipp Hörist's avatar
Philipp Hörist committed
10
- python3-nbxmpp (>=0.9.90.4)
André's avatar
André committed
11
- python3-openssl (>=16.2)
Philipp Hörist's avatar
Philipp Hörist committed
12
- python3-cssutils (>=1.0.2)
Philipp Hörist's avatar
Philipp Hörist committed
13
- python3-keyring
14
- python3-precis-i18n
Philipp Hörist's avatar
Philipp Hörist committed
15 16 17

### Optional Runtime Requirements

Philipp Hörist's avatar
Philipp Hörist committed
18
- python3-pil (pillow) for support of webp avatars
Philipp Hörist's avatar
Philipp Hörist committed
19
- gir1.2-avahi-0.6 for zeroconf on Linux or [pybonjour](https://dev.gajim.org/lovetox/pybonjour-python3) on Windows/macOS
Philipp Hörist's avatar
Philipp Hörist committed
20
- gir1.2-gspell-1 and hunspell-LANG where lang is your locale eg. en, fr etc
Philipp Hörist's avatar
Philipp Hörist committed
21
- gir1.2-secret-1 for GNOME Keyring or KDE support as password storage
Philipp Hörist's avatar
Philipp Hörist committed
22
- D-Bus running to have gajim-remote working
Philipp Hörist's avatar
Philipp Hörist committed
23 24 25
- gir1.2-farstream-0.2, gir1.2-gstreamer-1.0 and gir1.2-gst-plugins-base-1.0 for audio and video calls
- gir1.2-gupnpigd-1.0 for better NAT traversing
- gir1.2-networkmanager-1.0 for network lose detection
26
- gir1.2-geoclue-2.0 for sharing your location
Philipp Hörist's avatar
Philipp Hörist committed
27 28 29 30 31 32 33 34

### Compile-time Requirements

- python-setuptools


### Installation Procedure

Philipp Hörist's avatar
Philipp Hörist committed
35 36 37
#### Packages

- [Arch](https://aur.archlinux.org/packages/gajim-git/)
Philipp Hörist's avatar
Philipp Hörist committed
38
- [Debian](https://packages.debian.org/stretch-backports/gajim)
Philipp Hörist's avatar
Philipp Hörist committed
39 40 41 42 43 44

#### Snapshots

- [Daily Linux](https://www.gajim.org/downloads/snap/?M=D)
- [Daily Windows](https://gajim.org/downloads/snap/win)

Philipp Hörist's avatar
Philipp Hörist committed
45
#### Linux
Philipp Hörist's avatar
Philipp Hörist committed
46 47 48 49 50 51 52

``./setup.py install --root=/``

or

``pip install .`` (python-pip is required)

Philipp Hörist's avatar
Philipp Hörist committed
53 54 55 56
#### Mac

see [Wiki](https://dev.gajim.org/gajim/gajim/wikis/help/gajimmacosx#python3brew)

Philipp Hörist's avatar
Philipp Hörist committed
57
#### Developing
Philipp Hörist's avatar
Philipp Hörist committed
58

Alexander Krotov's avatar
Alexander Krotov committed
59
For developing you don't have to install Gajim.
Philipp Hörist's avatar
Philipp Hörist committed
60

Alexander Krotov's avatar
Alexander Krotov committed
61
After installing all dependencies execute
Philipp Hörist's avatar
Philipp Hörist committed
62

Philipp Hörist's avatar
Philipp Hörist committed
63
``./launch.py``
Philipp Hörist's avatar
Philipp Hörist committed
64

Philipp Hörist's avatar
Philipp Hörist committed
65 66 67 68 69
#### Flatpak

see [README](./flatpak/README.md)

#### Windows
Philipp Hörist's avatar
Philipp Hörist committed
70

Philipp Hörist's avatar
Philipp Hörist committed
71 72 73
see [README](./win/README.md)

### Miscellaneous
Philipp Hörist's avatar
Philipp Hörist committed
74

Philipp Hörist's avatar
Philipp Hörist committed
75
#### Debugging
Philipp Hörist's avatar
Philipp Hörist committed
76 77 78

Execute gajim with --verbose

Philipp Hörist's avatar
Philipp Hörist committed
79
#### Links
Philipp Hörist's avatar
Philipp Hörist committed
80 81 82 83 84 85 86 87

- [FAQ](https://dev.gajim.org/gajim/gajim/wikis/help/gajimfaq)
- [Wiki](https://dev.gajim.org/gajim/gajim/wikis/home)



That is all, **enjoy**!

André's avatar
André committed
88
(C) 2003-2019
Philipp Hörist's avatar
Philipp Hörist committed
89 90 91 92
The Gajim Team
[https://gajim.org](https://gajim.org)


André's avatar
André committed
93 94 95
We use original art and parts of sounds and other art from Psi, Gossip, Gnomebaker, Gaim
and some icons from various gnome-icons (mostly Dropline Etiquette) we found at art.gnome.org.
If you think we're violating a license please inform us. Thank you.