README.md 2.27 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)
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
- gir1.2-soup-2.4
Philipp Hörist's avatar
Philipp Hörist committed
16 17 18

### Optional Runtime Requirements

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

### Compile-time Requirements

31
- python3-setuptools
Philipp Hörist's avatar
Philipp Hörist committed
32 33 34 35


### Installation Procedure

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

38 39 40 41
- [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
42 43 44 45 46 47

#### 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
48
#### Linux
Philipp Hörist's avatar
Philipp Hörist committed
49 50 51 52 53 54 55

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

or

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

Philipp Hörist's avatar
Philipp Hörist committed
56 57 58 59
#### Mac

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

Philipp Hörist's avatar
Philipp Hörist committed
60
#### Developing
Philipp Hörist's avatar
Philipp Hörist committed
61

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

Alexander Krotov's avatar
Alexander Krotov committed
64
After installing all dependencies execute
Philipp Hörist's avatar
Philipp Hörist committed
65

Philipp Hörist's avatar
Philipp Hörist committed
66
``./launch.py``
Philipp Hörist's avatar
Philipp Hörist committed
67

Philipp Hörist's avatar
Philipp Hörist committed
68 69 70 71 72
#### Flatpak

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

#### 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 80 81

Execute gajim with --verbose

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**!

André's avatar
André committed
91
(C) 2003-2019
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.