app_gnusocial.html 15KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487
  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. <title></title>
  7. <!-- 2018-06-16 Sat 21:49 -->
  8. <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
  9. <meta name="generator" content="Org-mode" />
  10. <meta name="author" content="Bob Mottram" />
  11. <meta name="description" content="How to use GNU Social"
  12. />
  13. <meta name="keywords" content="freedombone, gnu social" />
  14. <style type="text/css">
  15. <!--/*--><![CDATA[/*><!--*/
  16. .title { text-align: center; }
  17. .todo { font-family: monospace; color: red; }
  18. .done { color: green; }
  19. .tag { background-color: #eee; font-family: monospace;
  20. padding: 2px; font-size: 80%; font-weight: normal; }
  21. .timestamp { color: #bebebe; }
  22. .timestamp-kwd { color: #5f9ea0; }
  23. .right { margin-left: auto; margin-right: 0px; text-align: right; }
  24. .left { margin-left: 0px; margin-right: auto; text-align: left; }
  25. .center { margin-left: auto; margin-right: auto; text-align: center; }
  26. .underline { text-decoration: underline; }
  27. #postamble p, #preamble p { font-size: 90%; margin: .2em; }
  28. p.verse { margin-left: 3%; }
  29. pre {
  30. border: 1px solid #ccc;
  31. box-shadow: 3px 3px 3px #eee;
  32. padding: 8pt;
  33. font-family: monospace;
  34. overflow: auto;
  35. margin: 1.2em;
  36. }
  37. pre.src {
  38. position: relative;
  39. overflow: visible;
  40. padding-top: 1.2em;
  41. }
  42. pre.src:before {
  43. display: none;
  44. position: absolute;
  45. background-color: white;
  46. top: -10px;
  47. right: 10px;
  48. padding: 3px;
  49. border: 1px solid black;
  50. }
  51. pre.src:hover:before { display: inline;}
  52. pre.src-sh:before { content: 'sh'; }
  53. pre.src-bash:before { content: 'sh'; }
  54. pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
  55. pre.src-R:before { content: 'R'; }
  56. pre.src-perl:before { content: 'Perl'; }
  57. pre.src-java:before { content: 'Java'; }
  58. pre.src-sql:before { content: 'SQL'; }
  59. table { border-collapse:collapse; }
  60. caption.t-above { caption-side: top; }
  61. caption.t-bottom { caption-side: bottom; }
  62. td, th { vertical-align:top; }
  63. th.right { text-align: center; }
  64. th.left { text-align: center; }
  65. th.center { text-align: center; }
  66. td.right { text-align: right; }
  67. td.left { text-align: left; }
  68. td.center { text-align: center; }
  69. dt { font-weight: bold; }
  70. .footpara:nth-child(2) { display: inline; }
  71. .footpara { display: block; }
  72. .footdef { margin-bottom: 1em; }
  73. .figure { padding: 1em; }
  74. .figure p { text-align: center; }
  75. .inlinetask {
  76. padding: 10px;
  77. border: 2px solid gray;
  78. margin: 10px;
  79. background: #ffffcc;
  80. }
  81. #org-div-home-and-up
  82. { text-align: right; font-size: 70%; white-space: nowrap; }
  83. textarea { overflow-x: auto; }
  84. .linenr { font-size: smaller }
  85. .code-highlighted { background-color: #ffff00; }
  86. .org-info-js_info-navigation { border-style: none; }
  87. #org-info-js_console-label
  88. { font-size: 10px; font-weight: bold; white-space: nowrap; }
  89. .org-info-js_search-highlight
  90. { background-color: #ffff00; color: #000000; font-weight: bold; }
  91. /*]]>*/-->
  92. </style>
  93. <link rel="stylesheet" type="text/css" href="freedombone.css" />
  94. <script type="text/javascript">
  95. /*
  96. @licstart The following is the entire license notice for the
  97. JavaScript code in this tag.
  98. Copyright (C) 2012-2013 Free Software Foundation, Inc.
  99. The JavaScript code in this tag is free software: you can
  100. redistribute it and/or modify it under the terms of the GNU
  101. General Public License (GNU GPL) as published by the Free Software
  102. Foundation, either version 3 of the License, or (at your option)
  103. any later version. The code is distributed WITHOUT ANY WARRANTY;
  104. without even the implied warranty of MERCHANTABILITY or FITNESS
  105. FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
  106. As additional permission under GNU GPL version 3 section 7, you
  107. may distribute non-source (e.g., minimized or compacted) forms of
  108. that code without the copy of the GNU GPL normally required by
  109. section 4, provided you include this license notice and a URL
  110. through which recipients can access the Corresponding Source.
  111. @licend The above is the entire license notice
  112. for the JavaScript code in this tag.
  113. */
  114. <!--/*--><![CDATA[/*><!--*/
  115. function CodeHighlightOn(elem, id)
  116. {
  117. var target = document.getElementById(id);
  118. if(null != target) {
  119. elem.cacheClassElem = elem.className;
  120. elem.cacheClassTarget = target.className;
  121. target.className = "code-highlighted";
  122. elem.className = "code-highlighted";
  123. }
  124. }
  125. function CodeHighlightOff(elem, id)
  126. {
  127. var target = document.getElementById(id);
  128. if(elem.cacheClassElem)
  129. elem.className = elem.cacheClassElem;
  130. if(elem.cacheClassTarget)
  131. target.className = elem.cacheClassTarget;
  132. }
  133. /*]]>*///-->
  134. </script>
  135. </head>
  136. <body>
  137. <div id="preamble" class="status">
  138. <a name="top" id="top"></a>
  139. </div>
  140. <div id="content">
  141. <h1 class="title"></h1>
  142. <div class="figure">
  143. <p><img src="images/logo.png" alt="logo.png" width="80%" height="10%" align="center" />
  144. </p>
  145. </div>
  146. <div id="outline-container-sec-1" class="outline-2">
  147. <h2 id="sec-1">GNU Social</h2>
  148. <div class="outline-text-2" id="text-1">
  149. <p>
  150. GNU Social is typically referred to as a microblogging system, although with a maximum post length much longer than Twitter it's really a sort of federated community blog with a stream-based appearance which also supports markdown formatting.
  151. </p>
  152. <p>
  153. You can host your own GNU Social instance and then "<i>remote follow</i>" other users who may also be doing the same. With a federated structure this type of system is hard to censor or ban. Unlike Twitter, there are no bribed adverts pushed into your stream, and any trends happening are likely to be real rather than being manipulated by some opaque algorithm.
  154. </p>
  155. <p>
  156. You should regard anything posted to GNU Social as being <i>public communication</i> visible to anyone on the internet. There is a direct messaging capability between users but it's not particularly secure, so for one-to-one messages stick to better methods, such as XMPP with OpenPGP/OMEMO or Tox.
  157. </p>
  158. <p>
  159. Some general advice about life in the fediverse <a href="./fediverse.html">can be found here</a>.
  160. </p>
  161. <div class="figure">
  162. <p><img src="images/gnusocial_pleroma.jpg" alt="gnusocial_pleroma.jpg" width="100%" align="center" />
  163. </p>
  164. </div>
  165. </div>
  166. </div>
  167. <div id="outline-container-sec-2" class="outline-2">
  168. <h2 id="sec-2">Installation</h2>
  169. <div class="outline-text-2" id="text-2">
  170. <p>
  171. Log into your system with:
  172. </p>
  173. <div class="org-src-container">
  174. <pre class="src src-bash">ssh myusername@mydomain -p 2222
  175. </pre>
  176. </div>
  177. <p>
  178. Using cursor keys and Enter key select <b>Administrator controls</b> and type in your password.
  179. </p>
  180. <p>
  181. Select <b>Add/Remove Apps</b> then <b>gnusocial</b>. You will then be asked for a domain name and if you are using FreeDNS also the code for the domain which can be found under <b>Dynamic DNS</b> on the FreeDNS site (the random string from "<i>quick cron example</i>" which appears after <i>update.php?</i> and before <i>&gt;&gt;</i>). For more details on obtaining a domain and making it accessible via dynamic DNS see the <a href="./faq.html">FAQ</a>. You can also add a welcome message and background picture URL if you wish, although those things are optional. Typically the domain name you use will be a subdomain, such as <i>gnusocial.mydomainname.net</i>. It will need to be a domain which you have bought somewhere and own and not one of the FreeDNS subdomains, otherwise you won't be able to get a SSL/TLS certificate for it.
  182. </p>
  183. <p>
  184. After the install has completed go to <b>Security settings</b> and select <b>Create a new Let's Encrypt certificate</b> and enter the domain name that you are using for GNU Social. If you're using the "onion only" version of the system then you don't need to do this. If the certificate is obtained successfully then you will see a congratulations message.
  185. </p>
  186. </div>
  187. </div>
  188. <div id="outline-container-sec-3" class="outline-2">
  189. <h2 id="sec-3">Initial setup</h2>
  190. <div class="outline-text-2" id="text-3">
  191. <p>
  192. If you have just obtained a Lets Encrypt certificate as above then go to <b>About</b> on the administrator control panel and you should see your GNU Social domain listed there along with an onion address. You can then navigate to your site in a browser.
  193. </p>
  194. <p>
  195. To see the login password for your site go to <b>Passwords</b> on the <b>Administrator control panel</b> and select the appropriate username and app. The passwords will be different for each user and may not be the same as the password which you used to originally ssh into the system.
  196. </p>
  197. <p>
  198. Once you have logged in to GNU Social you may then want to select <b>Admin</b> and check or change the details. You may also wish to change the license for the site to be either Creative Commons or private.
  199. </p>
  200. <p>
  201. GNU Social has a clutter-free mobile user interface which can be accessed via a Tor compatible browser (make sure to add a NoScript exception). Unlike similar proprietary sites there are no bribed posts.
  202. </p>
  203. <div class="figure">
  204. <p><img src="images/gnusocial_mobile.jpg" alt="gnusocial_mobile.jpg" width="80%" align="center" />
  205. </p>
  206. </div>
  207. </div>
  208. </div>
  209. <div id="outline-container-sec-4" class="outline-2">
  210. <h2 id="sec-4">Switching user interfaces</h2>
  211. <div class="outline-text-2" id="text-4">
  212. <p>
  213. A few web based user interfaces are available for GNU SOcial. They are selectable by going to the <b>Administrator control panel</b> and choosing <b>App settings</b> then <b>gnusocial</b>.
  214. </p>
  215. <div class="figure">
  216. <p><img src="images/gnusocial_settings.jpg" alt="gnusocial_settings.jpg" width="80%" align="center" />
  217. </p>
  218. </div>
  219. <ul class="org-ul">
  220. <li><b>Qvitter</b>: Looks similar to Twitter during its golden era, before the ads and other antifeatures arrived
  221. </li>
  222. <li><b>Pleroma</b>: A modern and lightweight user interface
  223. </li>
  224. <li><b>Classic</b>: Like the original StatusNet UI. Minimal Javascript and has good support for threaded conversations.
  225. </li>
  226. </ul>
  227. </div>
  228. </div>
  229. <div id="outline-container-sec-5" class="outline-2">
  230. <h2 id="sec-5">Using with Emacs</h2>
  231. <div class="outline-text-2" id="text-5">
  232. <div class="figure">
  233. <p><img src="images/gnu-social-mode.jpg" alt="gnu-social-mode.jpg" width="100%" align="center" />
  234. </p>
  235. </div>
  236. <p>
  237. If you are an Emacs user it's also possible to set up GNU Social mode as follows:
  238. </p>
  239. <div class="org-src-container">
  240. <pre class="src src-bash">mkdir ~/elisp
  241. git clone https://code.freedombone.net/bashrc/gnu-social-mode ~/elisp/gnu-social-mode
  242. echo "(add-to-list 'load-path \"~/elisp/gnu-social-mode\")" &gt;&gt; ~/.emacs
  243. echo "(require 'gnu-social-mode)" &gt;&gt; ~/.emacs
  244. echo "(setq gnu-social-server-textlimit 2000" &gt;&gt; ~/.emacs
  245. echo " gnu-social-server \"yourgnusocialdomain\"" &gt;&gt; ~/.emacs
  246. echo " gnu-social-username \"yourusername\"" &gt;&gt; ~/.emacs
  247. echo " gnu-social-password \"gnusocialpassword\")" &gt;&gt; ~/.emacs
  248. </pre>
  249. </div>
  250. <p>
  251. And as a quick reference the main keys are:
  252. </p>
  253. <div class="org-src-container">
  254. <pre class="src src-bash">M-x gnu-social
  255. </pre>
  256. </div>
  257. <p>
  258. The basics:
  259. </p>
  260. <table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
  261. <colgroup>
  262. <col class="left" />
  263. <col class="left" />
  264. </colgroup>
  265. <tbody>
  266. <tr>
  267. <td class="left">i</td>
  268. <td class="left">Show icons</td>
  269. </tr>
  270. <tr>
  271. <td class="left">CTRL-c CTRL-s</td>
  272. <td class="left">Post status update</td>
  273. </tr>
  274. <tr>
  275. <td class="left">r</td>
  276. <td class="left">Repeat</td>
  277. </tr>
  278. <tr>
  279. <td class="left">F</td>
  280. <td class="left">Favourite</td>
  281. </tr>
  282. <tr>
  283. <td class="left">CTRL-c CTRL-h</td>
  284. <td class="left">Highlight</td>
  285. </tr>
  286. <tr>
  287. <td class="left">R</td>
  288. <td class="left">Reply to user</td>
  289. </tr>
  290. <tr>
  291. <td class="left">CTRL-c CTRL-r</td>
  292. <td class="left">Show replies</td>
  293. </tr>
  294. <tr>
  295. <td class="left">CTRL-c CTRL-f</td>
  296. <td class="left">Friends timeline</td>
  297. </tr>
  298. <tr>
  299. <td class="left">CTRL-c CTRL-v</td>
  300. <td class="left">View user profile</td>
  301. </tr>
  302. </tbody>
  303. </table>
  304. <p>
  305. Navigation:
  306. </p>
  307. <table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
  308. <colgroup>
  309. <col class="left" />
  310. <col class="left" />
  311. </colgroup>
  312. <tbody>
  313. <tr>
  314. <td class="left">j</td>
  315. <td class="left">Next</td>
  316. </tr>
  317. <tr>
  318. <td class="left">k</td>
  319. <td class="left">Previous</td>
  320. </tr>
  321. </tbody>
  322. </table>
  323. <p>
  324. Showing timelines:
  325. </p>
  326. <table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
  327. <colgroup>
  328. <col class="left" />
  329. <col class="left" />
  330. </colgroup>
  331. <tbody>
  332. <tr>
  333. <td class="left">g</td>
  334. <td class="left">Current timeline</td>
  335. </tr>
  336. <tr>
  337. <td class="left">CTRL-c CTRL-a</td>
  338. <td class="left">Public timeline</td>
  339. </tr>
  340. <tr>
  341. <td class="left">CTRL-c CTRL-g</td>
  342. <td class="left">Group timeline</td>
  343. </tr>
  344. <tr>
  345. <td class="left">CTRL-c CTRL-t</td>
  346. <td class="left">Tag timeline</td>
  347. </tr>
  348. <tr>
  349. <td class="left">CTRL-c CTRL-k</td>
  350. <td class="left">Stop</td>
  351. </tr>
  352. <tr>
  353. <td class="left">CTRL-c CTRL-u</td>
  354. <td class="left">User timeline</td>
  355. </tr>
  356. <tr>
  357. <td class="left">CTRL-c CTRL-c</td>
  358. <td class="left">Conversation timeline</td>
  359. </tr>
  360. <tr>
  361. <td class="left">CTRL-c CTRL-o</td>
  362. <td class="left">Remote user timeline</td>
  363. </tr>
  364. <tr>
  365. <td class="left">CTRL-c CTRL-d</td>
  366. <td class="left">Post direct Message</td>
  367. </tr>
  368. </tbody>
  369. </table>
  370. </div>
  371. </div>
  372. <div id="outline-container-sec-6" class="outline-2">
  373. <h2 id="sec-6">Blocking controls</h2>
  374. <div class="outline-text-2" id="text-6">
  375. <div class="figure">
  376. <p><img src="images/controlpanel/control_panel_blocking.jpg" alt="control_panel_blocking.jpg" width="80%" align="center" />
  377. </p>
  378. </div>
  379. <p>
  380. The biggest hazard with GNU Social is that it's part of a public federated communications system. This means that conversations and replies from other servers may end up in your "whole known network" stream. The internet being what it is, some of these could be undesirable. You can block individual users or entire domains by going to the <b>Administrator control panel</b> and selecting <b>Domain or User Blocking</b>, then adding or removing entries. This blocks domains at the firewall level and also at the level of database and file storage.
  381. </p>
  382. <p>
  383. If you want to block a particular user then select <b>Block a domain or user</b> and enter the user in the format <b>username@domaintoblock</b> (similar to an email address).
  384. </p>
  385. </div>
  386. </div>
  387. </div>
  388. <div id="postamble" class="status">
  389. <style type="text/css">
  390. .back-to-top {
  391. position: fixed;
  392. bottom: 2em;
  393. right: 0px;
  394. text-decoration: none;
  395. color: #000000;
  396. background-color: rgba(235, 235, 235, 0.80);
  397. font-size: 12px;
  398. padding: 1em;
  399. display: none;
  400. }
  401. .back-to-top:hover {
  402. background-color: rgba(135, 135, 135, 0.50);
  403. }
  404. </style>
  405. <div class="back-to-top">
  406. <a href="#top">Back to top</a> | <a href="mailto:bob@freedombone.net">E-mail me</a>
  407. </div>
  408. </div>
  409. </body>
  410. </html>