diff --git a/doc/EN/installation.org b/doc/EN/installation.org index 71210150..9ce66a73 100644 --- a/doc/EN/installation.org +++ b/doc/EN/installation.org @@ -68,7 +68,7 @@ scp -r ~/.gnupg username@freedombone_IP_address:/home/username The interactive server configuration setup is recommended for most users. On the system where freedombone is to be installed create a configuration file. #+BEGIN_SRC bash -ssh username@freedombone_IP_address +ssh myusername@freedombone_IP_address su sudo apt-get update apt-get install git dialog build-essential @@ -91,32 +91,41 @@ If you don't want to install interactively then it's possible to manually create On the system where freedombone is to be installed create a configuration file. #+BEGIN_SRC bash -ssh username@freedombone_IP_address +ssh myusername@freedombone_IP_address su sudo apt-get update apt-get install git build-essential git clone https://github.com/bashrc/freedombone cd freedombone make install -nano /home/username/freedombone/freedombone.cfg +nano /home/myusername/freedombone/freedombone.cfg #+END_SRC -Add the following, and set the values as needed. +Add the following, and set the values as needed. Note that for a full install DOMAIN_NAME should be the same as the wiki domain name. #+BEGIN_SRC bash -MY_EMAIL_ADDRESS= -MY_NAME= -MY_BLOG_TITLE= -MY_BLOG_SUBTITLE= -FULLBLOG_DOMAIN_NAME= -MICROBLOG_DOMAIN_NAME= -REDMATRIX_DOMAIN_NAME= -OWNCLOUD_DOMAIN_NAME= -WIKI_DOMAIN_NAME= -WIKI_TITLE= +MY_USERNAME=myusername +DOMAIN_NAME=mywikidomain +SYSTEM_TYPE=full +INSTALLING_ON_BBB=no +DDNS_PROVIDER=default@freedns.afraid.org +DDNS_USERNAME=ddnsusername +DDNS_PASSWORD=ddnspassword3471326 +MY_NAME=MyFullNameOrNick +MY_EMAIL_ADDRESS=myusername@mywikidomain +LOCAL_NETWORK_STATIC_IP_ADDRESS=192.168.1.60 +ROUTER_IP_ADDRESS=192.168.1.254 ENABLE_CJDNS=no -LOCAL_NETWORK_STATIC_IP_ADDRESS= -ROUTER_IP_ADDRESS= +DEBIAN_REPO=ftp.us.debian.org +NAMESERVER1=85.214.73.63 +NAMESERVER2=213.73.91.35 +WIKI_TITLE=my wiki title +WIKI_DOMAIN_NAME=mywikidomain +MY_BLOG_TITLE=my blog +FULLBLOG_DOMAIN_NAME=myblogdomain +MICROBLOG_DOMAIN_NAME=mymicroblogdomain +REDMATRIX_DOMAIN_NAME=myredmatrixdomain +OWNCLOUD_DOMAIN_NAME=myownclouddomain #+END_SRC Both of the IP addresses are local IP addresses, typically of the form 192.168.x.x, with one being for the system and the other being for the internet router. @@ -126,18 +135,12 @@ Save the configuration file and exit from your editor. Now you can begin the installation. If you are doing this on a Beaglebone Black: #+BEGIN_SRC bash -freedombone --bbb -d [default domain name] -u [username] --ddns [dynamic DNS provider domain] --ddnsuser [dynamic DNS username] --ddnspass [dynamic DNS password] +freedombone -c freedombone.cfg #+END_SRC -Or on any other system don't include the *--bbb* option. +The above command should be run in the same directory in which your configuration file exists. -#+BEGIN_SRC bash -freedombone -d [default domain name] -u [username] --ddns [dynamic DNS provider domain] --ddnsuser [dynamic DNS username] --ddnspass [dynamic DNS password] -#+END_SRC - -The above command should be run in the same directory in which your configuration file exists. You can use any of your domains as the default one, but typically the default domain is the same as the one for your wiki. - -Also see the manpage for additional options which can be used instead of a configuration file. 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 from which the *freedombone* command is run. +Also see the manpage for additional options which can be used instead of a configuration file. * Post-Setup Setup of the server and installation of all the relevant packages is not quick, and depends upon which variant you choose and your internet bandwidth. Allow about three hours for a full installation on the Beaglebone Black. On the Beaglebone installation is in two parts, since a reboot is needed to enable the hardware random number generator and zram. @@ -145,7 +148,7 @@ Setup of the server and installation of all the relevant packages is not quick, When done you can ssh into the Freedombone with: #+BEGIN_SRC bash -ssh username@domain -p 2222 +ssh myusername@domain -p 2222 #+END_SRC Any manual post-installation setup instructions or passwords can be found in /home/username/README. You should remove any passwords from that file and store them within a password manager such as KeepassX. diff --git a/man/freedombone.1.gz b/man/freedombone.1.gz index 86899008..9721587a 100644 Binary files a/man/freedombone.1.gz and b/man/freedombone.1.gz differ diff --git a/website/EN/installation.html b/website/EN/installation.html index 3ef55f1d..badd2382 100644 --- a/website/EN/installation.html +++ b/website/EN/installation.html @@ -4,7 +4,7 @@ - + @@ -308,7 +308,7 @@ The interactive server configuration setup is recommended for most users. On the
-
ssh username@freedombone_IP_address
+
ssh myusername@freedombone_IP_address
 su
 sudo apt-get update
 apt-get install git dialog build-essential
@@ -347,36 +347,45 @@ On the system where freedombone is to be installed create a configuration file.
 
 

 
-
ssh username@freedombone_IP_address
+
ssh myusername@freedombone_IP_address
 su
 sudo apt-get update
 apt-get install git build-essential
 git clone https://github.com/bashrc/freedombone
 cd freedombone
 make install
-nano /home/username/freedombone/freedombone.cfg
+nano /home/myusername/freedombone/freedombone.cfg
 

 

 
 

-Add the following, and set the values as needed.
+Add the following, and set the values as needed. Note that for a full install DOMAIN_NAME should be the same as the wiki domain name.
 

 
 

 
-
MY_EMAIL_ADDRESS=
-MY_NAME=
-MY_BLOG_TITLE=
-MY_BLOG_SUBTITLE=
-FULLBLOG_DOMAIN_NAME=
-MICROBLOG_DOMAIN_NAME=
-REDMATRIX_DOMAIN_NAME=
-OWNCLOUD_DOMAIN_NAME=
-WIKI_DOMAIN_NAME=
-WIKI_TITLE=
+
MY_USERNAME=myusername
+DOMAIN_NAME=mywikidomain
+SYSTEM_TYPE=full
+INSTALLING_ON_BBB=no
+DDNS_PROVIDER=default@freedns.afraid.org
+DDNS_USERNAME=ddnsusername
+DDNS_PASSWORD=ddnspassword3471326
+MY_NAME=MyFullNameOrNick
+MY_EMAIL_ADDRESS=myusername@mywikidomain
+LOCAL_NETWORK_STATIC_IP_ADDRESS=192.168.1.60
+ROUTER_IP_ADDRESS=192.168.1.254
 ENABLE_CJDNS=no
-LOCAL_NETWORK_STATIC_IP_ADDRESS=
-ROUTER_IP_ADDRESS=
+DEBIAN_REPO=ftp.us.debian.org
+NAMESERVER1=85.214.73.63
+NAMESERVER2=213.73.91.35
+WIKI_TITLE=my wiki title
+WIKI_DOMAIN_NAME=mywikidomain
+MY_BLOG_TITLE=my blog
+FULLBLOG_DOMAIN_NAME=myblogdomain
+MICROBLOG_DOMAIN_NAME=mymicroblogdomain
+REDMATRIX_DOMAIN_NAME=myredmatrixdomain
+OWNCLOUD_DOMAIN_NAME=myownclouddomain
 

 

 
@@ -394,26 +403,16 @@ Now you can begin the installation. If you are doing this on a Beaglebone Black:
 
 

 
-
freedombone --bbb -d [default domain name] -u [username] --ddns [dynamic DNS provider domain] --ddnsuser [dynamic DNS username] --ddnspass [dynamic DNS password]
+
freedombone -c freedombone.cfg
 

 

 
 

-Or on any other system don't include the –bbb option.
-

-
-

-
-
freedombone -d [default domain name] -u [username] --ddns [dynamic DNS provider domain] --ddnsuser [dynamic DNS username] --ddnspass [dynamic DNS password]
-

-

-
-

-The above command should be run in the same directory in which your configuration file exists. You can use any of your domains as the default one, but typically the default domain is the same as the one for your wiki.
+The above command should be run in the same directory in which your configuration file exists.
 

 
 

-Also see the manpage for additional options which can be used instead of a configuration file. 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 from which the freedombone command is run.
+Also see the manpage for additional options which can be used instead of a configuration file.
@@ -431,7 +430,7 @@ When done you can ssh into the Freedombone with:
-
ssh username@domain -p 2222
+
ssh myusername@domain -p 2222