From dce6fca556a0d0b20d2b476f45eefaa29ccacac3 Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Wed, 7 Feb 2018 10:48:03 +0000 Subject: [PATCH] More examples --- doc/EN/devguide.org | 18 ++++++++++++++ man/freedombone-template.1.gz | Bin 1178 -> 1264 bytes website/EN/devguide.html | 44 ++++++++++++++++++++++++++-------- 3 files changed, 52 insertions(+), 10 deletions(-) diff --git a/doc/EN/devguide.org b/doc/EN/devguide.org index 3773ad87..636dccfa 100644 --- a/doc/EN/devguide.org +++ b/doc/EN/devguide.org @@ -56,6 +56,24 @@ freedombone-template --app [name] -e [email] -r [repo url] \ src/freedombone-app-myappname #+end_src +For an app without any database which communicates directly on a particular port through the firewall: + +#+begin_src bash +freedombone-template --app [name] -e [email] -r [repo url] \ + -c [commit] --dir /etc/myappname \ + --daemon yes --port 5000 > \ + src/freedombone-app-myappname +#+end_src + +A generic PHP plus MySql/MariaDB web app which is only available on an onion address: + +#+begin_src bash +freedombone-template --app [name] -e [email] -r [repo url] \ + -c [commit] --php yes -d mariadb \ + --onion yes > \ + src/freedombone-app-myappname +#+end_src + For more details see the manpage: #+begin_src bash diff --git a/man/freedombone-template.1.gz b/man/freedombone-template.1.gz index 3780d22e0fe827687b2f6d0995b575009b21ed3e..2f5215b45de89630b5399e9e31535bb90305d419 100644 GIT binary patch delta 1263 zcmVsxG~wimlL z+QJPCN*qb7B~l?N8!GbgogpRdu45y9NZP=0B#Lu6hi7J(+0`lJ7EziyH5#WL>!uPO zVIL-YKf?*8@MdrS?F1(DbF$e8*ADF~2j@b!qM9VhY<&uUlZ(aq@g#ZD-(OSsfEq15 zJJ9$5F0-ofFl=y;8w;XoT+%yR|9Nq_T%WCs#L_gNc$H(D9Jz0j1+_Nx?F?`)88 zQwytvOg}e&#`(gc`&5OUiqccsc~MnBFPM2_yN?6rqvQ4A>TG#+c6l*Lu1e*=b&eoI z>xdx%4n3H>=gz@Hsj?Cz@_UMag5H>w2j%Gja;Dh}ErpfpAC!={I`a&LS#vYEDsl9c z2@T{!Y2_6q*Fn)Am!#lI7vMP^=8_x&|Mewm$W>K;(H7JCKC130jHPcDdYmGJl<4Vv z+$@Q>q(P@&dB`mCX$qi!WjFO^S{TOgI)vyJBL}O=iE z0u+Bz8ofOME*wFDp`1cp1a2k^Qra3ltJ6*B3`61zSyQn&PkB)IL!-Sl6)c6uDvH0a zNWv239zYXbOQ9$-@t^z0RYuKWI0*>Jj3rOcrr{@1&EPB#r6moQ;8;%sGFBW_J89>M z2%+lPnA3~mh^=9aw5^9tF*0{;Q&=HKww8ZriTOGzy#M9`bQW^gs4O%h+iG|~ysL&I zNJVznHn)|b?_c`rKW|aN-~?Q+4?tQvtWg-$KIj;C+^piF3uaPy5z$2J=y*2?X23sz z=$R~ZR5{7>eoLV-kzH5MX7YuP*yfJ^Se!3^JErEA91cCT?{0l%u;x_;%hM$^RZD-f zyIX&%=I1=8jt+?7ltWRw1N!srMlMZC8jCy<`-uqe!P#uS9f90V>yCc2>m)e|`CiZv z{@ZQl*>1YbNGcqD>wLrLf0S?>+jI2Ue9Uq)^?CCPAuXw_jNU+6j(3Cag-62X{_)*# z@bKpn9x%KP*MwG6{f2>@qNnY|XjEr$Eq{+l0u{MM)XHQbM`f}Fw& zxp9U$eNrI=x&?k^_^%x$!jrYxpHK>91QRGmZXz ZGD~gpJErf(FpqX5{{q5Od^^4k007|;a-skL delta 1176 zcmV;J1ZVs337QFiABzY8?$ml(00XsF-*4MC5PsKRaqvrDYP;!%VF-p|&aWoGk{Gsw zZODp%5>FBriBw4{fr|d|yCWspP7`zwX^^xM#k>3N<9BzQZO$RLh|<)l(Kz*3HzHe#)4=Xm-Nooe_vfM*B9#-98RaS8E&#;5uCFG^rc@4G=O|@p z9Wf-pp$C)q+&OqGRaSyTeoqll&>OSzs60JD&NO?WrLa`i+w5DbU7)nz0Hf>CBF~>Oq1DlZ>&lm6 zCz_D*js#@~!-bSAE?#0@_o4MU?CxLnIrJvEHT4stfvr$nf{5I*uyFUW)~TYIHeL;9 zZGvXDGGRYiDRhB%jd1SKSULDO4$G0m;alt#A5c&z9dM2KGoy1=v=+Dci?J2mW0R2r z6n`L%-kwP=96^DhoI+g$ZYB#-+8RBp(@p3M1Mr2cso0z+92EZ8Xm3pgOQErf;_oYx za*1*eNmIU-LQ!PmKle|ojGDu65)ivKEaa|HS!hJI)$oXTUkyi) zitN5^?kYpyzxCCB-l2k%6L7OW0%_^6MqyCtL@@{Nz!=1%`wTrU4OrRJ6#4?VT-Zhd92=2ZsE^CdJ@OMkPw zTYs+RmprFVj)>uuLs7c}`gy&POOukuB9Fv=BEko7Hkk+8jg{IEQD z_;U#lIlK+mgjQ4ihJl=-r}~XuuXzvF-yeeNqL8^QhWpvU`=5S(?Nj|;-cPQA4B`7+ z#JW4W`A9Xl!hk((3sS77vWC+8#vRV*1rgMyGr}?_ZpwX^bLCu% - + @@ -246,17 +246,17 @@ for the JavaScript code in this tag.

Developers Guide

-
-

Introduction

-
+
+

Introduction

+

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 Code of Conduct, and there is a Matrix room at #fbone:matrix.freedombone.net

-
-

Adding extra apps

-
+
+

Adding extra apps

+

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.

@@ -312,6 +312,30 @@ For a Python app without any database, communicating between the daemon and the
+

+For an app without any database which communicates directly on a particular port through the firewall: +

+ +
+
freedombone-template --app [name] -e [email] -r [repo url] \
+                     -c [commit] --dir /etc/myappname \
+                     --daemon yes --port 5000 > \
+                     src/freedombone-app-myappname
+
+
+ +

+A generic PHP plus MySql/MariaDB web app which is only available on an onion address: +

+ +
+
freedombone-template --app [name] -e [email] -r [repo url] \
+                     -c [commit] --php yes -d mariadb \
+                     --onion yes > \
+                     src/freedombone-app-myappname
+
+
+

For more details see the manpage:

@@ -344,9 +368,9 @@ Submit your working app to -

Customising mesh images

-
+
+

Customising mesh images

+

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 img/backgrounds and to change the available avatars and desktop icons edit the images within img/avatars. Re-create disk images using the instructions shown previously.