Mercurial > sat_docs

comparison docker_legacy/README @ 164:29873a41aae1

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