free
/
freedombone
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
Browse Source

More examples

Bob Mottram 7 years ago
parent
3788bd3ae6
commit
dce6fca556
3 changed files with 52 additions and 10 deletions
Split View Show Diff Stats
  1. 18
    0
      doc/EN/devguide.org
  2. BIN
      man/freedombone-template.1.gz
  3. 34
    10
      website/EN/devguide.html

+ 18
- 0
doc/EN/devguide.org View File 

@@ -56,6 +56,24 @@ freedombone-template --app [name] -e [email] -r [repo url] \
56 56 
                      src/freedombone-app-myappname
57 57 
 #+end_src
58 58
59 
+For an app without any database which communicates directly on a particular port through the firewall:
60 
+
61 
+#+begin_src bash
62 
+freedombone-template --app [name] -e [email] -r [repo url] \
63 
+                     -c [commit] --dir /etc/myappname \
64 
+                     --daemon yes --port 5000 > \
65 
+                     src/freedombone-app-myappname
66 
+#+end_src
67 
+
68 
+A generic PHP plus MySql/MariaDB web app which is only available on an onion address:
69 
+
70 
+#+begin_src bash
71 
+freedombone-template --app [name] -e [email] -r [repo url] \
72 
+                     -c [commit] --php yes -d mariadb \
73 
+                     --onion yes > \
74 
+                     src/freedombone-app-myappname
75 
+#+end_src
76 
+
59 77 
 For more details see the manpage:
60 78
61 79 
 #+begin_src bash

BIN
man/freedombone-template.1.gz View File


+ 34
- 10
website/EN/devguide.html View File 

@@ -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-07 Wed 10:26 -->
6 
+<!-- 2018-02-07 Wed 10:46 -->
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-orgad5002e" class="outline-2">
250 
-<h2 id="orgad5002e">Introduction</h2>
251 
-<div class="outline-text-2" id="text-orgad5002e">
249 
+<div id="outline-container-orgcb772bb" class="outline-2">
250 
+<h2 id="orgcb772bb">Introduction</h2>
251 
+<div class="outline-text-2" id="text-orgcb772bb">
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-org8600e6f" class="outline-2">
258 
-<h2 id="org8600e6f">Adding extra apps</h2>
259 
-<div class="outline-text-2" id="text-org8600e6f">
257 
+<div id="outline-container-org8fd5474" class="outline-2">
258 
+<h2 id="org8fd5474">Adding extra apps</h2>
259 
+<div class="outline-text-2" id="text-org8fd5474">
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>
 
@@ -313,6 +313,30 @@ For a Python app without any database, communicating between the daemon and the
313 313 
 </div>
314 314
315 315 
 <p>
316 
+For an app without any database which communicates directly on a particular port through the firewall:
317 
+</p>
318 
+
319 
+<div class="org-src-container">
320 
+<pre class="src src-bash">freedombone-template --app [name] -e [email] -r [repo url] <span class="org-sh-escaped-newline">\</span>
321 
+                     -c [commit] --dir /etc/myappname <span class="org-sh-escaped-newline">\</span>
322 
+                     --daemon yes --port 5000 &gt; <span class="org-sh-escaped-newline">\</span>
323 
+                     src/freedombone-app-myappname
324 
+</pre>
325 
+</div>
326 
+
327 
+<p>
328 
+A generic PHP plus MySql/MariaDB web app which is only available on an onion address:
329 
+</p>
330 
+
331 
+<div class="org-src-container">
332 
+<pre class="src src-bash">freedombone-template --app [name] -e [email] -r [repo url] <span class="org-sh-escaped-newline">\</span>
333 
+                     -c [commit] --php yes -d mariadb <span class="org-sh-escaped-newline">\</span>
334 
+                     --onion yes &gt; <span class="org-sh-escaped-newline">\</span>
335 
+                     src/freedombone-app-myappname
336 
+</pre>
337 
+</div>
338 
+
339 
+<p>
316 340 
 For more details see the manpage:
317 341 
 </p>
318 342 
 
@@ -344,9 +368,9 @@ Submit your working app to <b><a href="https://github.com/bashrc/freedombone/iss
344 368 
 </div>
345 369 
 </div>
346 370
347 
-<div id="outline-container-org14991ba" class="outline-2">
348 
-<h2 id="org14991ba">Customising mesh images</h2>
349 
-<div class="outline-text-2" id="text-org14991ba">
371 
+<div id="outline-container-orgaefd9da" class="outline-2">
372 
+<h2 id="orgaefd9da">Customising mesh images</h2>
373 
+<div class="outline-text-2" id="text-orgaefd9da">
350 374 
 <p>
351 375 
 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.
352 376 
 </p>