Documentation
This commit is contained in:
Bob Mottram
parent
9bd26bf719
commit
ad34570740
|
|
@ -45,36 +45,36 @@ where */dev/sdX* is the device name for the microSD card. Often it's */dev/sdb*
|
|||
When the initial setup is done follow the instructions on screen to run the main Freedombone script. You can either edit the variables within the *install-freedombone.sh* script directly, or create a separate configuration file called *freedombone.cfg* which contains those variables. Variables which you might want to put into a *freedombone.cfg* file are:
|
||||
|
||||
#+BEGIN_SRC bash
|
||||
MY_EMAIL_ADDRESS=
|
||||
MY_NAME=
|
||||
MY_BLOG_TITLE=
|
||||
MY_BLOG_SUBTITLE=
|
||||
SSH_PORT=
|
||||
FULLBLOG_DOMAIN_NAME=
|
||||
FULLBLOG_FREEDNS_SUBDOMAIN_CODE=
|
||||
MICROBLOG_DOMAIN_NAME=
|
||||
MICROBLOG_FREEDNS_SUBDOMAIN_CODE=
|
||||
REDMATRIX_DOMAIN_NAME=
|
||||
OWNCLOUD_DOMAIN_NAME=
|
||||
OWNCLOUD_FREEDNS_SUBDOMAIN_CODE=
|
||||
WIKI_TITLE=
|
||||
WIKI_DOMAIN_NAME=
|
||||
WIKI_FREEDNS_SUBDOMAIN_CODE=
|
||||
MY_GPG_PUBLIC_KEY=
|
||||
MY_GPG_PRIVATE_KEY=
|
||||
PUBLIC_MAILING_LIST=
|
||||
ROUTE_THROUGH_TOR=no
|
||||
MY_EMAIL_ADDRESS=<your email address>
|
||||
MY_NAME=<your name/nick/pseudonym>
|
||||
MY_BLOG_TITLE=<title of your blog>
|
||||
MY_BLOG_SUBTITLE=<subtitle of your blog>
|
||||
SSH_PORT=2222
|
||||
FULLBLOG_DOMAIN_NAME=<freedns subdomain for your blog>
|
||||
FULLBLOG_FREEDNS_SUBDOMAIN_CODE=<freedns subdomain code for your blog>
|
||||
MICROBLOG_DOMAIN_NAME=<domain name for your microblog>
|
||||
MICROBLOG_FREEDNS_SUBDOMAIN_CODE=1234
|
||||
REDMATRIX_DOMAIN_NAME=<domain name for your Red Matrix site>
|
||||
OWNCLOUD_DOMAIN_NAME=<freedns subdomain for your Owncloud site>
|
||||
OWNCLOUD_FREEDNS_SUBDOMAIN_CODE=<freedns subdomain code for your Owncloud site>
|
||||
WIKI_TITLE=<title of your wiki>
|
||||
WIKI_DOMAIN_NAME=<freedns subdomain for your wiki>
|
||||
WIKI_FREEDNS_SUBDOMAIN_CODE=<freedns subdomain code for your wiki>
|
||||
MY_GPG_PUBLIC_KEY=<exported public key filename>
|
||||
MY_GPG_PRIVATE_KE=<exported private key filename>
|
||||
PUBLIC_MAILING_LIST=<name of your mailing list>
|
||||
LOCAL_NETWORK_STATIC_IP_ADDRESS=192.168.1.60
|
||||
ROUTER_IP_ADDRESS=192.168.1.254
|
||||
#+END_SRC
|
||||
|
||||
The GPG public/private key variables are for the filenames of exported GPG keys, and if a private key filename is given then it will be automatically shredded after import.
|
||||
|
||||
The FreeDNS subdomain codes can be found under "Dynamic DNS" and "quick cron example". On the last line it will be the string located between the '?' and the '==' characters.
|
||||
The [[https://freedns.afraid.org/][FreeDNS]] subdomain codes can be found under "Dynamic DNS" and "quick cron example". On the last line it will be the string located between the '?' and the '==' characters.
|
||||
|
||||
The syntax of the *install-freedombone.sh* script is:
|
||||
|
||||
#+BEGIN_SRC bash
|
||||
./install-freedombone.sh [domain name] [username] [FreeDNS subdomain code] [optional variant type]
|
||||
./install-freedombone.sh <your wiki domain name> <your username> <your wiki FreeDNS domain code> [optional variant type]
|
||||
#+END_SRC
|
||||
|
||||
If you don't specify a variant type with the final option then everything will be installed. If you have a *freedombone.cfg* file then it should be in the same directory as *install-freedombone.sh*.
|
||||
|
|
@ -112,27 +112,29 @@ cd freedombone
|
|||
nano freedombone.cfg
|
||||
#+END_SRC
|
||||
|
||||
* Now create a configuration file, such as the following, filling in the details for your [[https://freedns.afraid.org/][FreeDNS domains]].
|
||||
* Now create a configuration file, such as the following, filling in the details for your [[https://freedns.afraid.org/][FreeDNS subdomains]].
|
||||
#+BEGIN_SRC bash
|
||||
INSTALLING_ON_BBB=no
|
||||
MY_EMAIL_ADDRESS=<your email>
|
||||
MY_NAME=<your name>
|
||||
MY_BLOG_TITLE=<your blog title>
|
||||
MY_BLOG_SUBTITLE=<your blog subtitle>
|
||||
MY_EMAIL_ADDRESS=<your email address>
|
||||
MY_NAME=<your name/nick/pseudonym>
|
||||
MY_BLOG_TITLE=<title of your blog>
|
||||
MY_BLOG_SUBTITLE=<subtitle of your blog>
|
||||
SSH_PORT=2222
|
||||
FULLBLOG_DOMAIN_NAME=<your blog domain name
|
||||
FULLBLOG_FREEDNS_SUBDOMAIN_CODE=<your blog FreeDNS code>
|
||||
MICROBLOG_DOMAIN_NAME=<your GNU Social domain name>
|
||||
MICROBLOG_FREEDNS_SUBDOMAIN_CODE=<your GNU social FreeDNS domain code>
|
||||
REDMATRIX_DOMAIN_NAME=<your Red Matrix domain name>
|
||||
REDMATRIX_FREEDNS_SUBDOMAIN_CODE=1234
|
||||
OWNCLOUD_DOMAIN_NAME=<your Owncloud domain name>
|
||||
OWNCLOUD_FREEDNS_SUBDOMAIN_CODE=<your Owncloud FreeDNS domain code>
|
||||
WIKI_DOMAIN_NAME=<your wiki domain name>
|
||||
WIKI_FREEDNS_SUBDOMAIN_CODE=<your wiki FreeDNS domain code>
|
||||
WIKI_TITLE=<your wiki title>
|
||||
ROUTE_THROUGH_TOR=no
|
||||
FULLBLOG_DOMAIN_NAME=<freedns subdomain for your blog>
|
||||
FULLBLOG_FREEDNS_SUBDOMAIN_CODE=<freedns subdomain code for your blog>
|
||||
MICROBLOG_DOMAIN_NAME=<domain name for your microblog>
|
||||
MICROBLOG_FREEDNS_SUBDOMAIN_CODE=1234
|
||||
REDMATRIX_DOMAIN_NAME=<domain name for your Red Matrix site>
|
||||
OWNCLOUD_DOMAIN_NAME=<freedns subdomain for your Owncloud site>
|
||||
OWNCLOUD_FREEDNS_SUBDOMAIN_CODE=<freedns subdomain code for your Owncloud site>
|
||||
WIKI_TITLE=<title of your wiki>
|
||||
WIKI_DOMAIN_NAME=<freedns subdomain for your wiki>
|
||||
WIKI_FREEDNS_SUBDOMAIN_CODE=<freedns subdomain code for your wiki>
|
||||
MY_GPG_PUBLIC_KEY=<exported public key filename>
|
||||
MY_GPG_PRIVATE_KE=<exported private key filename>
|
||||
PUBLIC_MAILING_LIST=<name of your mailing list>
|
||||
LOCAL_NETWORK_STATIC_IP_ADDRESS=192.168.1.60
|
||||
ROUTER_IP_ADDRESS=192.168.1.254
|
||||
#+END_SRC
|
||||
|
||||
* Save and exit, then run:
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||
<head>
|
||||
<title></title>
|
||||
<!-- 2014-12-20 Sat 11:22 -->
|
||||
<!-- 2014-12-26 Fri 15:11 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="generator" content="Org-mode" />
|
||||
<meta name="author" content="Bob Mottram" />
|
||||
|
|
@ -252,26 +252,26 @@ When the initial setup is done follow the instructions on screen to run the main
|
|||
|
||||
<div class="org-src-container">
|
||||
|
||||
<pre class="src src-bash"><span class="org-variable-name">MY_EMAIL_ADDRESS</span>=
|
||||
<span class="org-variable-name">MY_NAME</span>=
|
||||
<span class="org-variable-name">MY_BLOG_TITLE</span>=
|
||||
<span class="org-variable-name">MY_BLOG_SUBTITLE</span>=
|
||||
<span class="org-variable-name">SSH_PORT</span>=
|
||||
<span class="org-variable-name">FULLBLOG_DOMAIN_NAME</span>=
|
||||
<span class="org-variable-name">FULLBLOG_FREEDNS_SUBDOMAIN_CODE</span>=
|
||||
<span class="org-variable-name">MICROBLOG_DOMAIN_NAME</span>=
|
||||
<span class="org-variable-name">MICROBLOG_FREEDNS_SUBDOMAIN_CODE</span>=
|
||||
<span class="org-variable-name">REDMATRIX_DOMAIN_NAME</span>=
|
||||
<span class="org-variable-name">OWNCLOUD_DOMAIN_NAME</span>=
|
||||
<span class="org-variable-name">OWNCLOUD_FREEDNS_SUBDOMAIN_CODE</span>=
|
||||
<span class="org-variable-name">WIKI_TITLE</span>=
|
||||
<span class="org-variable-name">WIKI_DOMAIN_NAME</span>=
|
||||
<span class="org-variable-name">WIKI_FREEDNS_SUBDOMAIN_CODE</span>=
|
||||
<span class="org-variable-name">MY_GPG_PUBLIC_KEY</span>=
|
||||
<span class="org-variable-name">MY_GPG_PRIVATE_KEY</span>=
|
||||
<span class="org-variable-name">PUBLIC_MAILING_LIST</span>=
|
||||
<span class="org-variable-name">ROUTE_THROUGH_TOR</span>=no
|
||||
<pre class="src src-bash"><span class="org-variable-name">MY_EMAIL_ADDRESS</span>=<your email address>
|
||||
<span class="org-variable-name">MY_NAME</span>=<your name/nick/pseudonym>
|
||||
<span class="org-variable-name">MY_BLOG_TITLE</span>=<title of your blog>
|
||||
<span class="org-variable-name">MY_BLOG_SUBTITLE</span>=<subtitle of your blog>
|
||||
<span class="org-variable-name">SSH_PORT</span>=2222
|
||||
<span class="org-variable-name">FULLBLOG_DOMAIN_NAME</span>=<freedns subdomain for your blog>
|
||||
<span class="org-variable-name">FULLBLOG_FREEDNS_SUBDOMAIN_CODE</span>=<freedns subdomain code for your blog>
|
||||
<span class="org-variable-name">MICROBLOG_DOMAIN_NAME</span>=<domain name for your microblog>
|
||||
<span class="org-variable-name">MICROBLOG_FREEDNS_SUBDOMAIN_CODE</span>=1234
|
||||
<span class="org-variable-name">REDMATRIX_DOMAIN_NAME</span>=<domain name for your Red Matrix site>
|
||||
<span class="org-variable-name">OWNCLOUD_DOMAIN_NAME</span>=<freedns subdomain for your Owncloud site>
|
||||
<span class="org-variable-name">OWNCLOUD_FREEDNS_SUBDOMAIN_CODE</span>=<freedns subdomain code for your Owncloud site>
|
||||
<span class="org-variable-name">WIKI_TITLE</span>=<title of your wiki>
|
||||
<span class="org-variable-name">WIKI_DOMAIN_NAME</span>=<freedns subdomain for your wiki>
|
||||
<span class="org-variable-name">WIKI_FREEDNS_SUBDOMAIN_CODE</span>=<freedns subdomain code for your wiki>
|
||||
<span class="org-variable-name">MY_GPG_PUBLIC_KEY</span>=<exported public key filename>
|
||||
<span class="org-variable-name">MY_GPG_PRIVATE_KE</span>=<exported private key filename>
|
||||
<span class="org-variable-name">PUBLIC_MAILING_LIST</span>=<name of your mailing list>
|
||||
<span class="org-variable-name">LOCAL_NETWORK_STATIC_IP_ADDRESS</span>=192.168.1.60
|
||||
<span class="org-variable-name">ROUTER_IP_ADDRESS</span>=192.168.1.254
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
|
|
@ -280,7 +280,7 @@ The GPG public/private key variables are for the filenames of exported GPG keys,
|
|||
</p>
|
||||
|
||||
<p>
|
||||
The FreeDNS subdomain codes can be found under "Dynamic DNS" and "quick cron example". On the last line it will be the string located between the '?' and the '==' characters.
|
||||
The <a href="https://freedns.afraid.org/">FreeDNS</a> subdomain codes can be found under "Dynamic DNS" and "quick cron example". On the last line it will be the string located between the '?' and the '==' characters.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
|
|
@ -289,7 +289,7 @@ The syntax of the <b>install-freedombone.sh</b> script is:
|
|||
|
||||
<div class="org-src-container">
|
||||
|
||||
<pre class="src src-bash">./install-freedombone.sh [domain name] [username] [FreeDNS subdomain code] [optional variant type]
|
||||
<pre class="src src-bash">./install-freedombone.sh <your wiki domain name> <your username> <your wiki FreeDNS domain code> [optional variant type]
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
|
|
@ -361,30 +361,32 @@ nano freedombone.cfg
|
|||
</div>
|
||||
|
||||
<ul class="org-ul">
|
||||
<li>Now create a configuration file, such as the following, filling in the details for your <a href="https://freedns.afraid.org/">FreeDNS domains</a>.
|
||||
<li>Now create a configuration file, such as the following, filling in the details for your <a href="https://freedns.afraid.org/">FreeDNS subdomains</a>.
|
||||
</li>
|
||||
</ul>
|
||||
<div class="org-src-container">
|
||||
|
||||
<pre class="src src-bash"><span class="org-variable-name">INSTALLING_ON_BBB</span>=no
|
||||
<span class="org-variable-name">MY_EMAIL_ADDRESS</span>=<your email>
|
||||
<span class="org-variable-name">MY_NAME</span>=<your name>
|
||||
<span class="org-variable-name">MY_BLOG_TITLE</span>=<your blog title>
|
||||
<span class="org-variable-name">MY_BLOG_SUBTITLE</span>=<your blog subtitle>
|
||||
<span class="org-variable-name">MY_EMAIL_ADDRESS</span>=<your email address>
|
||||
<span class="org-variable-name">MY_NAME</span>=<your name/nick/pseudonym>
|
||||
<span class="org-variable-name">MY_BLOG_TITLE</span>=<title of your blog>
|
||||
<span class="org-variable-name">MY_BLOG_SUBTITLE</span>=<subtitle of your blog>
|
||||
<span class="org-variable-name">SSH_PORT</span>=2222
|
||||
<span class="org-variable-name">FULLBLOG_DOMAIN_NAME</span>=<your blog domain name
|
||||
<span class="org-variable-name">FULLBLOG_FREEDNS_SUBDOMAIN_CODE</span>=<your blog FreeDNS code>
|
||||
<span class="org-variable-name">MICROBLOG_DOMAIN_NAME</span>=<your GNU Social domain name>
|
||||
<span class="org-variable-name">MICROBLOG_FREEDNS_SUBDOMAIN_CODE</span>=<your GNU social FreeDNS domain code>
|
||||
<span class="org-variable-name">REDMATRIX_DOMAIN_NAME</span>=<your Red Matrix domain name>
|
||||
<span class="org-variable-name">REDMATRIX_FREEDNS_SUBDOMAIN_CODE</span>=1234
|
||||
<span class="org-variable-name">OWNCLOUD_DOMAIN_NAME</span>=<your Owncloud domain name>
|
||||
<span class="org-variable-name">OWNCLOUD_FREEDNS_SUBDOMAIN_CODE</span>=<your Owncloud FreeDNS domain code>
|
||||
<span class="org-variable-name">WIKI_DOMAIN_NAME</span>=<your wiki domain name>
|
||||
<span class="org-variable-name">WIKI_FREEDNS_SUBDOMAIN_CODE</span>=<your wiki FreeDNS domain code>
|
||||
<span class="org-variable-name">WIKI_TITLE</span>=<your wiki title>
|
||||
<span class="org-variable-name">ROUTE_THROUGH_TOR</span>=no
|
||||
<span class="org-variable-name">FULLBLOG_DOMAIN_NAME</span>=<freedns subdomain for your blog>
|
||||
<span class="org-variable-name">FULLBLOG_FREEDNS_SUBDOMAIN_CODE</span>=<freedns subdomain code for your blog>
|
||||
<span class="org-variable-name">MICROBLOG_DOMAIN_NAME</span>=<domain name for your microblog>
|
||||
<span class="org-variable-name">MICROBLOG_FREEDNS_SUBDOMAIN_CODE</span>=1234
|
||||
<span class="org-variable-name">REDMATRIX_DOMAIN_NAME</span>=<domain name for your Red Matrix site>
|
||||
<span class="org-variable-name">OWNCLOUD_DOMAIN_NAME</span>=<freedns subdomain for your Owncloud site>
|
||||
<span class="org-variable-name">OWNCLOUD_FREEDNS_SUBDOMAIN_CODE</span>=<freedns subdomain code for your Owncloud site>
|
||||
<span class="org-variable-name">WIKI_TITLE</span>=<title of your wiki>
|
||||
<span class="org-variable-name">WIKI_DOMAIN_NAME</span>=<freedns subdomain for your wiki>
|
||||
<span class="org-variable-name">WIKI_FREEDNS_SUBDOMAIN_CODE</span>=<freedns subdomain code for your wiki>
|
||||
<span class="org-variable-name">MY_GPG_PUBLIC_KEY</span>=<exported public key filename>
|
||||
<span class="org-variable-name">MY_GPG_PRIVATE_KE</span>=<exported private key filename>
|
||||
<span class="org-variable-name">PUBLIC_MAILING_LIST</span>=<name of your mailing list>
|
||||
<span class="org-variable-name">LOCAL_NETWORK_STATIC_IP_ADDRESS</span>=192.168.1.60
|
||||
<span class="org-variable-name">ROUTER_IP_ADDRESS</span>=192.168.1.254
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue