Notes on etherpad

This commit is contained in:
Bob Mottram 2016-11-14 14:45:42 +00:00
parent 802ad58a8a
commit 763e61cc2e
5 changed files with 136 additions and 86 deletions

41
doc/EN/app_etherpad.org Normal file
View File

@ -0,0 +1,41 @@
#+TITLE:
#+AUTHOR: Bob Mottram
#+EMAIL: bob@freedombone.net
#+KEYWORDS: freedombone, etherpad
#+DESCRIPTION: How to use Etherpad
#+OPTIONS: ^:nil toc:nil
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="freedombone.css" />
#+BEGIN_CENTER
[[file:images/logo.png]]
#+END_CENTER
#+BEGIN_EXPORT html
<center>
<h1>Mailpile</h1>
</center>
#+END_EXPORT
For collaborative document editing Etherpad is hard to beat. Just log in, choose a document title and then edit. Different users will appear in different colours, and can also chat in the sidebar. This is installed as a private system in which only users on your Freedombone server will be able to create and edit documents, so it's not open to any random users on the internet.
* Installation
Log into your system with:
#+begin_src bash
ssh myusername@mydomain -p 2222
#+end_src
Using cursor keys, space bar and Enter key select *Administrator controls* and type in your password.
Select *Add/Remove Apps* then *etherpad*. 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 *Dynamic DNS* on the FreeDNS site (the random string from "/quick cron example/" which appears after /update.php?/ and before />>/). For more details on obtaining a domain and making it accessible via dynamic DNS see the [[./faq.html][FAQ]]. Typically the domain name you use will be a subdomain, such as /wiki.mydomainname.net/. 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.
After the install has completed go to *Security settings* and select *Create a new Let's Encrypt certificate* and enter the domain name that you are using for Etherpad. 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.
* Initial setup
If you have just obtained a Lets Encrypt certificate as above then go to *About* on the administrator control panel and you should see your Etherpad domain listed there along with an onion address. You can then navigate to your site in a browser.
If you installed the system using a disk image then you can log in using the username and password which was originally shown when you installed the system. If you didn't install from a disk image then a new random password will be generated for each site and stored within a readme file. If you need to view that file then exit to the user control panel, select *Exit to the command line* and then run:
#+begin_src bash
editor README
#+end_src

View File

@ -34,6 +34,7 @@ If you use the Mutt client to read your email then this will set it up to use em
* Etherpad
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.
[[./app_etherpad.html][How to use it]]
* Ghost
Modern looking blogging system.

View File

@ -26,6 +26,7 @@
| [[./app_gnusocial.html][Microblogging (GNU Social)]] |
| [[./app_hubzilla.html][Social Network]] |
| [[./app_dokuwiki.html][Wiki]] |
| [[./app_etherpad.html][Collaborative document editing]] |
| [[./app_irc.html][Multi-user chat with IRC]] |
| [[./app_xmpp.html][XMPP/Jabber]] |
| [[./app_tox.html][Tox]] |

