소스 검색

Improve the readme

Bob Mottram 10 년 전
부모
커밋
e2e2b17cdd
2개의 변경된 파일34개의 추가작업 그리고 15개의 파일을 삭제
  1. 34
    15
      README.md
  2. BIN
      man/freedombone.1.gz

+ 34
- 15
README.md 파일 보기

@@ -37,36 +37,55 @@ Plug the microSD card into your laptop/desktop and then run the *freedombone-pre
37 37
 
38 38
 where /dev/sdX is the device name for the microSD card. Often it's /dev/sdb or /dev/sdc, depending upon how many drives there are on your system. The script will download the Debian installer and update the microSD card. It can take a while, so be patient.
39 39
 
40
-When the initial setup is done follow the instructions on screen to run the main Freedombone script. You can 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:
40
+When the initial setup is done follow the instructions on screen to run the main freedombone command.
41
+
42
+On the system where freedombone is to be installed create a configuration file.
43
+
44
+    ssh username@freedombone_IP_address
45
+    su
46
+    apt-get install git
47
+    git clone https://github.com/bashrc/freedombone
48
+    cd freedombone
49
+    make install
50
+    nano /home/username/freedombone/freedombone.cfg
51
+
52
+Add the following, and set the values as needed.
41 53
 
42 54
     MY_EMAIL_ADDRESS=
43 55
     MY_NAME=
44 56
     MY_BLOG_TITLE=
45 57
     MY_BLOG_SUBTITLE=
46
-    SSH_PORT=
47 58
     FULLBLOG_DOMAIN_NAME=
48
-    FULLBLOG_FREEDNS_SUBDOMAIN_CODE=
49 59
     MICROBLOG_DOMAIN_NAME=
50
-    MICROBLOG_FREEDNS_SUBDOMAIN_CODE=
51 60
     REDMATRIX_DOMAIN_NAME=
52 61
     OWNCLOUD_DOMAIN_NAME=
53
-    OWNCLOUD_FREEDNS_SUBDOMAIN_CODE=
54
-    WIKI_TITLE=
55 62
     WIKI_DOMAIN_NAME=
56
-    WIKI_FREEDNS_SUBDOMAIN_CODE=
57
-    MY_GPG_PUBLIC_KEY=
58
-    MY_GPG_PRIVATE_KEY=
59
-    ROUTE_THROUGH_TOR=no
63
+    WIKI_TITLE=
60 64
     ENABLE_CJDNS=no
61
-    LOCAL_NETWORK_STATIC_IP_ADDRESS=192.168.1.60
65
+    LOCAL_NETWORK_STATIC_IP_ADDRESS=
66
+    ROUTER_IP_ADDRESS=
67
+
68
+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.
69
+
70
+If you are using FreeDNS as a dynamic DNS provider then you can add the following to your configuration file, setting the subdomain codes as appropriate. You can find the codes on the FreeDNS site under "Dynamic DNS" followed by "quick cron example" then look for the code on the last line between the ? and = characters.
71
+
72
+    FULLBLOG_FREEDNS_SUBDOMAIN_CODE=
73
+    REDMATRIX_FREEDNS_SUBDOMAIN_CODE=
74
+    MICROBLOG_FREEDNS_SUBDOMAIN_CODE=
75
+    OWNCLOUD_FREEDNS_SUBDOMAIN_CODE=
76
+    WIKI_FREEDNS_SUBDOMAIN_CODE=
77
+
78
+Save the configuration file and exit from your editor.
79
+
80
+Now you can begin the installation. If you are doing this on a Beaglebone Black:
62 81
 
63
-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.
82
+    freedombone --bbb -d [default domain name] -u [username] --ddns [dynamic DNS provider domain] --ddnsuser [dynamic DNS username] --ddnspass [dynamic DNS password]
64 83
 
65
-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.
84
+Or on any other system don't include the *--bbb* option.
66 85
 
67
-The syntax of the *freedombone* command is:
86
+    freedombone -d [default domain name] -u [username] --ddns [dynamic DNS provider domain] --ddnsuser [dynamic DNS username] --ddnspass [dynamic DNS password]
68 87
 
69
-    freedombone --bbb -d [domain name] -u [username] -c [FreeDNS subdomain code] --ddns "freedns.afraid.org" --ddnsuser [FreeDNS username] --ddnspass [FreeDNS password] -s [optional variant type]
88
+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. If you are using FreeDNS as the dynamic DNS provider then also add the -c option to specify the code corresponding to the subdomain.
70 89
 
71 90
 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.
72 91
 

BIN
man/freedombone.1.gz 파일 보기