Selaa lähdekoodia

Documentation including internal port

Bob Mottram 7 vuotta sitten
vanhempi
commit
f74db8a922
3 muutettua tiedostoa jossa 14 lisäystä ja 14 poistoa
  1. 2
    2
      doc/EN/devguide.org
  2. BIN
      man/freedombone-template.1.gz
  3. 12
    12
      website/EN/devguide.html

+ 2
- 2
doc/EN/devguide.org Näytä tiedosto

@@ -47,12 +47,12 @@ freedombone-template --app [name] -e [email] -r [repo url] \
47 47
                      src/freedombone-app-myappname
48 48
 #+end_src
49 49
 
50
-For a Python app without any database:
50
+For a Python app without any database, communicating between the daemon and the web server on port 1234:
51 51
 
52 52
 #+begin_src bash
53 53
 freedombone-template --app [name] -e [email] -r [repo url] \
54 54
                      -c [commit] --dir /etc/myappname \
55
-                     --daemon yes > \
55
+                     --daemon yes --portinternal 1234 > \
56 56
                      src/freedombone-app-myappname
57 57
 #+end_src
58 58
 

BIN
man/freedombone-template.1.gz Näytä tiedosto


+ 12
- 12
website/EN/devguide.html Näytä tiedosto

@@ -3,7 +3,7 @@
3 3
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 4
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
5 5
 <head>
6
-<!-- 2018-02-06 Tue 22:30 -->
6
+<!-- 2018-02-07 Wed 10:16 -->
7 7
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
8 8
 <meta name="viewport" content="width=device-width, initial-scale=1" />
9 9
 <title>&lrm;</title>
@@ -246,17 +246,17 @@ for the JavaScript code in this tag.
246 246
 
247 247
 <center><h1>Developers Guide</h1></center>
248 248
 
249
-<div id="outline-container-org3cc200b" class="outline-2">
250
-<h2 id="org3cc200b">Introduction</h2>
251
-<div class="outline-text-2" id="text-org3cc200b">
249
+<div id="outline-container-org5ea27e4" class="outline-2">
250
+<h2 id="org5ea27e4">Introduction</h2>
251
+<div class="outline-text-2" id="text-org5ea27e4">
252 252
 <p>
253 253
 Freedombone consists of a set of bash scripts. There are a lot of them, but they're not very complicated. If you're familiar with the GNU/Linux commandline and can hack a bash script then you can probably add a new app or fix a bug in the system. There are no trendy development frameworks to learn or to get in your way. You might also want to consult the <a href="./codeofconduct.html">Code of Conduct</a>, and there is a Matrix room at <b>#fbone:matrix.freedombone.net</b>
254 254
 </p>
255 255
 </div>
256 256
 </div>
257
-<div id="outline-container-org5149f2a" class="outline-2">
258
-<h2 id="org5149f2a">Adding extra apps</h2>
259
-<div class="outline-text-2" id="text-org5149f2a">
257
+<div id="outline-container-orgce16dbb" class="outline-2">
258
+<h2 id="orgce16dbb">Adding extra apps</h2>
259
+<div class="outline-text-2" id="text-orgce16dbb">
260 260
 <p>
261 261
 Suppose you have some internet application which you want to add to the system. To do this you need to create an app script which tells the system how to install/remove and also backup/restore. The script should be designed to work with the current stable version of Debian.
262 262
 </p>
@@ -301,13 +301,13 @@ For a Python app with Postgresql database:
301 301
 </div>
302 302
 
303 303
 <p>
304
-For a Python app without any database:
304
+For a Python app without any database, communicating between the daemon and the web server on port 1234:
305 305
 </p>
306 306
 
307 307
 <div class="org-src-container">
308 308
 <pre class="src src-bash">freedombone-template --app [name] -e [email] -r [repo url] <span class="org-sh-escaped-newline">\</span>
309 309
                      -c [commit] --dir /etc/myappname <span class="org-sh-escaped-newline">\</span>
310
-                     --daemon yes &gt; <span class="org-sh-escaped-newline">\</span>
310
+                     --daemon yes --portinternal 1234 &gt; <span class="org-sh-escaped-newline">\</span>
311 311
                      src/freedombone-app-myappname
312 312
 </pre>
313 313
 </div>
@@ -340,9 +340,9 @@ Submit your working app to <b><a href="https://github.com/bashrc/freedombone/iss
340 340
 </div>
341 341
 </div>
342 342
 
343
-<div id="outline-container-orgd731678" class="outline-2">
344
-<h2 id="orgd731678">Customising mesh images</h2>
345
-<div class="outline-text-2" id="text-orgd731678">
343
+<div id="outline-container-org9d33f36" class="outline-2">
344
+<h2 id="org9d33f36">Customising mesh images</h2>
345
+<div class="outline-text-2" id="text-org9d33f36">
346 346
 <p>
347 347
 If you want to make your own specially branded version of the mesh images, such as for a particular event, then to change the default desktop backgrounds edit the images within <b>img/backgrounds</b> and to change the available avatars and desktop icons edit the images within <b>img/avatars</b>. Re-create disk images using the instructions shown previously.
348 348
 </p>