123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284
  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:52 -->
  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 Pleroma"
  12. />
  13. <meta name="keywords" content="freedombone, pleroma" />
  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. <blockquote>
  147. <p>
  148. "<i>The way to keep giant companies from sterilizing the Internet is to make their sites irrelevant. If all the cool stuff happens elsewhere, people will follow. We did this with AOL and Prodigy, and we can do it again.</i>" &#x2013; Maciej Cegłowski
  149. </p>
  150. </blockquote>
  151. <p>
  152. Pleroma is an OStatus and ActivityPub compatible social networking server, compatible with GNU Social, PostActiv and Mastodon. It is high-performance and so is especially well suited for running on low power single board computers without much RAM.
  153. </p>
  154. <p>
  155. Some general advice about life in the fediverse <a href="./fediverse.html">can be found here</a>.
  156. </p>
  157. <div class="figure">
  158. <p><img src="images/pleroma.jpg" alt="pleroma.jpg" width="100%" align="center" />
  159. </p>
  160. </div>
  161. <div id="outline-container-sec-1" class="outline-2">
  162. <h2 id="sec-1">Installation</h2>
  163. <div class="outline-text-2" id="text-1">
  164. <p>
  165. Log into your system with:
  166. </p>
  167. <div class="org-src-container">
  168. <pre class="src src-bash">ssh myusername@mydomain -p 2222
  169. </pre>
  170. </div>
  171. <p>
  172. Using cursor keys and Enter key select <b>Administrator controls</b> and type in your password.
  173. </p>
  174. <p>
  175. Select <b>Add/Remove Apps</b> then <b>pleroma</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>. Typically the domain name you use will be a subdomain, such as <i>pleroma.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.
  176. </p>
  177. </div>
  178. </div>
  179. <div id="outline-container-sec-2" class="outline-2">
  180. <h2 id="sec-2">Initial setup</h2>
  181. <div class="outline-text-2" id="text-2">
  182. <p>
  183. The first thing you'll need to do is to obtain your login details. From the <b>administrator control panel</b> select <b>security settings</b> then <b>passwords</b> then <b>pleroma</b>. This gives the password you will need to log in, together with the username you gave during installation of the Freedombone system.
  184. </p>
  185. <p>
  186. Once you have done that then you can disable further registrations from the <b>Administrator control panel</b> by going to <b>App Settings</b> then <b>pleroma</b> then <b>Disable new account registrations</b>. This may take a while because the app gets recompiled afterwards.
  187. </p>
  188. </div>
  189. </div>
  190. <div id="outline-container-sec-3" class="outline-2">
  191. <h2 id="sec-3">Mastodon user interface</h2>
  192. <div class="outline-text-2" id="text-3">
  193. <p>
  194. If you prefer a Tweetdeck-style user interface, similar to Mastodon, then once you have registered an account navigate to <b>/yourpleromadomainname/web</b> and log in.
  195. </p>
  196. <div class="figure">
  197. <p><img src="images/pleromamastodon.jpg" alt="pleromamastodon.jpg" width="100%" align="center" />
  198. </p>
  199. </div>
  200. </div>
  201. </div>
  202. <div id="outline-container-sec-4" class="outline-2">
  203. <h2 id="sec-4">Mobile apps</h2>
  204. <div class="outline-text-2" id="text-4">
  205. <p>
  206. It's also possible to use Mastodon apps together with Pleroma, such as Tusky, since it supports the Mastodon API. You may need to install <b>IcecatMobile</b> and set it as your default browser (under <b>Settings/Apps/Menu</b>) in order for the initial oauth registration process to work.
  207. </p>
  208. <div class="figure">
  209. <p><img src="images/tusky.jpg" alt="tusky.jpg" width="50%" align="center" />
  210. </p>
  211. </div>
  212. </div>
  213. </div>
  214. <div id="outline-container-sec-5" class="outline-2">
  215. <h2 id="sec-5">Blocking controls</h2>
  216. <div class="outline-text-2" id="text-5">
  217. <div class="figure">
  218. <p><img src="images/controlpanel/control_panel_blocking.jpg" alt="control_panel_blocking.jpg" width="80%" align="center" />
  219. </p>
  220. </div>
  221. <p>
  222. The biggest hazard with Pleroma 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.
  223. </p>
  224. <p>
  225. 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).
  226. </p>
  227. </div>
  228. </div>
  229. </div>
  230. <div id="postamble" class="status">
  231. <style type="text/css">
  232. .back-to-top {
  233. position: fixed;
  234. bottom: 2em;
  235. right: 0px;
  236. text-decoration: none;
  237. color: #000000;
  238. background-color: rgba(235, 235, 235, 0.80);
  239. font-size: 12px;
  240. padding: 1em;
  241. display: none;
  242. }
  243. .back-to-top:hover {
  244. background-color: rgba(135, 135, 135, 0.50);
  245. }
  246. </style>
  247. <div class="back-to-top">
  248. <a href="#top">Back to top</a> | <a href="mailto:bob@freedombone.net">E-mail me</a>
  249. </div>
  250. </div>
  251. </body>
  252. </html>