free
/
freedombonee
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

More examples

This commit is contained in:
Bob Mottram 2018-02-07 10:48:03 +00:00
parent 3788bd3ae6
commit dce6fca556
3 changed files with 52 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/EN/devguide.org
View File

@ -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

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

Binary file not shown.

44
website/EN/devguide.html
View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2018-02-07 Wed 10:26 -->
<!-- 2018-02-07 Wed 10:46 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>&lrm;</title>
@ -246,17 +246,17 @@ for the JavaScript code in this tag.
<center><h1>Developers Guide</h1></center>
<div id="outline-container-orgad5002e" class="outline-2">
<h2 id="orgad5002e">Introduction</h2>
<div class="outline-text-2" id="text-orgad5002e">
<div id="outline-container-orgcb772bb" class="outline-2">
<h2 id="orgcb772bb">Introduction</h2>
<div class="outline-text-2" id="text-orgcb772bb">
<p>
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>
</p>
</div>
</div>
<div id="outline-container-org8600e6f" class="outline-2">
<h2 id="org8600e6f">Adding extra apps</h2>
<div class="outline-text-2" id="text-org8600e6f">
<div id="outline-container-org8fd5474" class="outline-2">
<h2 id="org8fd5474">Adding extra apps</h2>
<div class="outline-text-2" id="text-org8fd5474">
<p>
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.
</p>
@ -312,6 +312,30 @@ For a Python app without any database, communicating between the daemon and the
</pre>
</div>
<p>
For an app without any database which communicates directly on a particular port through the firewall:
</p>
<div class="org-src-container">
<pre class="src src-bash">freedombone-template --app [name] -e [email] -r [repo url] <span class="org-sh-escaped-newline">\</span>
-c [commit] --dir /etc/myappname <span class="org-sh-escaped-newline">\</span>
--daemon yes --port 5000 &gt; <span class="org-sh-escaped-newline">\</span>
src/freedombone-app-myappname
</pre>
</div>
<p>
A generic PHP plus MySql/MariaDB web app which is only available on an onion address:
</p>
<div class="org-src-container">
<pre class="src src-bash">freedombone-template --app [name] -e [email] -r [repo url] <span class="org-sh-escaped-newline">\</span>
-c [commit] --php yes -d mariadb <span class="org-sh-escaped-newline">\</span>
--onion yes &gt; <span class="org-sh-escaped-newline">\</span>
src/freedombone-app-myappname
</pre>
</div>
<p>
For more details see the manpage:
</p>
@ -344,9 +368,9 @@ Submit your working app to <b><a href="https://github.com/bashrc/freedombone/iss
</div>
</div>
<div id="outline-container-org14991ba" class="outline-2">
<h2 id="org14991ba">Customising mesh images</h2>
<div class="outline-text-2" id="text-org14991ba">
<div id="outline-container-orgaefd9da" class="outline-2">
<h2 id="orgaefd9da">Customising mesh images</h2>
<div class="outline-text-2" id="text-orgaefd9da">
<p>
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.
</p>