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 3780d22e..2f5215b4 100644 Binary files a/man/freedombone-template.1.gz and b/man/freedombone-template.1.gz differ diff --git a/website/EN/devguide.html b/website/EN/devguide.html index 4192ddee..e5124251 100644 --- a/website/EN/devguide.html +++ b/website/EN/devguide.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + @@ -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.