View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2016-11-14 Mon 14:34 -->
<!-- 2016-11-14 Mon 14:44 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title></title>
@ -257,9 +257,9 @@ The base install of the system just contains an email server and Mutt client, bu
</div>
</div>
<div id="outline-container-org6b0cb3c" class="outline-2">
<h2 id="org6b0cb3c">DLNA</h2>
<div class="outline-text-2" id="text-org6b0cb3c">
<div id="outline-container-orgd0aa565" class="outline-2">
<h2 id="orgd0aa565">DLNA</h2>
<div class="outline-text-2" id="text-orgd0aa565">
<p>
Enables you to use the system as a music server which any DLNA compatible devices can connect to within your home network.
</p>
@ -269,9 +269,9 @@ Enables you to use the system as a music server which any DLNA compatible device
</p>
</div>
</div>
<div id="outline-container-org1edaf37" class="outline-2">
<h2 id="org1edaf37">Dokuwiki</h2>
<div class="outline-text-2" id="text-org1edaf37">
<div id="outline-container-orgecf832a" class="outline-2">
<h2 id="orgecf832a">Dokuwiki</h2>
<div class="outline-text-2" id="text-orgecf832a">
<p>
A databaseless wiki system.
</p>
@ -281,36 +281,39 @@ A databaseless wiki system.
</p>
</div>
</div>
<div id="outline-container-org07e9247" class="outline-2">
<h2 id="org07e9247">Emacs</h2>
<div class="outline-text-2" id="text-org07e9247">
<div id="outline-container-orgfab0d83" class="outline-2">
<h2 id="orgfab0d83">Emacs</h2>
<div class="outline-text-2" id="text-orgfab0d83">
<p>
If you use the Mutt client to read your email then this will set it up to use emacs for composing new mail.
</p>
</div>
</div>
<div id="outline-container-orgbbbf14d" class="outline-2">
<h2 id="orgbbbf14d">Etherpad</h2>
<div class="outline-text-2" id="text-orgbbbf14d">
<div id="outline-container-orgb55d364" class="outline-2">
<h2 id="orgb55d364">Etherpad</h2>
<div class="outline-text-2" id="text-orgb55d364">
<p>
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.
</p>
</div>
</div>
<div id="outline-container-orga446976" class="outline-2">
<h2 id="orga446976">Ghost</h2>
<div class="outline-text-2" id="text-orga446976">
<p>
<a href="./app_etherpad.html">How to use it</a>
</p>
</div>
</div>
<div id="outline-container-org63c3d65" class="outline-2">
<h2 id="org63c3d65">Ghost</h2>
<div class="outline-text-2" id="text-org63c3d65">
<p>
Modern looking blogging system.
</p>
</div>
</div>
<div id="outline-container-org03949bb" class="outline-2">
<h2 id="org03949bb">GNU Social</h2>
<div class="outline-text-2" id="text-org03949bb">
<div id="outline-container-org61aebd3" class="outline-2">
<h2 id="org61aebd3">GNU Social</h2>
<div class="outline-text-2" id="text-org61aebd3">
<p>
Federated social network. You can "<i>remote follow</i>" other users within the GNU Social federation.
</p>
@ -320,9 +323,9 @@ Federated social network. You can "<i>remote follow</i>" other users within the
</p>
</div>
</div>
<div id="outline-container-orge3152c7" class="outline-2">
<h2 id="orge3152c7">Gogs</h2>
<div class="outline-text-2" id="text-orge3152c7">
<div id="outline-container-orgc4ad28e" class="outline-2">
<h2 id="orgc4ad28e">Gogs</h2>
<div class="outline-text-2" id="text-orgc4ad28e">
<p>
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.
</p>
@ -332,18 +335,18 @@ Lightweight git project hosting system. You can mirror projects from Github, or
</p>
</div>
</div>
<div id="outline-container-orgf79df97" class="outline-2">
<h2 id="orgf79df97">HTMLy</h2>
<div class="outline-text-2" id="text-orgf79df97">
<div id="outline-container-org3d69c4e" class="outline-2">
<h2 id="org3d69c4e">HTMLy</h2>
<div class="outline-text-2" id="text-org3d69c4e">
<p>
Databaseless blogging system. Quite simple and with a markdown-like format.
</p>
</div>
</div>
<div id="outline-container-org052cad7" class="outline-2">
<h2 id="org052cad7">Hubzilla</h2>
<div class="outline-text-2" id="text-org052cad7">
<div id="outline-container-orgf16ecb5" class="outline-2">
<h2 id="orgf16ecb5">Hubzilla</h2>
<div class="outline-text-2" id="text-orgf16ecb5">
<p>
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.
</p>
@ -353,9 +356,9 @@ Web publishing platform with social network like features and good privacy contr
</p>
</div>
</div>
<div id="outline-container-orgbf4c5c3" class="outline-2">
<h2 id="orgbf4c5c3">IRC Server (ngirc)</h2>
<div class="outline-text-2" id="text-orgbf4c5c3">
<div id="outline-container-org4d2ee61" class="outline-2">
<h2 id="org4d2ee61">IRC Server (ngirc)</h2>
<div class="outline-text-2" id="text-org4d2ee61">
<p>
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.
</p>
@ -365,27 +368,27 @@ Run your own IRC chat channel which can be secured with a password and accessibl
</p>
</div>
</div>
<div id="outline-container-org69c0d7e" class="outline-2">
<h2 id="org69c0d7e">Jitsi Meet</h2>
<div class="outline-text-2" id="text-org69c0d7e">
<div id="outline-container-org432e8cb" class="outline-2">
<h2 id="org432e8cb">Jitsi Meet</h2>
<div class="outline-text-2" id="text-org432e8cb">
<p>
Experimental WebRTC video conferencing system, similar to Google Hangouts. This may not be fully functional, but is hoped to be in the near future.
</p>
</div>
</div>
<div id="outline-container-orgdb1664e" class="outline-2">
<h2 id="orgdb1664e">Lychee</h2>
<div class="outline-text-2" id="text-orgdb1664e">
<div id="outline-container-org1047b5f" class="outline-2">
<h2 id="org1047b5f">Lychee</h2>
<div class="outline-text-2" id="text-org1047b5f">
<p>
Make your photo albums available on the web.
</p>
</div>
</div>
<div id="outline-container-org39c239b" class="outline-2">
<h2 id="org39c239b">Mailpile</h2>
<div class="outline-text-2" id="text-org39c239b">
<div id="outline-container-org5c41d4c" class="outline-2">
<h2 id="org5c41d4c">Mailpile</h2>
<div class="outline-text-2" id="text-org5c41d4c">
<p>
Modern email client which supports GPG encryption.
</p>
@ -395,9 +398,9 @@ Modern email client which supports GPG encryption.
</p>
</div>
</div>
<div id="outline-container-org8b10156" class="outline-2">
<h2 id="org8b10156">Mumble</h2>
<div class="outline-text-2" id="text-org8b10156">
<div id="outline-container-org221969e" class="outline-2">
<h2 id="org221969e">Mumble</h2>
<div class="outline-text-2" id="text-org221969e">
<p>
The popular VoIP and text chat system. Say goodbye to old-fashioned telephony conferences with silly dial codes. Also works well on mobile.
</p>
@ -407,9 +410,9 @@ The popular VoIP and text chat system. Say goodbye to old-fashioned telephony co
</p>
</div>
</div>
<div id="outline-container-org7d319bc" class="outline-2">
<h2 id="org7d319bc">PI-Hole</h2>
<div class="outline-text-2" id="text-org7d319bc">
<div id="outline-container-org1b69edd" class="outline-2">
<h2 id="org1b69edd">PI-Hole</h2>
<div class="outline-text-2" id="text-org1b69edd">
<p>
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.
</p>
@ -419,27 +422,27 @@ The black hole for web adverts. Block adverts at the domain name level within yo
</p>
</div>
</div>
<div id="outline-container-org813cfb0" class="outline-2">
<h2 id="org813cfb0">PostActiv</h2>
<div class="outline-text-2" id="text-org813cfb0">
<div id="outline-container-orgd048719" class="outline-2">
<h2 id="orgd048719">PostActiv</h2>
<div class="outline-text-2" id="text-orgd048719">
<p>
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.
</p>
</div>
</div>
<div id="outline-container-org57c1ea4" class="outline-2">
<h2 id="org57c1ea4">Radicale</h2>
<div class="outline-text-2" id="text-org57c1ea4">
<div id="outline-container-orgae34b71" class="outline-2">
<h2 id="orgae34b71">Radicale</h2>
<div class="outline-text-2" id="text-orgae34b71">
<p>
Calendar system compatible with CalDAV and CardDAV. Manage your calendar events easily across all your devices.
</p>
</div>
</div>
<div id="outline-container-org7d960e6" class="outline-2">
<h2 id="org7d960e6">tt-rss</h2>
<div class="outline-text-2" id="text-org7d960e6">
<div id="outline-container-org1b3357d" class="outline-2">
<h2 id="org1b3357d">tt-rss</h2>
<div class="outline-text-2" id="text-org1b3357d">
<p>
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.
</p>
@ -449,9 +452,9 @@ Private RSS reader. Pulls in RSS/Atom feeds via Tor and is only accessible via a
</p>
</div>
</div>
<div id="outline-container-orgea64faa" class="outline-2">
<h2 id="orgea64faa">Syncthing</h2>
<div class="outline-text-2" id="text-orgea64faa">
<div id="outline-container-org4d37ad9" class="outline-2">
<h2 id="org4d37ad9">Syncthing</h2>
<div class="outline-text-2" id="text-org4d37ad9">
<p>
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.
</p>
@ -461,9 +464,9 @@ Possibly the best way to synchronise files across all of your devices. Once it h
</p>
</div>
</div>
<div id="outline-container-orgf726393" class="outline-2">
<h2 id="orgf726393">Tox</h2>
<div class="outline-text-2" id="text-orgf726393">
<div id="outline-container-orgc8c5f1a" class="outline-2">
<h2 id="orgc8c5f1a">Tox</h2>
<div class="outline-text-2" id="text-orgc8c5f1a">
<p>
Client and bootstrap node for the Tox chat/VoIP system.
</p>
@ -473,18 +476,18 @@ Client and bootstrap node for the Tox chat/VoIP system.
</p>
</div>
</div>
<div id="outline-container-orgd2cad13" class="outline-2">
<h2 id="orgd2cad13">Vim</h2>
<div class="outline-text-2" id="text-orgd2cad13">
<div id="outline-container-org339ace5" class="outline-2">
<h2 id="org339ace5">Vim</h2>
<div class="outline-text-2" id="text-org339ace5">
<p>
If you use the Mutt client to read your email then this will set it up to use vim for composing new mail.
</p>
</div>
</div>
<div id="outline-container-org1c1ea0f" class="outline-2">
<h2 id="org1c1ea0f">XMPP</h2>
<div class="outline-text-2" id="text-org1c1ea0f">
<div id="outline-container-org4587b35" class="outline-2">
<h2 id="org4587b35">XMPP</h2>
<div class="outline-text-2" id="text-org4587b35">
<p>
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.
</p>

