Mercurial > libervia-web

comparison INSTALL @ 1521:0d517b596568

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: update installation instruction
author Goffi <goffi@goffi.org>
date Wed, 07 Jun 2023 09:35:36 +0200
parents 1028a9c366d3
children
comparison
equal deleted inserted replaced
1520:88f99488e604 1521:0d517b596568
1 Libervia's installation is currently a bit tricky. Please note that this file instructs 1 You'll find install instructions in documentation (see doc/installation.rst).
2 a minimal configuration of Libervia. For a complete procedure including the installation
3 and configuration of your XMPP server and enabling the blog and directory features,
4 please consult this page on the Salut à Toi wiki:
5 2
6 http://wiki.goffi.org/w/index.php?title=Libervia/en 3 If you need help, come the Libervia official XMPP room: xmpp:libervia@chat.jabberfr.org?join or join us with a web browser via https://chat.jabberfr.org/converse.js/libervia@chat.jabberfr.org
7
8 == Prerequesites ==
9
10 These steps are detailed on the Salut à Toi wiki:
11
12 * install and configure Salut à Toi
13 * install and configure a local XMPP server (we recommend using Prosody)
14 * install sat_pubsub
15
16 == Dependencies ==
17
18 * you need to install the txJSON-RPC and Jinja2 dependencies (as root):
19 pip install txJSON-RPC jinja2
20 * install python2-gobject2 from your distribution repositories. For example:
21 apt-get install python-gobject2
22 * install pyjamas. We use the version which used to be on http://pyj.be, not the fork
23 from http://pyjs.org. Since http://pyj.be has been down for a while, you can retrieve
24 the package from our FTP.
25
26 wget ftp://ftp.goffi.org/pyjamas/pyjamas.tar.bz2
27 tar xvjf pyjamas.tar.bz2
28 cd pyjamas
29 python2.7 bootstrap.py
30
31 Note that we force the python version to 2.7. Salut à Toi and Libervia will be ported
32 to Python 3 after the Twisted framework which is our main dependency.
33 You can check that it works by compiling the helloworld example:
34
35 cd examples/helloworld
36 ./build.sh
37
38 If you have no error message, it should be allright.
39
40 == Install Libervia ==
41
42 * to install Libervia using setuptools, the pyjsbuild executable should be accessible
43 from your environment variable "PATH". The easiest would be:
44
45 cd pyjamas
46 sudo ln -sf `pwd`/bin/pyjsbuild /usr/bin/pyjsbuild
47
48 * clone libervia repository:
49
50 hg clone http://repos.goffi.org/libervia
51
52 * install Libervia:
53
54 cd libervia
55 python setup.py install
56
57 * create an account "libervia@example.net" (replace "example.net" with your
58 domain or virtual host) on your XMPP server, create a profile on SàT named
59 "libervia", and plug the SàT profile to this account with jp or primitivus.
60 jp profile create libervia -j libervia@yourserver.tld -p <libervia_password>
61
62 == Configuration ==
63
64 You can configure the Libervia service from the SàT configuration file, for example:
65
66 [libervia]
67 port = 8080
68 port_https = 8443
69 port_https_ext = 8443
70 connection_type = both
71 ssl_certificate = libervia.pem
72 redirect_to_https = 0
73 security_warning = 1
74 passphrase = <libervia_password>
75 data_dir = ~/workspace/libervia
76
77 Check the wiki for more information: http://wiki.goffi.org/wiki/Configuration/en
78
79 == Usage ==
80
81 The four components must be launched in the following order:
82
83 * prosody
84 * sat_pubsub (with the xmpp domain and password as declared in prosodi.cfg.lua)
85 * sat
86 * libervia's web server
87
88 Your command input would look like that:
89
90 cd prosody && prosodyctl start
91 twistd sat_pubsub --jid=sat-pubsub.<xmpp_domain> --secret=<password>
92 sat
93 libervia
94
95 You can now drop your web browser on http://localhost:8080/libervia.html
96
97 If you encounter any issue, you can ask for help on MUC room sat@chat.jabberfr.org
98 or use the dev mailing list: http://lists.goffi.org