README.md 2.57 KB
Newer Older
Philipp Hörist's avatar
Philipp Hörist committed
1
2
3
4
# Welcome to Gajim

### Runtime Requirements

Philipp Hörist's avatar
Philipp Hörist committed
5
- python3.9 or higher
Philipp Hörist's avatar
Philipp Hörist committed
6
7
- python3-gi
- python3-gi-cairo
Philipp Hörist's avatar
Philipp Hörist committed
8
- python3-nbxmpp (>=2.99.0)
André's avatar
André committed
9
- python3-openssl (>=16.2)
10
- python3-css-parser
Philipp Hörist's avatar
Philipp Hörist committed
11
- python3-keyring
12
- python3-precis-i18n
Philipp Hörist's avatar
Philipp Hörist committed
13
- python3-packaging
14
- python3-pil
Philipp Hörist's avatar
Philipp Hörist committed
15
- python3-setuptools
16
- Gtk3 (>=3.22)
Philipp Hörist's avatar
Philipp Hörist committed
17
- GLib (>=2.60.0)
18
19
- gir1.2-gtksource-4
- gir1.2-soup-2.4
Philipp Hörist's avatar
Philipp Hörist committed
20
21
22

### Optional Runtime Requirements

23
- python3-sentry-sdk for Sentry error reporting to dev.gajim.org (users decide whether to send reports or not)
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
Philipp Hörist's avatar
Philipp Hörist committed
27
28
- gir1.2-gupnpigd-1.0 for better NAT traversing
- gir1.2-networkmanager-1.0 for network lose detection
29
- gir1.2-geoclue-2.0 for sharing your location
André's avatar
André committed
30
- gir1.2-gsound-1.0 for sound on Linux
31
32
33

#### For Video and Audio Calls

34
- gir1.2-farstream-0.2 for video calls
35
36
37
38
39
- gir1.2-gstreamer-1.0 for video and audio calls
- gir1.2-gst-plugins-base-1.0 for video and audio calls
- gstreamer1.0-plugins-ugly for video and audio calls
- gstreamer1.0-libav for video and audio calls
- gstreamer1.0-gtk3 
Philipp Hörist's avatar
Philipp Hörist committed
40
41
42

### Compile-time Requirements

André's avatar
André committed
43
- python3-setuptools
Philipp Hörist's avatar
Philipp Hörist committed
44
- gettext
Philipp Hörist's avatar
Philipp Hörist committed
45

Philipp Hörist's avatar
Philipp Hörist committed
46
47
48
49
### Running Tests

`python -m unittest discover -s test`

Philipp Hörist's avatar
Philipp Hörist committed
50
51
### Installation Procedure

Philipp Hörist's avatar
Philipp Hörist committed
52
53
#### Packages

André's avatar
André committed
54
55
56
57
- [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)
58
- [FreeBSD](https://www.freshports.org/net-im/gajim/)
Philipp Hörist's avatar
Philipp Hörist committed
59

André's avatar
André committed
60
61
62
63
#### Flatpak

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

Philipp Hörist's avatar
Philipp Hörist committed
64
65
#### Snapshots

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

Philipp Hörist's avatar
Philipp Hörist committed
69
#### Linux
Philipp Hörist's avatar
Philipp Hörist committed
70

André's avatar
André committed
71
    pip install .
Philipp Hörist's avatar
Philipp Hörist committed
72

Philipp Hörist's avatar
Philipp Hörist committed
73
74
#### Mac

75
see [Wiki](https://dev.gajim.org/gajim/gajim/-/wikis/help/Gajim-on-macOS)
Philipp Hörist's avatar
Philipp Hörist committed
76

Philipp Hörist's avatar
Philipp Hörist committed
77
#### Developing
Philipp Hörist's avatar
Philipp Hörist committed
78

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

Alexander Krotov's avatar
Alexander Krotov committed
81
After installing all dependencies execute
Philipp Hörist's avatar
Philipp Hörist committed
82

André's avatar
André committed
83
    ./launch.py
Philipp Hörist's avatar
Philipp Hörist committed
84

Philipp Hörist's avatar
Philipp Hörist committed
85
#### Windows
Philipp Hörist's avatar
Philipp Hörist committed
86

Philipp Hörist's avatar
Philipp Hörist committed
87
88
89
see [README](./win/README.md)

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

Philipp Hörist's avatar
Philipp Hörist committed
91
#### Debugging
Philipp Hörist's avatar
Philipp Hörist committed
92

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

Philipp Hörist's avatar
Philipp Hörist committed
95
#### Links
Philipp Hörist's avatar
Philipp Hörist committed
96
97
98
99
100
101

- [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
102
(C) 2003-2022
Philipp Hörist's avatar
Philipp Hörist committed
103
104
105
The Gajim Team
[https://gajim.org](https://gajim.org)

André's avatar
André committed
106
107
108
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.