Mercurial > sat_docs

comparison docker/README @ 21:0e78c8a4626e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added Dockerfiles to create Docker images for easy installation + scripts to manages them. see README for details.
author Goffi <goffi@goffi.org>
date Sun, 19 Oct 2014 15:14:40 +0200
parents
children 686a8c982c3f
comparison
equal deleted inserted replaced
20:703a394b9780 21:0e78c8a4626e
1 Salut à Toi Docker files
2 (c) Jérôme Poisson aka Goffi 2014
3
4 This directory and all subdirectories are files to manage Salut à Toi or its related applications/frontends with Docker
5 Salut à Toi is an XMPP multi-frontends multi-purposes client (see http://salut-a-toi.org)
6 All file in this directory or subdirectories are une AGPL v3+
7
8
9 ############
10 # LICENCE #
11 ############
12
13 SàT is free software: you can redistribute it and/or modify
14 it under the terms of the GNU Affero General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 SàT is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 GNU Affero General Public License for more details.
22
23 You should have received a copy of the GNU Affero General Public License
24 along with SàT. If not, see <http://www.gnu.org/licenses/>.
25
26
27 #########
28 # ABOUT #
29 #########
30
31 The files in subdirectories are Dockerfile needed to build the various images.
32 The do_all.sh script is used to do action (like building) on all images in the good order.
33 The libervia_cont.sh is the manager script, which simplify the launching, stopping, updating, etc of Libervia container.
34
35 You can find up-to-date instructions on http://wiki.goffi.org/wiki/Docker/en
36
37 Following sections explain in more details how to use everything
38
39
40 ####################
41 # do_all.sh script #
42 ####################
43
44 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.
45
46 ************
47 * building *
48 ************
49
50 To build all the images in the good orders, just do:
51 $ ./do_all.sh build [ARGS]
52
53 ARGS are Docker args, so you can use for example:
54 $ ./do_all.sh build --no-cache
55
56 ***********
57 * pushing *
58 ***********
59
60 If you want to push your own images, you'll need to change ACCOUNT variable in the script, then you can do:
61 $ ./do_all.sh push
62
63
64 ###########################
65 # libervia_cont.sh script #
66 ###########################
67
68 This script manage the launch of Libervia container and its dependencies.
69
70 ***********
71 * running *
72 ***********
73
74 To launch Libervia, just enter:
75 $ ./libervia_cont.sh
76
77 If you have not the images locally, Docker will automatically download them.
78
79 If everything is alright, at the end you should have the ports used and some instruction.
80
81 If you want to tune the launch, you can use the following syntax:
82
83 $ ./libervia_cont.sh run [ARGS...]
84
85 ********
86 * stop *
87 ********
88
89 To stop Libervia and its dependencies, enter:
90 $ ./libervia_cont.sh stop
91
92 The containers will be stopped then removed.
93 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 !)
94
95 **********
96 * backup *
97 **********
98
99 Backup is easy with the managed, enter the following command:
100 $ ./libervia_cont.sh backup
101
102 This will create a tar.gz archive of persistent data, the name contain the date of the archive creation.
103
104 **********
105 * update *
106 **********
107
108 Updating is done by entering the following command
109 $ ./libervia_cont.sh update
110
111 **********
112 * ports *
113 **********
114
115 You can get the list of ports used locally with the following command:
116 $ ./libervia_cont.sh ports
117
118
119 ###########
120 # IMAGES #
121 ###########
122
123 Here is a description of each image:
124
125 - base: the main images used to build everything. It contains several helping scripts to easy automatic configuration
126 - data: this image build the container which will keep all the persistent data (sat_data)
127 - 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)
128 - libervia: the web frontend, the one launched (with its dependencies) with libervia_cont.sh script
129 - media: base images + media used by frontends
130 - primitivus: the console interface frontend
131 - prosody: Prosody XMPP server specially tuned to be used by Libervia
132 - salut: directory component, which is plugged to Prosody
133 - sat: the Salut à Toi backend
134 - sat_nomedia: the Salut à Toi backend without media, if you only use text frontends, you don't need the media
135 - sat_pubsub: PubSub component created for the Salut à Toi project, the container will plug itself to Prosody
136
137
138 ###########
139 # CONTACT #
140 ###########
141
142 You can join us on the XMPP MUC room (sat@chat.jabberfr.org), or individually:
143
144 Goffi:
145 - goffi@goffi.org (e-mail)
146 - goffi@jabber.fr (jid)
147 - http://www.goffi.org (blog, with fresh news about SàT)
148
149 Souliane:
150 - souliane@mailoo.org (e-mail)
151 - souliane@libervia.org (jid)
152
153 You'll find the latest version and other stuffs on *.goffi.org websites:
154 - wiki (wiki.goffi.org), in French & English so far
155 - ftp (ftp.goffi.org) for the latest version, or previous ones (and other projects)
156 - bugtracker (bugs.goffi.org) to report any problem or give suggestions
157 - mailing lists (lists.goffi.org)
158
159 and the official SàT website is at http://www.salut-a-toi.org