Mercurial > libervia-backend
view INSTALL @ 2144:1d3f73e065e1
core, jp: component handling + client handling refactoring:
- SàT can now handle components
- plugin have now a "modes" key in PLUGIN_INFO where they declare if they can be used with clients and or components. They default to be client only.
- components are really similar to clients, but with some changes in behaviour:
* component has "entry point", which is a special plugin with a componentStart method, which is called just after component is connected
* trigger end with a different suffixes (e.g. profileConnected vs profileConnectedComponent), so a plugin which manage both clients and components can have different workflow
* for clients, only triggers of plugins handling client mode are launched
* for components, only triggers of plugins needed in dependencies are launched. They all must handle component mode.
* component have a sendHistory attribute (False by default) which can be set to True to allow saving sent messages into history
* for convenience, "client" is still used in method even if it can now be a component
* a new "component" boolean attribute tells if we have a component or a client
* components have to add themselve Message protocol
* roster and presence protocols are not added for components
* component default port is 5347 (which is Prosody's default port)
- asyncCreateProfile has been renamed for profileCreate, both to follow new naming convention and to prepare the transition to fully asynchronous bridge
- createProfile has a new "component" attribute. When used to create a component, it must be set to a component entry point
- jp: added --component argument to profile/create
- disconnect bridge method is now asynchronous, this way frontends can know when disconnection is finished
- new PI_* constants for PLUGIN_INFO values (not used everywhere yet)
- client/component connection workflow has been moved to their classes instead of being a host methods
- host.messageSend is now client.sendMessage, and former client.sendMessage is now client.sendMessageData.
- identities are now handled in client.identities list, so it can be updated dynamically by plugins (in the future, frontends should be able to update them too through bridge)
- profileConnecting* profileConnected* profileDisconnected* and getHandler now all use client instead of profile
author | Goffi <goffi@goffi.org> |
---|---|
date | Sun, 12 Feb 2017 17:55:43 +0100 |
parents | 1128feb54180 |
children | e7bd2945518f |
line wrap: on
line source
You can install SàT automatically using easy_install or pip, and it is available in several GNU/Linux distributions. The full instructions are available on the wiki: http://wiki.goffi.org/wiki/Salut_%C3%A0_Toi Below is are installation instructions, but please check the wiki which may be more up-to-date. *** You can automatically install SàT and its dependencies using easy_install or pip. You will however need to install Python's headers (needed to build some packages), WxPython which is available in most Gnu/Linux distributions, PyGObject and developments version of libxml2 and libxslt (to compile lxml python library). The environment variable SAT_INSTALL customises the installation, it contains flags separated by spaces: - "nopreinstall" skips all preinstallation checks - "autodeb" automatically installs missing packages on Debian-based distributions - "nox" disables installation of X-based packages (WxWidgets), this is useful for servers PyGobject is automatically installed on Debian-based distributions if "autodeb" option is set. Indeed, on Debian-based distribution, you can type (with the root account): # apt-get install python-pip python-dev libxml2-dev libxslt-dev # SAT_INSTALL=autodeb pip install . On a *buntu, same commands with sudo: $ sudo apt-get install python-pip python-dev libxml2-dev libxslt-dev $ sudo SAT_INSTALL=autodeb pip install . After installing SàT, you need to install the media: $ mkdir -p ~/sat/media/destination/path $ cd ~/sat/media/destination/path wget ftp://ftp.goffi.org/sat_media/sat_media.tar.bz2 tar -jxvf sat_media.tar.bz2 then, create a ~/.sat.conf file which contains: ### sat.conf ### [DEFAULT] media_dir=~/sat/media/destination/path ### end sat.conf ### Of course, replace ~/sat/media/destination/path with the actual path you want to use. Check the wiki for more information about this configuration file: http://wiki.goffi.org/wiki/Configuration/en You should now be able to launch sat: - to launch the backend, enter $ sat - to stop the backend, enter: $ sat stop - to launch Primitivus, enter: $ primitivus then create a profile. - to use jp, follow its help: $ jp --help For Libervia, the web interface, check http://wiki.goffi.org/wiki/Libervia/en If you need help, come the SàT official XMPP room: sat@chat.jabberfr.org