Browse Source

Separate gogs documentation

Bob Mottram 8 years ago
parent
commit
0e6285a1ea
7 changed files with 461 additions and 166 deletions
  1. 31
    0
      doc/EN/app_gogs.org
  2. 1
    0
      doc/EN/apps.org
  3. 1
    23
      doc/EN/usage.org
  4. 20
    0
      src/freedombone-app-gogs
  5. 300
    0
      website/EN/app_gogs.html
  6. 71
    68
      website/EN/apps.html
  7. 37
    75
      website/EN/usage.html

+ 31
- 0
doc/EN/app_gogs.org View File

@@ -0,0 +1,31 @@
1
+#+TITLE:
2
+#+AUTHOR: Bob Mottram
3
+#+EMAIL: bob@freedombone.net
4
+#+KEYWORDS: freedombone, gogs
5
+#+DESCRIPTION: How to use Gogs
6
+#+OPTIONS: ^:nil toc:nil
7
+#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="freedombone.css" />
8
+
9
+#+BEGIN_CENTER
10
+[[file:images/logo.png]]
11
+#+END_CENTER
12
+
13
+#+BEGIN_EXPORT html
14
+<center>
15
+<h1>Gogs</h1>
16
+</center>
17
+#+END_EXPORT
18
+
19
+Github is ok, but it's proprietary and funded by venture capital. If you been around on the internet for long enough then you know how this story eventually works itself out - i.e. badly for the users. It's really only a question of time. If you're a software developer or do things which involve the Git version control system then it's a good idea to become accustomed to hosting your own repositories, before the inevitable Github shitstorm occurs.
20
+
21
+A Git hosting system called [[https://gogs.io][Gogs]] can optionally be installed. This is very similar to Github in appearance and use. It's lightweight and so well suited for use on low power ARM servers.
22
+
23
+Navigate to your git site and click the *Register* button. The first user registered on the system becomes the administrator. Once you've done that then it's a good idea to disable further registrations. Currently that's a little complicated, but you can do it as follows:
24
+
25
+#+begin_src bash :tangle no
26
+sudo username@domainname -p 2222
27
+#+end_src
28
+
29
+Select *Administrator controls* then *App Settings* then *gogs*. You can then enable or disable registration of new users.
30
+
31
+Disabling further registrations will stop any spam accounts being created by random strangers or bots.

+ 1
- 0
doc/EN/apps.org View File

@@ -43,6 +43,7 @@ Federated social network. You can "/remote follow/" other users within the GNU S
43 43
 * Gogs
44 44
 Lightweight git project hosting system. You can mirror projects from Github, or if Github turns evil then just host your own projects while retaining the familiar /fork-and-pull/ workflow. If you can use Github then you can also use Gogs.
45 45
 
46
+[[./app_gogs.html][How to use it]]
46 47
 * HTMLy
47 48
 Databaseless blogging system. Quite simple and with a markdown-like format.
48 49
 

+ 1
- 23
doc/EN/usage.org View File

@@ -30,7 +30,7 @@
30 30
 | [[./app_tox.html][Tox]]                                                  |
31 31
 | [[./app_mumble.html][Mumble]]                                               |
32 32
 | [[./app_rss.html][RSS Reader]]                                           |
33
-| [[Git Projects]]                                         |
33
+| [[./app_gogs.html][Git Projects]]                                         |
34 34
 | [[Adding or removing users]]                             |
35 35
 | [[Blocking Ads]]                                         |
36 36
 
@@ -100,28 +100,6 @@ ssh username@address.onion -p 2222
100 100
 #+END_SRC
101 101
 
102 102
 Subsequently even if dynamic DNS isn't working you may still be able to administer your system. Using the onion address also gives you some degree of protection against corporate or government metadata analysis, since it becomes more difficult to passively detect which systems are communicating.
103
-* Git Projects
104
-Github is ok, but it's proprietary and funded by venture capital. If you been around on the internet for long enough then you know how this story eventually works itself out - i.e. badly for the users. It's really only a question of time. If you're a software developer or do things which involve the Git version control system then it's a good idea to become accustomed to hosting your own repositories, before the inevitable Github shitstorm happens.
105
-
106
-A Git hosting system called [[https://gogs.io][Gogs]] can optionally be installed. This is very similar to Github in appearance and use. It's lightweight and so well suited for use on low power ARM servers.
107
-
108
-Navigate to your git site and click the *Register* button. The first user registered on the system becomes the administrator. Once you've done that then it's a good idea to disable further registrations. Currently that's a little complicated, but you can do it as follows:
109
-
110
-#+begin_src bash :tangle no
111
-sudo username@domainname -p 2222
112
-#+end_src
113
-
114
-Select *Exit to the comand line*.
115
-
116
-#+begin_src bash :tangle no
117
-sudo su
118
-sed -i "s|DISABLE_REGISTRATION =.*|DISABLE_REGISTRATION = true|g" /home/gogs/custom/conf/app.ini
119
-sed -i "s|SHOW_REGISTRATION_BUTTON =.*|SHOW_REGISTRATION_BUTTON = false|g" /home/gogs/custom/conf/app.ini
120
-systemctl restart gogs
121
-exit; exit
122
-#+end_src
123
-
124
-This will stop any spam accounts being created by random strangers or bots. You might want to mirror existing repos, and at any time a mirror can be converted into the main repo.
125 103
 * Adding or removing users
126 104
 Log into the system with:
127 105
 

+ 20
- 0
src/freedombone-app-gogs View File

@@ -64,6 +64,26 @@ function install_interactive_gogs {
64 64
     APP_INSTALLED=1
65 65
 }
66 66
 
67
+function configure_interactive_gogs {
68
+    dialog --title $"Gogs" \
69
+           --backtitle $"Freedombone Control Panel" \
70
+           --defaultno \
71
+           --yesno $"\nAllow registration of new users?" 10 60
72
+    sel=$?
73
+    case $sel in
74
+        0)
75
+            sed -i "s|DISABLE_REGISTRATION =.*|DISABLE_REGISTRATION = false|g" /home/gogs/custom/conf/app.ini
76
+            sed -i "s|SHOW_REGISTRATION_BUTTON =.*|SHOW_REGISTRATION_BUTTON = true|g" /home/gogs/custom/conf/app.ini
77
+            ;;
78
+        1)
79
+            sed -i "s|DISABLE_REGISTRATION =.*|DISABLE_REGISTRATION = true|g" /home/gogs/custom/conf/app.ini
80
+            sed -i "s|SHOW_REGISTRATION_BUTTON =.*|SHOW_REGISTRATION_BUTTON = false|g" /home/gogs/custom/conf/app.ini
81
+            ;;
82
+        255) return;;
83
+    esac
84
+    systemctl restart gogs
85
+}
86
+
67 87
 function change_password_gogs {
68 88
     echo -n ''
69 89
 }

+ 300
- 0
website/EN/app_gogs.html View File

@@ -0,0 +1,300 @@
1
+<?xml version="1.0" encoding="utf-8"?>
2
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
5
+<head>
6
+<!-- 2016-11-12 Sat 23:35 -->
7
+<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
8
+<meta name="viewport" content="width=device-width, initial-scale=1" />
9
+<title></title>
10
+<meta name="generator" content="Org mode" />
11
+<meta name="author" content="Bob Mottram" />
12
+<meta name="description" content="How to use Gogs"
13
+ />
14
+<meta name="keywords" content="freedombone, gogs" />
15
+<style type="text/css">
16
+ <!--/*--><![CDATA[/*><!--*/
17
+  .title  { text-align: center;
18
+             margin-bottom: .2em; }
19
+  .subtitle { text-align: center;
20
+              font-size: medium;
21
+              font-weight: bold;
22
+              margin-top:0; }
23
+  .todo   { font-family: monospace; color: red; }
24
+  .done   { font-family: monospace; color: green; }
25
+  .priority { font-family: monospace; color: orange; }
26
+  .tag    { background-color: #eee; font-family: monospace;
27
+            padding: 2px; font-size: 80%; font-weight: normal; }
28
+  .timestamp { color: #bebebe; }
29
+  .timestamp-kwd { color: #5f9ea0; }
30
+  .org-right  { margin-left: auto; margin-right: 0px;  text-align: right; }
31
+  .org-left   { margin-left: 0px;  margin-right: auto; text-align: left; }
32
+  .org-center { margin-left: auto; margin-right: auto; text-align: center; }
33
+  .underline { text-decoration: underline; }
34
+  #postamble p, #preamble p { font-size: 90%; margin: .2em; }
35
+  p.verse { margin-left: 3%; }
36
+  pre {
37
+    border: 1px solid #ccc;
38
+    box-shadow: 3px 3px 3px #eee;
39
+    padding: 8pt;
40
+    font-family: monospace;
41
+    overflow: auto;
42
+    margin: 1.2em;
43
+  }
44
+  pre.src {
45
+    position: relative;
46
+    overflow: visible;
47
+    padding-top: 1.2em;
48
+  }
49
+  pre.src:before {
50
+    display: none;
51
+    position: absolute;
52
+    background-color: white;
53
+    top: -10px;
54
+    right: 10px;
55
+    padding: 3px;
56
+    border: 1px solid black;
57
+  }
58
+  pre.src:hover:before { display: inline;}
59
+  /* Languages per Org manual */
60
+  pre.src-asymptote:before { content: 'Asymptote'; }
61
+  pre.src-awk:before { content: 'Awk'; }
62
+  pre.src-C:before { content: 'C'; }
63
+  /* pre.src-C++ doesn't work in CSS */
64
+  pre.src-clojure:before { content: 'Clojure'; }
65
+  pre.src-css:before { content: 'CSS'; }
66
+  pre.src-D:before { content: 'D'; }
67
+  pre.src-ditaa:before { content: 'ditaa'; }
68
+  pre.src-dot:before { content: 'Graphviz'; }
69
+  pre.src-calc:before { content: 'Emacs Calc'; }
70
+  pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
71
+  pre.src-fortran:before { content: 'Fortran'; }
72
+  pre.src-gnuplot:before { content: 'gnuplot'; }
73
+  pre.src-haskell:before { content: 'Haskell'; }
74
+  pre.src-java:before { content: 'Java'; }
75
+  pre.src-js:before { content: 'Javascript'; }
76
+  pre.src-latex:before { content: 'LaTeX'; }
77
+  pre.src-ledger:before { content: 'Ledger'; }
78
+  pre.src-lisp:before { content: 'Lisp'; }
79
+  pre.src-lilypond:before { content: 'Lilypond'; }
80
+  pre.src-lua:before { content: 'Lua'; }
81
+  pre.src-matlab:before { content: 'MATLAB'; }
82
+  pre.src-mscgen:before { content: 'Mscgen'; }
83
+  pre.src-ocaml:before { content: 'Objective Caml'; }
84
+  pre.src-octave:before { content: 'Octave'; }
85
+  pre.src-org:before { content: 'Org mode'; }
86
+  pre.src-oz:before { content: 'OZ'; }
87
+  pre.src-plantuml:before { content: 'Plantuml'; }
88
+  pre.src-processing:before { content: 'Processing.js'; }
89
+  pre.src-python:before { content: 'Python'; }
90
+  pre.src-R:before { content: 'R'; }
91
+  pre.src-ruby:before { content: 'Ruby'; }
92
+  pre.src-sass:before { content: 'Sass'; }
93
+  pre.src-scheme:before { content: 'Scheme'; }
94
+  pre.src-screen:before { content: 'Gnu Screen'; }
95
+  pre.src-sed:before { content: 'Sed'; }
96
+  pre.src-sh:before { content: 'shell'; }
97
+  pre.src-sql:before { content: 'SQL'; }
98
+  pre.src-sqlite:before { content: 'SQLite'; }
99
+  /* additional languages in org.el's org-babel-load-languages alist */
100
+  pre.src-forth:before { content: 'Forth'; }
101
+  pre.src-io:before { content: 'IO'; }
102
+  pre.src-J:before { content: 'J'; }
103
+  pre.src-makefile:before { content: 'Makefile'; }
104
+  pre.src-maxima:before { content: 'Maxima'; }
105
+  pre.src-perl:before { content: 'Perl'; }
106
+  pre.src-picolisp:before { content: 'Pico Lisp'; }
107
+  pre.src-scala:before { content: 'Scala'; }
108
+  pre.src-shell:before { content: 'Shell Script'; }
109
+  pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
110
+  /* additional language identifiers per "defun org-babel-execute"
111
+       in ob-*.el */
112
+  pre.src-cpp:before  { content: 'C++'; }
113
+  pre.src-abc:before  { content: 'ABC'; }
114
+  pre.src-coq:before  { content: 'Coq'; }
115
+  pre.src-groovy:before  { content: 'Groovy'; }
116
+  /* additional language identifiers from org-babel-shell-names in
117
+     ob-shell.el: ob-shell is the only babel language using a lambda to put
118
+     the execution function name together. */
119
+  pre.src-bash:before  { content: 'bash'; }
120
+  pre.src-csh:before  { content: 'csh'; }
121
+  pre.src-ash:before  { content: 'ash'; }
122
+  pre.src-dash:before  { content: 'dash'; }
123
+  pre.src-ksh:before  { content: 'ksh'; }
124
+  pre.src-mksh:before  { content: 'mksh'; }
125
+  pre.src-posh:before  { content: 'posh'; }
126
+  /* Additional Emacs modes also supported by the LaTeX listings package */
127
+  pre.src-ada:before { content: 'Ada'; }
128
+  pre.src-asm:before { content: 'Assembler'; }
129
+  pre.src-caml:before { content: 'Caml'; }
130
+  pre.src-delphi:before { content: 'Delphi'; }
131
+  pre.src-html:before { content: 'HTML'; }
132
+  pre.src-idl:before { content: 'IDL'; }
133
+  pre.src-mercury:before { content: 'Mercury'; }
134
+  pre.src-metapost:before { content: 'MetaPost'; }
135
+  pre.src-modula-2:before { content: 'Modula-2'; }
136
+  pre.src-pascal:before { content: 'Pascal'; }
137
+  pre.src-ps:before { content: 'PostScript'; }
138
+  pre.src-prolog:before { content: 'Prolog'; }
139
+  pre.src-simula:before { content: 'Simula'; }
140
+  pre.src-tcl:before { content: 'tcl'; }
141
+  pre.src-tex:before { content: 'TeX'; }
142
+  pre.src-plain-tex:before { content: 'Plain TeX'; }
143
+  pre.src-verilog:before { content: 'Verilog'; }
144
+  pre.src-vhdl:before { content: 'VHDL'; }
145
+  pre.src-xml:before { content: 'XML'; }
146
+  pre.src-nxml:before { content: 'XML'; }
147
+  /* add a generic configuration mode; LaTeX export needs an additional
148
+     (add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
149
+  pre.src-conf:before { content: 'Configuration File'; }
150
+
151
+  table { border-collapse:collapse; }
152
+  caption.t-above { caption-side: top; }
153
+  caption.t-bottom { caption-side: bottom; }
154
+  td, th { vertical-align:top;  }
155
+  th.org-right  { text-align: center;  }
156
+  th.org-left   { text-align: center;   }
157
+  th.org-center { text-align: center; }
158
+  td.org-right  { text-align: right;  }
159
+  td.org-left   { text-align: left;   }
160
+  td.org-center { text-align: center; }
161
+  dt { font-weight: bold; }
162
+  .footpara { display: inline; }
163
+  .footdef  { margin-bottom: 1em; }
164
+  .figure { padding: 1em; }
165
+  .figure p { text-align: center; }
166
+  .inlinetask {
167
+    padding: 10px;
168
+    border: 2px solid gray;
169
+    margin: 10px;
170
+    background: #ffffcc;
171
+  }
172
+  #org-div-home-and-up
173
+   { text-align: right; font-size: 70%; white-space: nowrap; }
174
+  textarea { overflow-x: auto; }
175
+  .linenr { font-size: smaller }
176
+  .code-highlighted { background-color: #ffff00; }
177
+  .org-info-js_info-navigation { border-style: none; }
178
+  #org-info-js_console-label
179
+    { font-size: 10px; font-weight: bold; white-space: nowrap; }
180
+  .org-info-js_search-highlight
181
+    { background-color: #ffff00; color: #000000; font-weight: bold; }
182
+  .org-svg { width: 90%; }
183
+  /*]]>*/-->
184
+</style>
185
+<link rel="stylesheet" type="text/css" href="freedombone.css" />
186
+<script type="text/javascript">
187
+/*
188
+@licstart  The following is the entire license notice for the
189
+JavaScript code in this tag.
190
+
191
+Copyright (C) 2012-2013 Free Software Foundation, Inc.
192
+
193
+The JavaScript code in this tag is free software: you can
194
+redistribute it and/or modify it under the terms of the GNU
195
+General Public License (GNU GPL) as published by the Free Software
196
+Foundation, either version 3 of the License, or (at your option)
197
+any later version.  The code is distributed WITHOUT ANY WARRANTY;
198
+without even the implied warranty of MERCHANTABILITY or FITNESS
199
+FOR A PARTICULAR PURPOSE.  See the GNU GPL for more details.
200
+
201
+As additional permission under GNU GPL version 3 section 7, you
202
+may distribute non-source (e.g., minimized or compacted) forms of
203
+that code without the copy of the GNU GPL normally required by
204
+section 4, provided you include this license notice and a URL
205
+through which recipients can access the Corresponding Source.
206
+
207
+
208
+@licend  The above is the entire license notice
209
+for the JavaScript code in this tag.
210
+*/
211
+<!--/*--><![CDATA[/*><!--*/
212
+ function CodeHighlightOn(elem, id)
213
+ {
214
+   var target = document.getElementById(id);
215
+   if(null != target) {
216
+     elem.cacheClassElem = elem.className;
217
+     elem.cacheClassTarget = target.className;
218
+     target.className = "code-highlighted";
219
+     elem.className   = "code-highlighted";
220
+   }
221
+ }
222
+ function CodeHighlightOff(elem, id)
223
+ {
224
+   var target = document.getElementById(id);
225
+   if(elem.cacheClassElem)
226
+     elem.className = elem.cacheClassElem;
227
+   if(elem.cacheClassTarget)
228
+     target.className = elem.cacheClassTarget;
229
+ }
230
+/*]]>*///-->
231
+</script>
232
+</head>
233
+<body>
234
+<div id="preamble" class="status">
235
+<a name="top" id="top"></a>
236
+</div>
237
+<div id="content">
238
+<div class="org-center">
239
+
240
+<div class="figure">
241
+<p><img src="images/logo.png" alt="logo.png" />
242
+</p>
243
+</div>
244
+</div>
245
+
246
+<center>
247
+<h1>Gogs</h1>
248
+</center>
249
+
250
+<p>
251
+Github is ok, but it's proprietary and funded by venture capital. If you been around on the internet for long enough then you know how this story eventually works itself out - i.e. badly for the users. It's really only a question of time. If you're a software developer or do things which involve the Git version control system then it's a good idea to become accustomed to hosting your own repositories, before the inevitable Github shitstorm occurs.
252
+</p>
253
+
254
+<p>
255
+A Git hosting system called <a href="https://gogs.io">Gogs</a> can optionally be installed. This is very similar to Github in appearance and use. It's lightweight and so well suited for use on low power ARM servers.
256
+</p>
257
+
258
+<p>
259
+Navigate to your git site and click the <b>Register</b> button. The first user registered on the system becomes the administrator. Once you've done that then it's a good idea to disable further registrations. Currently that's a little complicated, but you can do it as follows:
260
+</p>
261
+
262
+<div class="org-src-container">
263
+<pre class="src src-bash">sudo username@domainname -p 2222
264
+</pre>
265
+</div>
266
+
267
+<p>
268
+Select <b>Administrator controls</b> then <b>App Settings</b> then <b>gogs</b>. You can then enable or disable registration of new users.
269
+</p>
270
+
271
+<p>
272
+Disabling further registrations will stop any spam accounts being created by random strangers or bots.
273
+</p>
274
+</div>
275
+<div id="postamble" class="status">
276
+
277
+<style type="text/css">
278
+.back-to-top {
279
+    position: fixed;
280
+    bottom: 2em;
281
+    right: 0px;
282
+    text-decoration: none;
283
+    color: #000000;
284
+    background-color: rgba(235, 235, 235, 0.80);
285
+    font-size: 12px;
286
+    padding: 1em;
287
+    display: none;
288
+}
289
+
290
+.back-to-top:hover {
291
+    background-color: rgba(135, 135, 135, 0.50);
292
+}
293
+</style>
294
+
295
+<div class="back-to-top">
296
+<a href="#top">Back to top</a> | <a href="mailto:bob@freedombone.net">E-mail me</a>
297
+</div>
298
+</div>
299
+</body>
300
+</html>

+ 71
- 68
website/EN/apps.html View File

@@ -3,7 +3,7 @@
3 3
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 4
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
5 5
 <head>
6
-<!-- 2016-11-12 Sat 23:05 -->
6
+<!-- 2016-11-12 Sat 23:35 -->
7 7
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
8 8
 <meta name="viewport" content="width=device-width, initial-scale=1" />
9 9
 <title></title>
@@ -257,9 +257,9 @@ The base install of the system just contains an email server and Mutt client, bu
257 257
 </div>
258 258
 </div>
259 259
 
260
-<div id="outline-container-org62db2d9" class="outline-2">
261
-<h2 id="org62db2d9">DLNA</h2>
262
-<div class="outline-text-2" id="text-org62db2d9">
260
+<div id="outline-container-orgcf12a1b" class="outline-2">
261
+<h2 id="orgcf12a1b">DLNA</h2>
262
+<div class="outline-text-2" id="text-orgcf12a1b">
263 263
 <p>
264 264
 Enables you to use the system as a music server which any DLNA compatible devices can connect to within your home network.
265 265
 </p>
@@ -269,45 +269,45 @@ Enables you to use the system as a music server which any DLNA compatible device
269 269
 </p>
270 270
 </div>
271 271
 </div>
272
-<div id="outline-container-org36e6ee8" class="outline-2">
273
-<h2 id="org36e6ee8">Dokuwiki</h2>
274
-<div class="outline-text-2" id="text-org36e6ee8">
272
+<div id="outline-container-org0b3f3a7" class="outline-2">
273
+<h2 id="org0b3f3a7">Dokuwiki</h2>
274
+<div class="outline-text-2" id="text-org0b3f3a7">
275 275
 <p>
276 276
 A databaseless wiki system.
277 277
 </p>
278 278
 </div>
279 279
 </div>
280 280
 
281
-<div id="outline-container-orgc8fb8d3" class="outline-2">
282
-<h2 id="orgc8fb8d3">Emacs</h2>
283
-<div class="outline-text-2" id="text-orgc8fb8d3">
281
+<div id="outline-container-orga5ddc93" class="outline-2">
282
+<h2 id="orga5ddc93">Emacs</h2>
283
+<div class="outline-text-2" id="text-orga5ddc93">
284 284
 <p>
285 285
 If you use the Mutt client to read your email then this will set it up to use emacs for composing new mail.
286 286
 </p>
287 287
 </div>
288 288
 </div>
289 289
 
290
-<div id="outline-container-org804a2db" class="outline-2">
291
-<h2 id="org804a2db">Etherpad</h2>
292
-<div class="outline-text-2" id="text-org804a2db">
290
+<div id="outline-container-orge763528" class="outline-2">
291
+<h2 id="orge763528">Etherpad</h2>
292
+<div class="outline-text-2" id="text-orge763528">
293 293
 <p>
294 294
 Collaborate on creating documents in real time. Maybe you're planning a holiday with other family members or creating documentation for a Free Software project along with other volunteers. Etherpad is hard to beat for simplicity and speed. Only users of the system will be able to access it.
295 295
 </p>
296 296
 </div>
297 297
 </div>
298 298
 
299
-<div id="outline-container-orgda10680" class="outline-2">
300
-<h2 id="orgda10680">Ghost</h2>
301
-<div class="outline-text-2" id="text-orgda10680">
299
+<div id="outline-container-orga6006b6" class="outline-2">
300
+<h2 id="orga6006b6">Ghost</h2>
301
+<div class="outline-text-2" id="text-orga6006b6">
302 302
 <p>
303 303
 Modern looking blogging system.
304 304
 </p>
305 305
 </div>
306 306
 </div>
307 307
 
308
-<div id="outline-container-org8fba16b" class="outline-2">
309
-<h2 id="org8fba16b">GNU Social</h2>
310
-<div class="outline-text-2" id="text-org8fba16b">
308
+<div id="outline-container-org13ba239" class="outline-2">
309
+<h2 id="org13ba239">GNU Social</h2>
310
+<div class="outline-text-2" id="text-org13ba239">
311 311
 <p>
312 312
 Federated social network. You can "<i>remote follow</i>" other users within the GNU Social federation.
313 313
 </p>
@@ -317,27 +317,30 @@ Federated social network. You can "<i>remote follow</i>" other users within the
317 317
 </p>
318 318
 </div>
319 319
 </div>
320
-<div id="outline-container-org6f5afe6" class="outline-2">
321
-<h2 id="org6f5afe6">Gogs</h2>
322
-<div class="outline-text-2" id="text-org6f5afe6">
320
+<div id="outline-container-orgc2d3fa7" class="outline-2">
321
+<h2 id="orgc2d3fa7">Gogs</h2>
322
+<div class="outline-text-2" id="text-orgc2d3fa7">
323 323
 <p>
324 324
 Lightweight git project hosting system. You can mirror projects from Github, or if Github turns evil then just host your own projects while retaining the familiar <i>fork-and-pull</i> workflow. If you can use Github then you can also use Gogs.
325 325
 </p>
326
+
327
+<p>
328
+<a href="./app_gogs.html">How to use it</a>
329
+</p>
326 330
 </div>
327 331
 </div>
328
-
329
-<div id="outline-container-org5746649" class="outline-2">
330
-<h2 id="org5746649">HTMLy</h2>
331
-<div class="outline-text-2" id="text-org5746649">
332
+<div id="outline-container-orgd8a4cbe" class="outline-2">
333
+<h2 id="orgd8a4cbe">HTMLy</h2>
334
+<div class="outline-text-2" id="text-orgd8a4cbe">
332 335
 <p>
333 336
 Databaseless blogging system. Quite simple and with a markdown-like format.
334 337
 </p>
335 338
 </div>
336 339
 </div>
337 340
 
338
-<div id="outline-container-org3067f30" class="outline-2">
339
-<h2 id="org3067f30">Hubzilla</h2>
340
-<div class="outline-text-2" id="text-org3067f30">
341
+<div id="outline-container-org82e592b" class="outline-2">
342
+<h2 id="org82e592b">Hubzilla</h2>
343
+<div class="outline-text-2" id="text-org82e592b">
341 344
 <p>
342 345
 Web publishing platform with social network like features and good privacy controls so that it's possible to specify who can see which content. Includes photo albums, calendar, wiki and file storage.
343 346
 </p>
@@ -347,9 +350,9 @@ Web publishing platform with social network like features and good privacy contr
347 350
 </p>
348 351
 </div>
349 352
 </div>
350
-<div id="outline-container-org6b0640e" class="outline-2">
351
-<h2 id="org6b0640e">IRC Server (ngirc)</h2>
352
-<div class="outline-text-2" id="text-org6b0640e">
353
+<div id="outline-container-org49bea85" class="outline-2">
354
+<h2 id="org49bea85">IRC Server (ngirc)</h2>
355
+<div class="outline-text-2" id="text-org49bea85">
353 356
 <p>
354 357
 Run your own IRC chat channel which can be secured with a password and accessible via an onion address. A bouncer is included so that you can receive messages sent while you were offline. Works with Hexchat and other popular clients.
355 358
 </p>
@@ -359,36 +362,36 @@ Run your own IRC chat channel which can be secured with a password and accessibl
359 362
 </p>
360 363
 </div>
361 364
 </div>
362
-<div id="outline-container-org3673a78" class="outline-2">
363
-<h2 id="org3673a78">Jitsi Meet</h2>
364
-<div class="outline-text-2" id="text-org3673a78">
365
+<div id="outline-container-orga475600" class="outline-2">
366
+<h2 id="orga475600">Jitsi Meet</h2>
367
+<div class="outline-text-2" id="text-orga475600">
365 368
 <p>
366 369
 Experimental WebRTC video conferencing system, similar to Google Hangouts. This may not be fully functional, but is hoped to be in the near future.
367 370
 </p>
368 371
 </div>
369 372
 </div>
370 373
 
371
-<div id="outline-container-org52c8925" class="outline-2">
372
-<h2 id="org52c8925">Lychee</h2>
373
-<div class="outline-text-2" id="text-org52c8925">
374
+<div id="outline-container-orgc7ea2a9" class="outline-2">
375
+<h2 id="orgc7ea2a9">Lychee</h2>
376
+<div class="outline-text-2" id="text-orgc7ea2a9">
374 377
 <p>
375 378
 Make your photo albums available on the web.
376 379
 </p>
377 380
 </div>
378 381
 </div>
379 382
 
380
-<div id="outline-container-orge747965" class="outline-2">
381
-<h2 id="orge747965">Mailpile</h2>
382
-<div class="outline-text-2" id="text-orge747965">
383
+<div id="outline-container-org17c21ac" class="outline-2">
384
+<h2 id="org17c21ac">Mailpile</h2>
385
+<div class="outline-text-2" id="text-org17c21ac">
383 386
 <p>
384 387
 Modern email client which supports GPG encryption.
385 388
 </p>
386 389
 </div>
387 390
 </div>
388 391
 
389
-<div id="outline-container-org4a8c2a9" class="outline-2">
390
-<h2 id="org4a8c2a9">Mumble</h2>
391
-<div class="outline-text-2" id="text-org4a8c2a9">
392
+<div id="outline-container-org3e493c2" class="outline-2">
393
+<h2 id="org3e493c2">Mumble</h2>
394
+<div class="outline-text-2" id="text-org3e493c2">
392 395
 <p>
393 396
 The popular VoIP and text chat system. Say goodbye to old-fashioned telephony conferences with silly dial codes. Also works well on mobile.
394 397
 </p>
@@ -398,36 +401,36 @@ The popular VoIP and text chat system. Say goodbye to old-fashioned telephony co
398 401
 </p>
399 402
 </div>
400 403
 </div>
401
-<div id="outline-container-orgd8b1747" class="outline-2">
402
-<h2 id="orgd8b1747">PI-Hole</h2>
403
-<div class="outline-text-2" id="text-orgd8b1747">
404
+<div id="outline-container-org1d90f71" class="outline-2">
405
+<h2 id="org1d90f71">PI-Hole</h2>
406
+<div class="outline-text-2" id="text-org1d90f71">
404 407
 <p>
405 408
 The black hole for web adverts. Block adverts at the domain name level within your local network. It can significantly reduce bandwidth, speed up page load times and protect your systems from being tracked by spyware.
406 409
 </p>
407 410
 </div>
408 411
 </div>
409 412
 
410
-<div id="outline-container-org205ed4c" class="outline-2">
411
-<h2 id="org205ed4c">PostActiv</h2>
412
-<div class="outline-text-2" id="text-org205ed4c">
413
+<div id="outline-container-org9eb5a1b" class="outline-2">
414
+<h2 id="org9eb5a1b">PostActiv</h2>
415
+<div class="outline-text-2" id="text-org9eb5a1b">
413 416
 <p>
414 417
 An alternative federated social networking system compatible with GNU Social. It includes some optimisations and fixes currently not available within the main GNU Social project.
415 418
 </p>
416 419
 </div>
417 420
 </div>
418 421
 
419
-<div id="outline-container-org6777291" class="outline-2">
420
-<h2 id="org6777291">Radicale</h2>
421
-<div class="outline-text-2" id="text-org6777291">
422
+<div id="outline-container-org8d87175" class="outline-2">
423
+<h2 id="org8d87175">Radicale</h2>
424
+<div class="outline-text-2" id="text-org8d87175">
422 425
 <p>
423 426
 Calendar system compatible with CalDAV and CardDAV. Manage your calendar events easily across all your devices.
424 427
 </p>
425 428
 </div>
426 429
 </div>
427 430
 
428
-<div id="outline-container-org04f022b" class="outline-2">
429
-<h2 id="org04f022b">tt-rss</h2>
430
-<div class="outline-text-2" id="text-org04f022b">
431
+<div id="outline-container-org38c229e" class="outline-2">
432
+<h2 id="org38c229e">tt-rss</h2>
433
+<div class="outline-text-2" id="text-org38c229e">
431 434
 <p>
432 435
 Private RSS reader. Pulls in RSS/Atom feeds via Tor and is only accessible via an onion address. Have "<i>the right to read</i>" without the Surveillance State knowing what you're reading. Also available with a user interface suitable for viewing on mobile devices via a browser such as OrFox.
433 436
 </p>
@@ -437,9 +440,9 @@ Private RSS reader. Pulls in RSS/Atom feeds via Tor and is only accessible via a
437 440
 </p>
438 441
 </div>
439 442
 </div>
440
-<div id="outline-container-org2d2cfa7" class="outline-2">
441
-<h2 id="org2d2cfa7">Syncthing</h2>
442
-<div class="outline-text-2" id="text-org2d2cfa7">
443
+<div id="outline-container-org621979d" class="outline-2">
444
+<h2 id="org621979d">Syncthing</h2>
445
+<div class="outline-text-2" id="text-org621979d">
443 446
 <p>
444 447
 Possibly the best way to synchronise files across all of your devices. Once it has been set up it "just works" with no user intervention needed.
445 448
 </p>
@@ -449,9 +452,9 @@ Possibly the best way to synchronise files across all of your devices. Once it h
449 452
 </p>
450 453
 </div>
451 454
 </div>
452
-<div id="outline-container-org427b028" class="outline-2">
453
-<h2 id="org427b028">Tox</h2>
454
-<div class="outline-text-2" id="text-org427b028">
455
+<div id="outline-container-orgf5ad294" class="outline-2">
456
+<h2 id="orgf5ad294">Tox</h2>
457
+<div class="outline-text-2" id="text-orgf5ad294">
455 458
 <p>
456 459
 Client and bootstrap node for the Tox chat/VoIP system.
457 460
 </p>
@@ -461,18 +464,18 @@ Client and bootstrap node for the Tox chat/VoIP system.
461 464
 </p>
462 465
 </div>
463 466
 </div>
464
-<div id="outline-container-orgc67de70" class="outline-2">
465
-<h2 id="orgc67de70">Vim</h2>
466
-<div class="outline-text-2" id="text-orgc67de70">
467
+<div id="outline-container-org19b02df" class="outline-2">
468
+<h2 id="org19b02df">Vim</h2>
469
+<div class="outline-text-2" id="text-org19b02df">
467 470
 <p>
468 471
 If you use the Mutt client to read your email then this will set it up to use vim for composing new mail.
469 472
 </p>
470 473
 </div>
471 474
 </div>
472 475
 
473
-<div id="outline-container-orgd06f6f3" class="outline-2">
474
-<h2 id="orgd06f6f3">XMPP</h2>
475
-<div class="outline-text-2" id="text-orgd06f6f3">
476
+<div id="outline-container-org01cda7f" class="outline-2">
477
+<h2 id="org01cda7f">XMPP</h2>
478
+<div class="outline-text-2" id="text-org01cda7f">
476 479
 <p>
477 480
 Chat server which can be used together with client such as Gajim or Conversations to provide end-to-end content security and also onion routed metadata security. Includes advanced features such as <i>client state notification</i> to save battery power on your mobile devices, support for seamless roaming between networks and <i>message carbons</i> so that you can receive the same messages while being simultaneously logged in to your account on more than one device.
478 481
 </p>

+ 37
- 75
website/EN/usage.html View File

@@ -3,7 +3,7 @@
3 3
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 4
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
5 5
 <head>
6
-<!-- 2016-11-12 Sat 23:05 -->
6
+<!-- 2016-11-12 Sat 23:35 -->
7 7
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
8 8
 <meta name="viewport" content="width=device-width, initial-scale=1" />
9 9
 <title></title>
@@ -255,15 +255,15 @@ for the JavaScript code in this tag.
255 255
 </colgroup>
256 256
 <tbody>
257 257
 <tr>
258
-<td class="org-left"><a href="#org23abd36">Readme</a></td>
258
+<td class="org-left"><a href="#org78e8ebf">Readme</a></td>
259 259
 </tr>
260 260
 
261 261
 <tr>
262
-<td class="org-left"><a href="#orgb27a404">Improving ssh security</a></td>
262
+<td class="org-left"><a href="#orgef4badc">Improving ssh security</a></td>
263 263
 </tr>
264 264
 
265 265
 <tr>
266
-<td class="org-left"><a href="#org406b9c4">Administrating the system via an onion address (Tor)</a></td>
266
+<td class="org-left"><a href="#org09b8978">Administrating the system via an onion address (Tor)</a></td>
267 267
 </tr>
268 268
 
269 269
 <tr>
@@ -311,22 +311,22 @@ for the JavaScript code in this tag.
311 311
 </tr>
312 312
 
313 313
 <tr>
314
-<td class="org-left"><a href="#org2b5ad1e">Git Projects</a></td>
314
+<td class="org-left"><a href="./app_gogs.html">Git Projects</a></td>
315 315
 </tr>
316 316
 
317 317
 <tr>
318
-<td class="org-left"><a href="#org6b00b78">Adding or removing users</a></td>
318
+<td class="org-left"><a href="#org3e5b626">Adding or removing users</a></td>
319 319
 </tr>
320 320
 
321 321
 <tr>
322
-<td class="org-left"><a href="#org5f849d3">Blocking Ads</a></td>
322
+<td class="org-left"><a href="#org576f971">Blocking Ads</a></td>
323 323
 </tr>
324 324
 </tbody>
325 325
 </table>
326 326
 
327
-<div id="outline-container-org23abd36" class="outline-2">
328
-<h2 id="org23abd36">Readme</h2>
329
-<div class="outline-text-2" id="text-org23abd36">
327
+<div id="outline-container-org78e8ebf" class="outline-2">
328
+<h2 id="org78e8ebf">Readme</h2>
329
+<div class="outline-text-2" id="text-org78e8ebf">
330 330
 <p>
331 331
 After the system has installed a README file will be generated which contains passwords and some brief advice on using the installed systems. You can read this with the following commands:
332 332
 </p>
@@ -346,9 +346,9 @@ To exit you can either just close the terminal or use <b>CTRL-x CTRL-c</b> follo
346 346
 </p>
347 347
 </div>
348 348
 </div>
349
-<div id="outline-container-orgb27a404" class="outline-2">
350
-<h2 id="orgb27a404">Improving ssh security</h2>
351
-<div class="outline-text-2" id="text-orgb27a404">
349
+<div id="outline-container-orgef4badc" class="outline-2">
350
+<h2 id="orgef4badc">Improving ssh security</h2>
351
+<div class="outline-text-2" id="text-orgef4badc">
352 352
 <p>
353 353
 To improve ssh security you can generate an ssh key pair on your system and then upload the public key to the Freedombone.
354 354
 </p>
@@ -398,9 +398,9 @@ If you wish to only use ssh keys then log in to the Freedombone, become the root
398 398
 </div>
399 399
 </div>
400 400
 
401
-<div id="outline-container-org406b9c4" class="outline-2">
402
-<h2 id="org406b9c4">Administrating the system via an onion address (Tor)</h2>
403
-<div class="outline-text-2" id="text-org406b9c4">
401
+<div id="outline-container-org09b8978" class="outline-2">
402
+<h2 id="org09b8978">Administrating the system via an onion address (Tor)</h2>
403
+<div class="outline-text-2" id="text-org09b8978">
404 404
 <p>
405 405
 You can also access your system via the Tor system using an onion address. To find out what the onion address for ssh access is you can do the following:
406 406
 </p>
@@ -442,47 +442,9 @@ Subsequently even if dynamic DNS isn't working you may still be able to administ
442 442
 </p>
443 443
 </div>
444 444
 </div>
445
-<div id="outline-container-org2b5ad1e" class="outline-2">
446
-<h2 id="org2b5ad1e">Git Projects</h2>
447
-<div class="outline-text-2" id="text-org2b5ad1e">
448
-<p>
449
-Github is ok, but it's proprietary and funded by venture capital. If you been around on the internet for long enough then you know how this story eventually works itself out - i.e. badly for the users. It's really only a question of time. If you're a software developer or do things which involve the Git version control system then it's a good idea to become accustomed to hosting your own repositories, before the inevitable Github shitstorm happens.
450
-</p>
451
-
452
-<p>
453
-A Git hosting system called <a href="https://gogs.io">Gogs</a> can optionally be installed. This is very similar to Github in appearance and use. It's lightweight and so well suited for use on low power ARM servers.
454
-</p>
455
-
456
-<p>
457
-Navigate to your git site and click the <b>Register</b> button. The first user registered on the system becomes the administrator. Once you've done that then it's a good idea to disable further registrations. Currently that's a little complicated, but you can do it as follows:
458
-</p>
459
-
460
-<div class="org-src-container">
461
-<pre class="src src-bash">sudo username@domainname -p 2222
462
-</pre>
463
-</div>
464
-
465
-<p>
466
-Select <b>Exit to the comand line</b>.
467
-</p>
468
-
469
-<div class="org-src-container">
470
-<pre class="src src-bash">sudo su
471
-sed -i <span class="org-string">"s|DISABLE_REGISTRATION =.*|DISABLE_REGISTRATION = true|g"</span> /home/gogs/custom/conf/app.ini
472
-sed -i <span class="org-string">"s|SHOW_REGISTRATION_BUTTON =.*|SHOW_REGISTRATION_BUTTON = false|g"</span> /home/gogs/custom/conf/app.ini
473
-systemctl restart gogs
474
-<span class="org-keyword">exit</span>; <span class="org-keyword">exit</span>
475
-</pre>
476
-</div>
477
-
478
-<p>
479
-This will stop any spam accounts being created by random strangers or bots. You might want to mirror existing repos, and at any time a mirror can be converted into the main repo.
480
-</p>
481
-</div>
482
-</div>
483
-<div id="outline-container-org6b00b78" class="outline-2">
484
-<h2 id="org6b00b78">Adding or removing users</h2>
485
-<div class="outline-text-2" id="text-org6b00b78">
445
+<div id="outline-container-org3e5b626" class="outline-2">
446
+<h2 id="org3e5b626">Adding or removing users</h2>
447
+<div class="outline-text-2" id="text-org3e5b626">
486 448
 <p>
487 449
 Log into the system with:
488 450
 </p>
@@ -510,9 +472,9 @@ control
510 472
 </div>
511 473
 </div>
512 474
 
513
-<div id="outline-container-org5f849d3" class="outline-2">
514
-<h2 id="org5f849d3">Blocking Ads</h2>
515
-<div class="outline-text-2" id="text-org5f849d3">
475
+<div id="outline-container-org576f971" class="outline-2">
476
+<h2 id="org576f971">Blocking Ads</h2>
477
+<div class="outline-text-2" id="text-org576f971">
516 478
 <p>
517 479
 Everyone except for advertisers hates adverts. Not only are they annoying, but they can consume a lot of bandwidth, be a privacy problem in terms of allowing companies to track your browsing habits and also any badly written scripts they contain may introduce exploitable security holes. Also if you're poor then adverts often make you want things that you can't have.
518 480
 </p>
@@ -526,9 +488,9 @@ Also don't expect perfection. Though many ads may be blocked by this system some
526 488
 </p>
527 489
 </div>
528 490
 
529
-<div id="outline-container-orgc118780" class="outline-3">
530
-<h3 id="orgc118780">Set a static IP address</h3>
531
-<div class="outline-text-3" id="text-orgc118780">
491
+<div id="outline-container-org280f5db" class="outline-3">
492
+<h3 id="org280f5db">Set a static IP address</h3>
493
+<div class="outline-text-3" id="text-org280f5db">
532 494
 <p>
533 495
 Ensure that your system has a static local IP address (typically 192.168..) using the option on the control panel. You will also need to know the IP address of your internet router, which is usually <b>192.168.1.1</b> or <b>192.168.1.254</b>.
534 496
 </p>
@@ -539,9 +501,9 @@ When that's done select <b>About this system</b> from the control panel and see
539 501
 </div>
540 502
 </div>
541 503
 
542
-<div id="outline-container-orgf236d40" class="outline-3">
543
-<h3 id="orgf236d40">On each client system within your local network</h3>
544
-<div class="outline-text-3" id="text-orgf236d40">
504
+<div id="outline-container-orgfdc8d62" class="outline-3">
505
+<h3 id="orgfdc8d62">On each client system within your local network</h3>
506
+<div class="outline-text-3" id="text-orgfdc8d62">
545 507
 <div class="org-src-container">
546 508
 <pre class="src src-bash">sudo chattr -i /etc/resolv.conf
547 509
 sudo nano /etc/resolv.conf
@@ -568,9 +530,9 @@ Normally <i>resolv.conf</i> will be overwritten every time your reboot, but you
568 530
 </div>
569 531
 </div>
570 532
 
571
-<div id="outline-container-orge601ffa" class="outline-3">
572
-<h3 id="orge601ffa">On your internet router</h3>
573
-<div class="outline-text-3" id="text-orge601ffa">
533
+<div id="outline-container-orga97bbac" class="outline-3">
534
+<h3 id="orga97bbac">On your internet router</h3>
535
+<div class="outline-text-3" id="text-orga97bbac">
574 536
 <p>
575 537
 If you can access the settings on your local internet router then this is the simplest way to provide ad blocking for all devices which connect to it. Unfortunately some router models don't let you edit the DNS settings and if that's the case you might want to consider getting a different router.
576 538
 </p>
@@ -580,9 +542,9 @@ Edit the DNS settings and add the IPv4 address which you got from the control pa
580 542
 </p>
581 543
 </div>
582 544
 
583
-<div id="outline-container-org0d5eccb" class="outline-4">
584
-<h4 id="org0d5eccb">LibreCMC</h4>
585
-<div class="outline-text-4" id="text-org0d5eccb">
545
+<div id="outline-container-org36b29b4" class="outline-4">
546
+<h4 id="org36b29b4">LibreCMC</h4>
547
+<div class="outline-text-4" id="text-org36b29b4">
586 548
 <p>
587 549
 On a router running LibreCMC from the <b>Network</b> menu select <b>DHCP and DNS</b>. Enter the static IP address of your Freedombone system within <b>DNS Forwardings</b>, then at the bottom of the page click on <b>Save &amp; Apply</b>. Any devices which connect to your router will now have ad blocking.
588 550
 </p>
@@ -590,9 +552,9 @@ On a router running LibreCMC from the <b>Network</b> menu select <b>DHCP and DNS
590 552
 </div>
591 553
 </div>
592 554
 
593
-<div id="outline-container-orgbfa50dc" class="outline-3">
594
-<h3 id="orgbfa50dc">Configuring block lists</h3>
595
-<div class="outline-text-3" id="text-orgbfa50dc">
555
+<div id="outline-container-orge945f94" class="outline-3">
556
+<h3 id="orge945f94">Configuring block lists</h3>
557
+<div class="outline-text-3" id="text-orge945f94">
596 558
 <p>
597 559
 You can configure the block lists which the system uses by going to the <b>administrator control panel</b>, selecting <b>App Settings</b> then choosing <b>pihole</b>. You can also add any extra domain names to the whitelist if they're being wrongly blocked or to the blacklist if they're not blocked by the current lists.
598 560
 </p>