README.md 2.21 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 11
- python3-nbxmpp
- python3-openssl (>=0.14)
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
Philipp Hörist's avatar
Philipp Hörist committed
14 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
- python3-gnupg to enable GPG encryption
20
- For zeroconf (bonjour) you need python3-dbus
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 31 32 33 34 35 36
- 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

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

Alexander Krotov's avatar
Alexander Krotov committed
63
After installing all dependencies 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

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


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