README.md 2.43 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 (>=2.0.1)
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
- python3-setuptools
Philipp Hörist's avatar
Philipp Hörist committed
17
- gir1.2-soup-2.4
Philipp Hörist's avatar
Philipp Hörist committed
18
- GLib (>=2.60.0)
Philipp Hörist's avatar
Philipp Hörist committed
19
20
21

### Optional Runtime Requirements

Philipp Hörist's avatar
Philipp Hörist committed
22
- python3-pil (pillow) for support of webp avatars
Philipp Hörist's avatar
Philipp Hörist committed
23
- 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
24
- 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
25
- gir1.2-secret-1 for GNOME Keyring or KDE support as password storage
Philipp Hörist's avatar
Philipp Hörist committed
26
- D-Bus running to have gajim-remote working
27
- gir1.2-farstream-0.2, gir1.2-gstreamer-1.0 gir1.2-gst-plugins-base-1.0, gstreamer1.0-plugins-ugly, gstreamer1.0-libav, and gstreamer1.0-gtk3 for audio and video calls
Philipp Hörist's avatar
Philipp Hörist committed
28
29
- gir1.2-gupnpigd-1.0 for better NAT traversing
- gir1.2-networkmanager-1.0 for network lose detection
30
- gir1.2-geoclue-2.0 for sharing your location
André's avatar
André committed
31
- gir1.2-gsound-1.0 for sound on Linux
Philipp Hörist's avatar
Philipp Hörist committed
32
33
34

### Compile-time Requirements

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


### Installation Procedure

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

André's avatar
André committed
43
44
45
46
- [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)
47
- [FreeBSD](https://www.freshports.org/net-im/gajim/)
Philipp Hörist's avatar
Philipp Hörist committed
48

André's avatar
André committed
49
50
51
52
#### Flatpak

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

Philipp Hörist's avatar
Philipp Hörist committed
53
54
#### Snapshots

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

Philipp Hörist's avatar
Philipp Hörist committed
58
#### Linux
Philipp Hörist's avatar
Philipp Hörist committed
59

André's avatar
André committed
60
    pip install .
Philipp Hörist's avatar
Philipp Hörist committed
61

Philipp Hörist's avatar
Philipp Hörist committed
62
63
64
65
#### Mac

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

Philipp Hörist's avatar
Philipp Hörist committed
66
#### Developing
Philipp Hörist's avatar
Philipp Hörist committed
67

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

Alexander Krotov's avatar
Alexander Krotov committed
70
After installing all dependencies execute
Philipp Hörist's avatar
Philipp Hörist committed
71

André's avatar
André committed
72
    ./launch.py
Philipp Hörist's avatar
Philipp Hörist committed
73

Philipp Hörist's avatar
Philipp Hörist committed
74
#### 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

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

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

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