Salut à Toi Docker files
(c) Jérôme Poisson aka Goffi 2014-2016

This directory and all subdirectories are files to manage Salut à Toi or its related applications/frontends with Docker
Salut à Toi is an XMPP multi-frontends multi-purposes client (see http://salut-a-toi.org)
All file in this directory or subdirectories are under AGPL v3+


############
# LICENCE  #
############

SàT is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

SàT is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with SàT.  If not, see <http://www.gnu.org/licenses/>.


#########
# ABOUT #
#########

The files in subdirectories are Dockerfile needed to build the various images.
The do_all.sh script is used to do action (like building) on all images in the good order.
The libervia_cont.sh is the manager script, which simplify the launching, stopping, updating, etc of Libervia container.

You can find up-to-date instructions on http://wiki.goffi.org/wiki/Docker/en

Following sections explain in more details how to use everything


####################
# do_all.sh script #
####################

This script is used mainly to build images. You normaly don't need it as image should be on Docker hub and will be downloaded automaticaly, but it can be useful if you want to build images for a different architecture (e.g. ARM), or if you want to modify images.

************
* building *
************

To build all the images in the good orders, just do:
$ ./do_all.sh build [ARGS]

ARGS are Docker args, so you can use for example:
$ ./do_all.sh build --no-cache

***********
* pushing *
***********

If you want to push your own images, you'll need to change ACCOUNT variable in the script, then you can do:
$ ./do_all.sh push


###########################
# libervia_cont.sh script #
###########################

This script manage the launch of Libervia container and its dependencies.

***********
* running *
***********

To launch Libervia, just enter:
$ ./libervia_cont.sh

If you have not the images locally, Docker will automatically download them.

If everything is alright, at the end you should have the ports used and some instruction.

If you want to tune the launch, you can use the following syntax:

$ ./libervia_cont.sh run [ARGS...]

********
* stop *
********

To stop Libervia and its dependencies, enter:
$ ./libervia_cont.sh stop

The containers will be stopped then removed.
Note that the data container (sat_data) will not be deleted, as it is were your persistent data are stocked. If you want to delete it, you need to do it manually (be sure to have backuped before that, as it will remove everything !)

**********
* backup *
**********

Backup is easy with the managed, enter the following command:
$ ./libervia_cont.sh backup

This will create a tar.gz archive of persistent data, the name contain the date of the archive creation.

**********
* update *
**********

Updating is done by entering the following command
$ ./libervia_cont.sh update

**********
* ports  *
**********

You can get the list of ports used locally with the following command:
$ ./libervia_cont.sh ports


###########
# IMAGES  #
###########

Here is a description of each image:

- base: the main images used to build everything. It contains several helping scripts to easy automatic configuration
- data: this image build the container which will keep all the persistent data (sat_data)
- jp: CLI frontend (note that it's better to used it directly on your host, i.e. not with Docker, if you want to use it seriously)
- libervia: the web frontend, the one launched (with its dependencies) with libervia_cont.sh script
- media: base images + media used by frontends
- primitivus: the console interface frontend
- prosody: Prosody XMPP server specially tuned to be used by Libervia
- salut: directory component, which is plugged to Prosody
- sat: the Salut à Toi backend
- sat_nomedia: the Salut à Toi backend without media, if you only use text frontends, you don't need the media
- sat_pubsub: PubSub component created for the Salut à Toi project, the container will plug itself to Prosody


###########
# CONTACT #
###########

You can join us on the XMPP MUC room (sat@chat.jabberfr.org), or individually:

Goffi:
	- goffi@goffi.org (e-mail)
	- goffi@jabber.fr (jid)
	- http://www.goffi.org (blog, with fresh news about SàT)

Souliane:
	- souliane@mailoo.org (e-mail)
	- souliane@libervia.org (jid)

You'll find the latest version and other stuffs on *.goffi.org websites:
	- wiki (wiki.goffi.org), in French & English so far
	- ftp (ftp.goffi.org) for the latest version, or previous ones (and other projects)
	- bugtracker (bugs.goffi.org) to report any problem or give suggestions
	- mailing lists (lists.goffi.org)

and the official SàT website is at http://www.salut-a-toi.org