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


### Runtime Requirements

Philipp Hörist's avatar
Philipp Hörist committed
6
- python3.7 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 (>=1.0.0)
André's avatar
André committed
11
- python3-openssl (>=16.2)
12
- python3-css-parser
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
- python3-packaging
Philipp Hörist's avatar
Philipp Hörist committed
16
- gir1.2-soup-2.4
Philipp Hörist's avatar
Philipp Hörist committed
17
- GLib (>=2.60.0)
Philipp Hörist's avatar
Philipp Hörist committed
18 19 20

### Optional Runtime Requirements

Philipp Hörist's avatar
Philipp Hörist committed
21
- python3-pil (pillow) for support of webp avatars
Philipp Hörist's avatar
Philipp Hörist committed
22
- 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
23
- 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
24
- gir1.2-secret-1 for GNOME Keyring or KDE support as password storage
Philipp Hörist's avatar
Philipp Hörist committed
25
- D-Bus running to have gajim-remote working
Philipp Hörist's avatar
Philipp Hörist committed
26 27 28
- 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
29
- gir1.2-geoclue-2.0 for sharing your location
André's avatar
André committed
30
- gir1.2-gsound-1.0 for sound on Linux
Philipp Hörist's avatar
Philipp Hörist committed
31 32 33

### Compile-time Requirements

André's avatar
André committed
34
- python3-setuptools
Philipp Hörist's avatar
Philipp Hörist committed
35
- gettext
Philipp Hörist's avatar
Philipp Hörist committed
36 37 38 39


### Installation Procedure

Philipp Hörist's avatar
Philipp Hörist committed
40 41
#### Packages

André's avatar
André committed
42 43 44 45
- [Arch Linux](https://www.archlinux.org/packages/community/any/gajim/)
- [Debian](https://packages.debian.org/stable/gajim)
- [Fedora](https://apps.fedoraproject.org/packages/gajim)
- [Ubuntu](https://packages.ubuntu.com/gajim)
Philipp Hörist's avatar
Philipp Hörist committed
46

André's avatar
André committed
47 48 49 50
#### Flatpak

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

Philipp Hörist's avatar
Philipp Hörist committed
51 52
#### Snapshots

André's avatar
André committed
53
- [Daily Linux](https://www.gajim.org/downloads/snap/)
Philipp Hörist's avatar
Philipp Hörist committed
54 55
- [Daily Windows](https://gajim.org/downloads/snap/win)

Philipp Hörist's avatar
Philipp Hörist committed
56
#### Linux
Philipp Hörist's avatar
Philipp Hörist committed
57

André's avatar
André committed
58
    pip install .
Philipp Hörist's avatar
Philipp Hörist committed
59

Philipp Hörist's avatar
Philipp Hörist committed
60 61 62 63
#### Mac

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

Philipp Hörist's avatar
Philipp Hörist committed
64
#### Developing
Philipp Hörist's avatar
Philipp Hörist committed
65

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

Alexander Krotov's avatar
Alexander Krotov committed
68
After installing all dependencies execute
Philipp Hörist's avatar
Philipp Hörist committed
69

André's avatar
André committed
70
    ./launch.py
Philipp Hörist's avatar
Philipp Hörist committed
71

Philipp Hörist's avatar
Philipp Hörist committed
72
#### Windows
Philipp Hörist's avatar
Philipp Hörist committed
73

Philipp Hörist's avatar
Philipp Hörist committed
74 75 76
see [README](./win/README.md)

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

Philipp Hörist's avatar
Philipp Hörist committed
78
#### Debugging
Philipp Hörist's avatar
Philipp Hörist committed
79

André's avatar
André committed
80
Execute gajim with `--verbose`
Philipp Hörist's avatar
Philipp Hörist committed
81

Philipp Hörist's avatar
Philipp Hörist committed
82
#### Links
Philipp Hörist's avatar
Philipp Hörist committed
83 84 85 86 87 88 89 90

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



That is all, **enjoy**!

Philipp Hörist's avatar
Philipp Hörist committed
91
(C) 2003-2020
Philipp Hörist's avatar
Philipp Hörist committed
92 93 94 95
The Gajim Team
[https://gajim.org](https://gajim.org)


André's avatar
André committed
96 97 98
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.