View File

@ -3,7 +3,7 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2016-11-14 Mon 14:35 -->
<!-- 2016-11-14 Mon 14:45 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title></title>
@ -255,15 +255,15 @@ for the JavaScript code in this tag.
</colgroup>
<tbody>
<tr>
<td class="org-left"><a href="#org08009e1">Readme</a></td>
<td class="org-left"><a href="#orga82b0a7">Readme</a></td>
</tr>
<tr>
<td class="org-left"><a href="#org1880b3a">Improving ssh security</a></td>
<td class="org-left"><a href="#orgd17333f">Improving ssh security</a></td>
</tr>
<tr>
<td class="org-left"><a href="#org6ba1d5e">Administrating the system via an onion address (Tor)</a></td>
<td class="org-left"><a href="#orgb7a0b80">Administrating the system via an onion address (Tor)</a></td>
</tr>
<tr>
@ -294,6 +294,10 @@ for the JavaScript code in this tag.
<td class="org-left"><a href="./app_dokuwiki.html">Wiki</a></td>
</tr>
<tr>
<td class="org-left"><a href="./app_etherpad.html">Collaborative document editing</a></td>
</tr>
<tr>
<td class="org-left"><a href="./app_irc.html">Multi-user chat with IRC</a></td>
</tr>
@ -323,7 +327,7 @@ for the JavaScript code in this tag.
</tr>
<tr>
<td class="org-left"><a href="#org2486541">Adding or removing users</a></td>
<td class="org-left"><a href="#orgd120dab">Adding or removing users</a></td>
</tr>
<tr>
@ -332,9 +336,9 @@ for the JavaScript code in this tag.
</tbody>
</table>
<div id="outline-container-org08009e1" class="outline-2">
<h2 id="org08009e1">Readme</h2>
<div class="outline-text-2" id="text-org08009e1">
<div id="outline-container-orga82b0a7" class="outline-2">
<h2 id="orga82b0a7">Readme</h2>
<div class="outline-text-2" id="text-orga82b0a7">
<p>
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:
</p>
@ -354,9 +358,9 @@ To exit you can either just close the terminal or use <b>CTRL-x CTRL-c</b> follo
</p>
</div>
</div>
<div id="outline-container-org1880b3a" class="outline-2">
<h2 id="org1880b3a">Improving ssh security</h2>
<div class="outline-text-2" id="text-org1880b3a">
<div id="outline-container-orgd17333f" class="outline-2">
<h2 id="orgd17333f">Improving ssh security</h2>
<div class="outline-text-2" id="text-orgd17333f">
<p>
To improve ssh security you can generate an ssh key pair on your system and then upload the public key to the Freedombone.
</p>
@ -406,9 +410,9 @@ If you wish to only use ssh keys then log in to the Freedombone, become the root
</div>
</div>
<div id="outline-container-org6ba1d5e" class="outline-2">
<h2 id="org6ba1d5e">Administrating the system via an onion address (Tor)</h2>
<div class="outline-text-2" id="text-org6ba1d5e">
<div id="outline-container-orgb7a0b80" class="outline-2">
<h2 id="orgb7a0b80">Administrating the system via an onion address (Tor)</h2>
<div class="outline-text-2" id="text-orgb7a0b80">
<p>
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:
</p>
@ -450,9 +454,9 @@ Subsequently even if dynamic DNS isn't working you may still be able to administ
</p>
</div>
</div>
<div id="outline-container-org2486541" class="outline-2">
<h2 id="org2486541">Adding or removing users</h2>
<div class="outline-text-2" id="text-org2486541">
<div id="outline-container-orgd120dab" class="outline-2">
<h2 id="orgd120dab">Adding or removing users</h2>
<div class="outline-text-2" id="text-orgd120dab">
<p>
Log into the system with:
</p>