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

Documentation including internal port

This commit is contained in:
Bob Mottram 2018-02-07 10:17:23 +00:00
parent 08a14be3f6
commit f74db8a922
3 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/EN/devguide.org
View File

@ -47,12 +47,12 @@ freedombone-template --app [name] -e [email] -r [repo url] \
src/freedombone-app-myappname
#+end_src
For a Python app without any database:
For a Python app without any database, communicating between the daemon and the web server on port 1234:
#+begin_src bash
freedombone-template --app [name] -e [email] -r [repo url] \
-c [commit] --dir /etc/myappname \
--daemon yes > \
--daemon yes --portinternal 1234 > \
src/freedombone-app-myappname
#+end_src

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

Binary file not shown.

24
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-06 Tue 22:30 -->
<!-- 2018-02-07 Wed 10:16 -->
<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-org3cc200b" class="outline-2">
<h2 id="org3cc200b">Introduction</h2>
<div class="outline-text-2" id="text-org3cc200b">
<div id="outline-container-org5ea27e4" class="outline-2">
<h2 id="org5ea27e4">Introduction</h2>
<div class="outline-text-2" id="text-org5ea27e4">
<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-org5149f2a" class="outline-2">
<h2 id="org5149f2a">Adding extra apps</h2>
<div class="outline-text-2" id="text-org5149f2a">
<div id="outline-container-orgce16dbb" class="outline-2">
<h2 id="orgce16dbb">Adding extra apps</h2>
<div class="outline-text-2" id="text-orgce16dbb">
<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>
@ -301,13 +301,13 @@ For a Python app with Postgresql database:
</div>
<p>
For a Python app without any database:
For a Python app without any database, communicating between the daemon and the web server on port 1234:
</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 &gt; <span class="org-sh-escaped-newline">\</span>
--daemon yes --portinternal 1234 &gt; <span class="org-sh-escaped-newline">\</span>
src/freedombone-app-myappname
</pre>
</div>
@ -340,9 +340,9 @@ Submit your working app to <b><a href="https://github.com/bashrc/freedombone/iss
</div>
</div>
<div id="outline-container-orgd731678" class="outline-2">
<h2 id="orgd731678">Customising mesh images</h2>
<div class="outline-text-2" id="text-orgd731678">
<div id="outline-container-org9d33f36" class="outline-2">
<h2 id="org9d33f36">Customising mesh images</h2>
<div class="outline-text-2" id="text-org9d33f36">
<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>