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

### Runtime Requirements

5
6
7
- [Python](https://www.python.org/) (>=3.9)
- [PyGObject](https://pypi.org/project/PyGObject/)
- [pycairo](https://pypi.org/project/pycairo/)
Philipp Hörist's avatar
Philipp Hörist committed
8
- [nbxmpp](https://pypi.org/project/nbxmpp/) (>=3.1.1)
9
10
11
12
13
14
15
16
17
18
19
- [pyOpenSSL](https://pypi.org/project/pyOpenSSL/) (>=16.2)
- [css-parser](https://pypi.org/project/css-parser/)
- [keyring](https://pypi.org/project/keyring/)
- [precis_i18n](https://pypi.org/project/precis-i18n/)
- [packaging](https://pypi.org/project/packaging/)
- [Pillow](https://pypi.org/project/Pillow/)
- [setuptools](https://pypi.org/project/setuptools/)
- [Gtk3](https://gitlab.com/gnome/gtk) (>=3.22)
- [GLib](https://gitlab.com/gnome/glib) (>=2.60.0)
- [GtkSourceView](https://gitlab.gnome.org/GNOME/gtksourceview)
- [libsoup](https://gitlab.gnome.org/GNOME/libsoup/)
Philipp Hörist's avatar
Philipp Hörist committed
20
21
22

### Optional Runtime Requirements

Philipp Hörist's avatar
Philipp Hörist committed
23
- D-Bus running to have gajim-remote working
24
25
26
27
28
29
30
- [sentry-sdk](https://pypi.org/project/sentry-sdk/) for Sentry error reporting to dev.gajim.org (users decide whether to send reports or not)
- [gspell](https://gitlab.gnome.org/GNOME/gspell) and hunspell-LANG where lang is your locale eg. en, fr etc
- [libsecret](https://gitlab.gnome.org/GNOME/libsecret/) for GNOME Keyring or KDE support as password storage
- [GUPnP-IGD](https://gitlab.gnome.org/GNOME/gupnp) for better NAT traversing
- [NetworkManager](https://gitlab.freedesktop.org/NetworkManager/NetworkManager) for network lose detection
- [GeoClue](https://gitlab.freedesktop.org/geoclue/geoclue) for sharing your location
- [GSound](https://gitlab.gnome.org/GNOME/gsound) for sound on Linux
31
32
33

#### For Video and Audio Calls

34
35
36
37
38
- [Farstream](https://gitlab.freedesktop.org/farstream/farstream)
- [GStreamer](https://gitlab.freedesktop.org/gstreamer/gstreamer)
- [gst-plugins-base](https://gitlab.freedesktop.org/gstreamer/gst-plugins-base)
- [gst-plugins-ugly](https://gitlab.freedesktop.org/gstreamer/gst-plugins-ugly)
- [gst-libav](https://gitlab.freedesktop.org/gstreamer/gst-libav)
Philipp Hörist's avatar
Philipp Hörist committed
39
40
41

### Compile-time Requirements

42
43
- [setuptools](https://pypi.org/project/setuptools/)
- [gettext](https://savannah.gnu.org/projects/gettext/)
Philipp Hörist's avatar
Philipp Hörist committed
44

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

`python -m unittest discover -s test`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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