README.md 2.31 KB
Newer Older
Philipp Hörist's avatar
Philipp Hörist committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
# Welcome to Gajim


### Runtime Requirements

- python3.4 or higher
- python3-gi
- python3-gi-cairo
- gir1.2-gtk-3.0
- python3-nbxmpp
- python3-openssl (>=0.14)
- python3-pyasn1


### Optional Runtime Requirements

Philipp Hörist's avatar
Philipp Hörist committed
17
- python-pillow for support of webp avatars
Philipp Hörist's avatar
Philipp Hörist committed
18 19
- python3-crypto to enable End to end encryption
- python3-gnupg to enable GPG encryption
Philipp Hörist's avatar
Philipp Hörist committed
20
- For zeroconf (bonjour) you need dbus-glib, python-avahi
Philipp Hörist's avatar
Philipp Hörist committed
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
- gir1.2-gtkspell3-3.0 and aspell-LANG where lang is your locale eg. en, fr etc
- gir1.2-secret-1 for GNOME Keyring or KDE support as password storage
- D-Bus running to have gajim-remote working. Some distributions split dbus-x11, which is needed for dbus to work with Gajim. Version >= 0.80 is required.
- python3-dbus bindings (>=1.2.0)
- 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
- python3-idna and python3-precis-i18n for correctly parsing JIDs

### Compile-time Requirements

- python-setuptools


### Installation Procedure

Philipp Hörist's avatar
Philipp Hörist committed
37 38 39 40 41 42 43 44 45 46
#### Packages

- [Arch](https://aur.archlinux.org/packages/gajim-git/)
- [Debian](https://packages.debian.org/source/experimental/gajim) (tested with Debian ``testing`` and ``unstable``)

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

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

or

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

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

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

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

Philipp Hörist's avatar
Philipp Hörist committed
61
For developing you dont have to install Gajim.
Philipp Hörist's avatar
Philipp Hörist committed
62

Philipp Hörist's avatar
Philipp Hörist committed
63
After installing all dependencys execute
Philipp Hörist's avatar
Philipp Hörist committed
64

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

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

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

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

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

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

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

Execute gajim with --verbose

Philipp Hörist's avatar
Philipp Hörist committed
81
#### Links
Philipp Hörist's avatar
Philipp Hörist committed
82 83 84 85 86 87 88 89 90 91 92 93 94 95

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



That is all, **enjoy**!

(C) 2003-2017
The Gajim Team
[https://gajim.org](https://gajim.org)


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.