diff --git a/doc/EN/devguide.org b/doc/EN/devguide.org index b78e3f1d..3b95ffda 100644 --- a/doc/EN/devguide.org +++ b/doc/EN/devguide.org @@ -18,10 +18,11 @@ Suppose you have some internet application which you want to add to the system. There's a command which you can use to generate scripts for new apps. Some examples are as follows: -To create a script for a generic PHP plus MySql/MariaDB web app: +To create a script for a generic PHP plus MySql/MariaDB web app with a couple of extra packages: #+begin_src bash freedombone-template --app [name] -e [email] -r [repo url] \ + --packages "cowsay libssl-dev" \ -c [commit] --php yes -d mariadb > \ src/freedombone-app-myappname #+end_src diff --git a/website/EN/devguide.html b/website/EN/devguide.html index bcd440ff..37a8d262 100644 --- a/website/EN/devguide.html +++ b/website/EN/devguide.html @@ -3,26 +3,33 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - - - - - - + + +‎ + + + - + @@ -97,7 +189,7 @@ @licstart The following is the entire license notice for the JavaScript code in this tag. -Copyright (C) 2012-2013 Free Software Foundation, Inc. +Copyright (C) 2012-2017 Free Software Foundation, Inc. The JavaScript code in this tag is free software: you can redistribute it and/or modify it under the terms of the GNU @@ -144,28 +236,27 @@ for the JavaScript code in this tag.
-

logo.png

-
-

Developers Guide

+
+

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.

@@ -175,13 +266,13 @@ There's a command which you can use to generate scripts for new apps. Some examp

-To create a script for a generic PHP plus MySql/MariaDB web app: +To create a script for a generic PHP plus MySql/MariaDB web app with a couple of extra packages:

- -
freedombone-template --app [name] -e [email] -r [repo url] \
-                     -c [commit] --php yes -d mariadb > \
+
freedombone-template --app [name] -e [email] -r [repo url] \
+                     --packages "cowsay libssl-dev" \
+                     -c [commit] --php yes -d mariadb > \
                      src/freedombone-app-myappname
@@ -191,10 +282,9 @@ For a Nodejs app with MySql/MariaDB database:

- -
freedombone-template --app [name] -e [email] -r [repo url] \
-                     -c [commit] --node yes -d mariadb \
-                     --dir /etc/myappname --daemon yes > \
+
freedombone-template --app [name] -e [email] -r [repo url] \
+                     -c [commit] --node yes -d mariadb \
+                     --dir /etc/myappname --daemon yes > \
                      src/freedombone-app-myappname
@@ -204,10 +294,9 @@ For a Python app with Postgresql database:

- -
freedombone-template --app [name] -e [email] -r [repo url] \
-                     -c [commit] -d postgresql \
-                     --dir /etc/myappname --daemon yes > \
+
freedombone-template --app [name] -e [email] -r [repo url] \
+                     -c [commit] -d postgresql \
+                     --dir /etc/myappname --daemon yes > \
                      src/freedombone-app-myappname
@@ -217,10 +306,9 @@ For a Python app without any database, communicating between the daemon and the

- -
freedombone-template --app [name] -e [email] -r [repo url] \
-                     -c [commit] --dir /etc/myappname \
-                     --daemon yes --portinternal 1234 > \
+
freedombone-template --app [name] -e [email] -r [repo url] \
+                     -c [commit] --dir /etc/myappname \
+                     --daemon yes --portinternal 1234 > \
                      src/freedombone-app-myappname
@@ -230,10 +318,9 @@ For an app without any database which communicates directly on a particular port

- -
freedombone-template --app [name] -e [email] -r [repo url] \
-                     -c [commit] --dir /etc/myappname \
-                     --daemon yes --port 5000 > \
+
freedombone-template --app [name] -e [email] -r [repo url] \
+                     -c [commit] --dir /etc/myappname \
+                     --daemon yes --port 5000 > \
                      src/freedombone-app-myappname
@@ -243,10 +330,9 @@ A generic PHP plus MySql/MariaDB web app which is only available on an onion add

- -
freedombone-template --app [name] -e [email] -r [repo url] \
-                     -c [commit] --php yes -d mariadb \
-                     --onion yes > \
+
freedombone-template --app [name] -e [email] -r [repo url] \
+                     -c [commit] --php yes -d mariadb \
+                     --onion yes > \
                      src/freedombone-app-myappname
@@ -256,7 +342,6 @@ For more details see the manpage:

- 
man freedombone-template
@@ -270,7 +355,6 @@ When your new script is ready for testing you can install it with:

- 
make install
@@ -285,9 +369,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.