view INSTALL @ 2109:85f3e12e984d

core (memory/cache): file caching handling, first draft: instead of having file caching handled individually by plugins, a generic module has been added in memory. - Cache can be global or associated to a profile. In the later case, client.cache can be used. - Cache are managed with unique ids (which can be any unique unicode, hash uuid, or something else). - To know if a file is in cache, getFilePath is used: if the file is in cache, its absolute path is returned, else None is returned. - To cache a file, cacheData is used with at list the source of cache (most of time plugin import name), and unique id. The method return file opened in binary writing mode (so cacheData can - and should - be used with "with" statement). - 2 files will be created: a metadata file (named after the unique id), and the actual file. - each file has a end of life time, after it, the cache is invalidated and the file must be requested again.
author Goffi <goffi@goffi.org>
date Thu, 05 Jan 2017 20:23:38 +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