# HG changeset patch # User Goffi # Date 1686123336 -7200 # Node ID 0d517b596568b6e866c81deaa720233e0da1340c # Parent 88f99488e604b08e3d7ba37d85a80ee656c61dbf doc: update installation instruction diff -r 88f99488e604 -r 0d517b596568 INSTALL --- a/INSTALL Wed Jun 07 09:17:05 2023 +0200 +++ b/INSTALL Wed Jun 07 09:35:36 2023 +0200 @@ -1,98 +1,3 @@ -Libervia's installation is currently a bit tricky. Please note that this file instructs -a minimal configuration of Libervia. For a complete procedure including the installation -and configuration of your XMPP server and enabling the blog and directory features, -please consult this page on the Salut à Toi wiki: - -http://wiki.goffi.org/w/index.php?title=Libervia/en - -== Prerequesites == - -These steps are detailed on the Salut à Toi wiki: - -* install and configure Salut à Toi -* install and configure a local XMPP server (we recommend using Prosody) -* install sat_pubsub - -== Dependencies == - -* you need to install the txJSON-RPC and Jinja2 dependencies (as root): - pip install txJSON-RPC jinja2 -* install python2-gobject2 from your distribution repositories. For example: - apt-get install python-gobject2 -* install pyjamas. We use the version which used to be on http://pyj.be, not the fork - from http://pyjs.org. Since http://pyj.be has been down for a while, you can retrieve - the package from our FTP. - - wget ftp://ftp.goffi.org/pyjamas/pyjamas.tar.bz2 - tar xvjf pyjamas.tar.bz2 - cd pyjamas - python2.7 bootstrap.py - -Note that we force the python version to 2.7. Salut à Toi and Libervia will be ported -to Python 3 after the Twisted framework which is our main dependency. -You can check that it works by compiling the helloworld example: - - cd examples/helloworld - ./build.sh - -If you have no error message, it should be allright. - -== Install Libervia == - -* to install Libervia using setuptools, the pyjsbuild executable should be accessible -from your environment variable "PATH". The easiest would be: - - cd pyjamas - sudo ln -sf `pwd`/bin/pyjsbuild /usr/bin/pyjsbuild - -* clone libervia repository: +You'll find install instructions in documentation (see doc/installation.rst). - hg clone http://repos.goffi.org/libervia - -* install Libervia: - - cd libervia - python setup.py install - -* create an account "libervia@example.net" (replace "example.net" with your -domain or virtual host) on your XMPP server, create a profile on SàT named -"libervia", and plug the SàT profile to this account with jp or primitivus. - jp profile create libervia -j libervia@yourserver.tld -p - -== Configuration == - -You can configure the Libervia service from the SàT configuration file, for example: - - [libervia] - port = 8080 - port_https = 8443 - port_https_ext = 8443 - connection_type = both - ssl_certificate = libervia.pem - redirect_to_https = 0 - security_warning = 1 - passphrase = - data_dir = ~/workspace/libervia - -Check the wiki for more information: http://wiki.goffi.org/wiki/Configuration/en - -== Usage == - -The four components must be launched in the following order: - -* prosody -* sat_pubsub (with the xmpp domain and password as declared in prosodi.cfg.lua) -* sat -* libervia's web server - -Your command input would look like that: - - cd prosody && prosodyctl start - twistd sat_pubsub --jid=sat-pubsub. --secret= - sat - libervia - -You can now drop your web browser on http://localhost:8080/libervia.html - -If you encounter any issue, you can ask for help on MUC room sat@chat.jabberfr.org -or use the dev mailing list: http://lists.goffi.org +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 diff -r 88f99488e604 -r 0d517b596568 doc/installation.rst --- a/doc/installation.rst Wed Jun 07 09:17:05 2023 +0200 +++ b/doc/installation.rst Wed Jun 07 09:35:36 2023 +0200 @@ -2,13 +2,14 @@ Installation ============ -This are the instructions to install Libervia (SàT) using Python. -Note that if you are using GNU/Linux, Libervia may already be present on your distribution. +This are the instructions to install Libervia Web using Python. +Note that if you are using GNU/Linux, Libervia Web may already be present on your +distribution. -Libervia is a Salut à Toi frontend, the SàT backend must be installed first (if you +This is the web frontend of Libervia, the Libervia backend must be installed first (if you haven't installed it yet, it will be downloaded automatically as it is a dependency of -Libervia). Libervia and SàT backend must always have the same version (Libervia won't -start if the version backend has not the same version). +Libervia Web). Libervia Web and Libervia Backend must always have the same version +(Libervia Web won't start if the version backend differs). We recommend to use development version for now, until the release of 0.8 version. @@ -49,9 +50,9 @@ $ hg clone https://repos.goffi.org/libervia libervia-web && cd libervia-web -Now you can install the requirements:: +Now you can install the frontend and its requirements:: - $ pip install -r requirements.txt + $ pip install . If you haven't done it for the backend, you need to install the media:: @@ -94,17 +95,18 @@ Where you'll obviously change ``libervia@example.net`` for the JID you want to use, with your domain name. You'll then be prompted for a password. You can now create the -associated SàT profile:: +associated Libervia profile:: - $ jp profile create libervia -j libervia@example.net -p + $ li profile create libervia -j libervia@example.net -p .. note:: - jp doesn't prompt for password yet, this means that the password is visible to anybody - looking at your screen and will stay in your shell history, and the password will be - visible for a few seconds in process list. If this is a concern for you (e.g. you use a - shared machine), use an other frontend to create the profile, or do the necessary to - remove the password from history. + Libervia CLI doesn't prompt for password yet, this means that the password is visible + to anybody looking at your screen and will stay in your shell history, and the password + will be visible for a few seconds in process list. If this is a concern for you (e.g. + you use a shared machine), use an other frontend to create the profile, or do the + necessary to remove the password from history. In most shells, you can add a space in + front of the command so that it doesn't appear in the history. Finally, you need to specify to specify the password of this ``libervia`` profile in your configuration. To do so, edit your ``libervia.conf`` and edit ``[libervia]`` and set the @@ -112,7 +114,7 @@ .. sourcecode:: cfg - [libervia_web] + [web] passphrase = You should now be good to run the Libervia Web server. @@ -140,10 +142,10 @@ $ libervia-web status -SàT Pubsub -========== +Libervia Pubsub +=============== Some functionalities use advanced or experimental features of XMPP PubSub. We recommend to -use the SàT PubSub service that is a side project developed for the needs of Salut à Toi, -and consequently implements everything needed. Please refer to SàT PubSub documentation to -know how to install and use it. +use the Libervia PubSub service that is a side project developed for the needs of +Libervia, and consequently implements everything needed. Please refer to Libervia PubSub +documentation to know how to install and use it.