README.md 2.32 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
André's avatar
André committed
28
- gir1.2-gsound-1.0 for sound on Linux
Philipp Hörist's avatar
Philipp Hörist committed
29 30 31

### Compile-time Requirements

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


### Installation Procedure

Philipp Hörist's avatar
Philipp Hörist committed
38 39
#### Packages

André's avatar
André committed
40 41 42 43
- [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
44 45 46 47 48 49

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

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

or

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

Philipp Hörist's avatar
Philipp Hörist committed
58 59 60 61
#### Mac

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

Philipp Hörist's avatar
Philipp Hörist committed
62
#### Developing
Philipp Hörist's avatar
Philipp Hörist committed
63

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

Alexander Krotov's avatar
Alexander Krotov committed
66
After installing all dependencies execute
Philipp Hörist's avatar
Philipp Hörist committed
67

Philipp Hörist's avatar
Philipp Hörist committed
68
``./launch.py``
Philipp Hörist's avatar
Philipp Hörist committed
69

Philipp Hörist's avatar
Philipp Hörist committed
70 71 72 73 74
#### Flatpak

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

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

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

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

Philipp Hörist's avatar
Philipp Hörist committed
80
#### Debugging
Philipp Hörist's avatar
Philipp Hörist committed
81 82 83

Execute gajim with --verbose

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

- [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
93
(C) 2003-2020
Philipp Hörist's avatar
Philipp Hörist committed
94 95 96 97
The Gajim Team
[https://gajim.org](https://gajim.org)


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