free
/
freedomboneeee
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update usage documentation with new email commands

This commit is contained in:
Bob Mottram 2015-04-05 13:00:03 +01:00
parent d62015c061
commit 6543c14bd0
2 changed files with 163 additions and 130 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/EN/usage.org
View File

@ -229,26 +229,44 @@ To view any new folders which you may have created using the /mailinglistrule/ s
If your folder still doesn't show up then press the *menu button*, select *show folders* and select *all folders*.
** Subscribing to mailing lists
To subscribe to a mailing list so that it appears within Mutt or Thunderbird.
To subscribe to a mailing list log in as your user (i.e. not the root user).
#+BEGIN_SRC bash
ssh username@domainname -p 2222
addmailinglist <username> <mailinglistname> <subjecttag>
freedombone-addlist -l <mailing list name> -s <subject tag>
exit
#+END_SRC
The subject tag should be the word or phrase which appears within the brackets in the subject line of emails from the mailing list. The mailing list name should be something short so that it is readable within the left side column of the mutt email client.
The subject tag should be the word or phrase which appears within the brackets in the subject line of emails from the mailing list. The mailing list name should be something short so that it is readable within the left side column of the mutt email client, and contain no spaces.
** Adding email addresses to a group/folder
Similar to adding mailing list folders you can also add specified email addresses into a folder.
#+BEGIN_SRC bash
ssh username@domainname -p 2222
addemailtofolder <username> <emailaddress> <mailinglistname>
freedombone-addemail -e <email address> -l <mailing list name>
exit
#+END_SRC
The mailing list name should be something short so that it is readable within the left side column of the mutt email client.
The mailing list name should be something short so that it is readable within the left side column of the mutt email client, and not contain any spaces.
** Ignoring incoming emails
It is possible to ignore incoming emails if they are from a particular email address or if the subject line contains particular text.
#+BEGIN_SRC bash
ssh username@domainname -p 2222
freedombone-ignore -e baduser@baddomain
exit
#+END_SRC
Or:
#+BEGIN_SRC bash
ssh username@domainname -p 2222
freedombone-ignore -t "make $$$ now!"
exit
#+END_SRC
You can also reverse this by using the *freedombone-unignore* command with the same options.
* Mailing List
If you want to set up a public mailing list then when installing the system remember to set the *PUBLIC_MAILING_LIST* variable within *freedombone.cfg* to the name of your list. The name should have no spaces in it. Public mailing lists are unencrypted so anyone will be able to read the contents, including non subscribers.

265
website/EN/usage.html
View File

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title></title>
<!-- 2015-01-27 Tue 22:06 -->
<!-- 2015-04-05 Sun 12:59 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="generator" content="Org-mode" />
<meta name="author" content="Bob Mottram" />
@ -15,7 +15,8 @@
<!--/*--><![CDATA[/*><!--*/
.title { text-align: center; }
.todo { font-family: monospace; color: red; }
.done { color: green; }
.done { font-family: monospace; color: green; }
.priority { font-family: monospace; color: orange; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
@ -183,12 +184,12 @@ for the JavaScript code in this tag.
<td class="left"><a href="index.html">Home</a></td>
<td class="left"><a href="#unnumbered-1">Readme</a></td>
<td class="left"><a href="#unnumbered-3">Using Email</a></td>
<td class="left"><a href="#unnumbered-19">Mailing List</a></td>
<td class="left"><a href="#unnumbered-20">Syncing to the Cloud</a></td>
<td class="left"><a href="#unnumbered-24">Play Music</a></td>
<td class="left"><a href="#unnumbered-27">Microblogging</a></td>
<td class="left"><a href="#unnumbered-29">Social Network</a></td>
<td class="left"><a href="#unnumbered-32">Chat Services</a></td>
<td class="left"><a href="#unnumbered-20">Mailing List</a></td>
<td class="left"><a href="#unnumbered-21">Syncing to the Cloud</a></td>
<td class="left"><a href="#unnumbered-25">Play Music</a></td>
<td class="left"><a href="#unnumbered-28">Microblogging</a></td>
<td class="left"><a href="#unnumbered-30">Social Network</a></td>
<td class="left"><a href="#unnumbered-33">Chat Services</a></td>
</tr>
</tbody>
</table>
@ -508,12 +509,9 @@ The settings should be as follows, substituting <i>mydomainname.com</i> for your
</p>
<ul class="org-ul">
<li>Incoming: IMAP, mydomainname.com, 993, SSL/TLS, Normal Password
</li>
<li>Outgoing: SMTP, mydomainname.com, 465, SSL/TLS, Normal Password
</li>
<li>Username: myusername
</li>
<li>Incoming: IMAP, mydomainname.com, 993, SSL/TLS, Normal Password</li>
<li>Outgoing: SMTP, mydomainname.com, 465, SSL/TLS, Normal Password</li>
<li>Username: myusername</li>
</ul>
<p>
@ -659,20 +657,13 @@ Make sure that "<b>show only subscribed folders</b>" is not checked. Then click
<h4 id="unnumbered-14">Incoming server settings</h4>
<div class="outline-text-4" id="text-unnumbered-14">
<ul class="org-ul">
<li>Select settings/account settings
</li>
<li>Select Fetching mail/incoming server
</li>
<li>Enter your username and password
</li>
<li>IMAP server should be your domain name
</li>
<li>Security: SSL/TLS (always)
</li>
<li>Authentication: Plain
</li>
<li>Port: 993
</li>
<li>Select settings/account settings</li>
<li>Select Fetching mail/incoming server</li>
<li>Enter your username and password</li>
<li>IMAP server should be your domain name</li>
<li>Security: SSL/TLS (always)</li>
<li>Authentication: Plain</li>
<li>Port: 993</li>
</ul>
</div>
</div>
@ -680,22 +671,14 @@ Make sure that "<b>show only subscribed folders</b>" is not checked. Then click
<h4 id="unnumbered-15">Outgoing (SMTP) server settings</h4>
<div class="outline-text-4" id="text-unnumbered-15">
<ul class="org-ul">
<li>Select settings/account settings
</li>
<li>Select Sending mail/outgoing server
</li>
<li>Set SMTP server to your domain name
</li>
<li>Set Security to SSL/TLS (always)
</li>
<li>Set port to 465
</li>
<li>Set authentication to PLAIN
</li>
<li>Enter your username and password
</li>
<li>Accept the SSL certificate
</li>
<li>Select settings/account settings</li>
<li>Select Sending mail/outgoing server</li>
<li>Set SMTP server to your domain name</li>
<li>Set Security to SSL/TLS (always)</li>
<li>Set port to 465</li>
<li>Set authentication to PLAIN</li>
<li>Enter your username and password</li>
<li>Accept the SSL certificate</li>
</ul>
</div>
</div>
@ -717,19 +700,19 @@ If your folder still doesn't show up then press the <b>menu button</b>, select <
<h3 id="unnumbered-17">Subscribing to mailing lists</h3>
<div class="outline-text-3" id="text-unnumbered-17">
<p>
To subscribe to a mailing list so that it appears within Mutt or Thunderbird.
To subscribe to a mailing list log in as your user (i.e. not the root user).
</p>
<div class="org-src-container">
<pre class="src src-bash">ssh username@domainname -p 2222
addmailinglist &lt;username&gt; &lt;mailinglistname&gt; &lt;subjecttag&gt;
freedombone-addlist -l &lt;mailing list name&gt; -s &lt;subject tag&gt;
<span class="org-keyword">exit</span>
</pre>
</div>
<p>
The subject tag should be the word or phrase which appears within the brackets in the subject line of emails from the mailing list. The mailing list name should be something short so that it is readable within the left side column of the mutt email client.
The subject tag should be the word or phrase which appears within the brackets in the subject line of emails from the mailing list. The mailing list name should be something short so that it is readable within the left side column of the mutt email client, and contain no spaces.
</p>
</div>
</div>
@ -743,21 +726,53 @@ Similar to adding mailing list folders you can also add specified email addresse
<div class="org-src-container">
<pre class="src src-bash">ssh username@domainname -p 2222
addemailtofolder &lt;username&gt; &lt;emailaddress&gt; &lt;mailinglistname&gt;
freedombone-addemail -e &lt;email address&gt; -l &lt;mailing list name&gt;
<span class="org-keyword">exit</span>
</pre>
</div>
<p>
The mailing list name should be something short so that it is readable within the left side column of the mutt email client.
The mailing list name should be something short so that it is readable within the left side column of the mutt email client, and not contain any spaces.
</p>
</div>
</div>
<div id="outline-container-unnumbered-19" class="outline-3">
<h3 id="unnumbered-19">Ignoring incoming emails</h3>
<div class="outline-text-3" id="text-unnumbered-19">
<p>
It is possible to ignore incoming emails if they are from a particular email address or if the subject line contains particular text.
</p>
<div class="org-src-container">
<pre class="src src-bash">ssh username@domainname -p 2222
freedombone-ignore -e baduser@baddomain
<span class="org-keyword">exit</span>
</pre>
</div>
<p>
Or:
</p>
<div class="org-src-container">
<pre class="src src-bash">ssh username@domainname -p 2222
freedombone-ignore -t <span class="org-string">"make $$$ now!"</span>
<span class="org-keyword">exit</span>
</pre>
</div>
<p>
You can also reverse this by using the <b>freedombone-unignore</b> command with the same options.
</p>
</div>
</div>
</div>
<div id="outline-container-unnumbered-19" class="outline-2">
<h2 id="unnumbered-19">Mailing List</h2>
<div class="outline-text-2" id="text-unnumbered-19">
<div id="outline-container-unnumbered-20" class="outline-2">
<h2 id="unnumbered-20">Mailing List</h2>
<div class="outline-text-2" id="text-unnumbered-20">
<p>
If you want to set up a public mailing list then when installing the system remember to set the <b>PUBLIC_MAILING_LIST</b> variable within <b>freedombone.cfg</b> to the name of your list. The name should have no spaces in it. Public mailing lists are unencrypted so anyone will be able to read the contents, including non subscribers.
</p>
@ -777,12 +792,12 @@ Tip: When using the Mutt email client if you want to send an email in cleartext
</p>
</div>
</div>
<div id="outline-container-unnumbered-20" class="outline-2">
<h2 id="unnumbered-20">Syncing to the Cloud</h2>
<div class="outline-text-2" id="text-unnumbered-20">
</div><div id="outline-container-unnumbered-21" class="outline-3">
<h3 id="unnumbered-21">Initial install</h3>
<div class="outline-text-3" id="text-unnumbered-21">
<div id="outline-container-unnumbered-21" class="outline-2">
<h2 id="unnumbered-21">Syncing to the Cloud</h2>
<div class="outline-text-2" id="text-unnumbered-21">
</div><div id="outline-container-unnumbered-22" class="outline-3">
<h3 id="unnumbered-22">Initial install</h3>
<div class="outline-text-3" id="text-unnumbered-22">
<p>
Within a browser go to your owncloud domain, then create an administrator account. The username and password can be anything, and ideally should be generated from a password manager.
</p>
@ -826,9 +841,9 @@ Log out from the administrator account and then log back in as the user you just
</p>
</div>
</div>
<div id="outline-container-unnumbered-22" class="outline-3">
<h3 id="unnumbered-22">On Android</h3>
<div class="outline-text-3" id="text-unnumbered-22">
<div id="outline-container-unnumbered-23" class="outline-3">
<h3 id="unnumbered-23">On Android</h3>
<div class="outline-text-3" id="text-unnumbered-23">
<p>
Within F-droid search for <b>owncloud</b> and install the client. Also install <b>CalDAV Sync Adapter</b>.
</p>
@ -852,9 +867,9 @@ You will also be prompted to enter login details. Your Android and Owncloud cale
</p>
</div>
</div>
<div id="outline-container-unnumbered-23" class="outline-3">
<h3 id="unnumbered-23">On Linux</h3>
<div class="outline-text-3" id="text-unnumbered-23">
<div id="outline-container-unnumbered-24" class="outline-3">
<h3 id="unnumbered-24">On Linux</h3>
<div class="outline-text-3" id="text-unnumbered-24">
<p>
Open your software center and search for "owncloud client". Enter your owncloud domain name (with the https prefix) and login details.
</p>
@ -865,12 +880,12 @@ You can now drag files into the <b>~/owncloud</b> directory and they will automa
</div>
</div>
</div>
<div id="outline-container-unnumbered-24" class="outline-2">
<h2 id="unnumbered-24">Play Music</h2>
<div class="outline-text-2" id="text-unnumbered-24">
</div><div id="outline-container-unnumbered-25" class="outline-3">
<h3 id="unnumbered-25">With the DLNA service</h3>
<div class="outline-text-3" id="text-unnumbered-25">
<div id="outline-container-unnumbered-25" class="outline-2">
<h2 id="unnumbered-25">Play Music</h2>
<div class="outline-text-2" id="text-unnumbered-25">
</div><div id="outline-container-unnumbered-26" class="outline-3">
<h3 id="unnumbered-26">With the DLNA service</h3>
<div class="outline-text-3" id="text-unnumbered-26">
<p>
An easy way to play music on any mobile device in your home is to use the DLNA service. Copy your music into a directory called "<i>Music</i>" on a USB thumb drive and then insert it into from socket on the Beaglebone.
</p>
@ -910,9 +925,9 @@ The DLNA service will only work within your local home network, and isn't remote
</div>
</div>
<div id="outline-container-unnumbered-26" class="outline-3">
<h3 id="unnumbered-26">With Owncloud</h3>
<div class="outline-text-3" id="text-unnumbered-26">
<div id="outline-container-unnumbered-27" class="outline-3">
<h3 id="unnumbered-27">With Owncloud</h3>
<div class="outline-text-3" id="text-unnumbered-27">
<p>
The main advantage of playing music via Owncloud is that you can do that from anywhere - not only within your home network.
</p>
@ -924,12 +939,12 @@ By default a music player is installed into Owncloud, so all you need to do is t
</div>
</div>
<div id="outline-container-unnumbered-27" class="outline-2">
<h2 id="unnumbered-27">Microblogging</h2>
<div class="outline-text-2" id="text-unnumbered-27">
</div><div id="outline-container-unnumbered-28" class="outline-3">
<h3 id="unnumbered-28">Initial configuration</h3>
<div class="outline-text-3" id="text-unnumbered-28">
<div id="outline-container-unnumbered-28" class="outline-2">
<h2 id="unnumbered-28">Microblogging</h2>
<div class="outline-text-2" id="text-unnumbered-28">
</div><div id="outline-container-unnumbered-29" class="outline-3">
<h3 id="unnumbered-29">Initial configuration</h3>
<div class="outline-text-3" id="text-unnumbered-29">
<p>
To set up your microblog go to:
</p>
@ -1037,12 +1052,12 @@ When the install is complete you will see a lot of warnings but just ignore thos
</div>
</div>
</div>
<div id="outline-container-unnumbered-29" class="outline-2">
<h2 id="unnumbered-29">Social Network</h2>
<div class="outline-text-2" id="text-unnumbered-29">
</div><div id="outline-container-unnumbered-30" class="outline-3">
<h3 id="unnumbered-30">Certificates</h3>
<div class="outline-text-3" id="text-unnumbered-30">
<div id="outline-container-unnumbered-30" class="outline-2">
<h2 id="unnumbered-30">Social Network</h2>
<div class="outline-text-2" id="text-unnumbered-30">
</div><div id="outline-container-unnumbered-31" class="outline-3">
<h3 id="unnumbered-31">Certificates</h3>
<div class="outline-text-3" id="text-unnumbered-31">
<p>
You will need to have a non self-signed SSL certificate in order to use Red Matrix. Put the public certificate in <b>/etc/ssl/certs/yourredmatrixdomainname.crt</b> and the private certificate in <b>/etc/ssl/private/yourredmatrixdomainname.key</b>. If there is an intermediate certificate needed (such as with StartSSL) then this will need to be concatenated onto the end of the crt file, like this:
</p>
@ -1059,9 +1074,9 @@ Then change ssl_certificate to <b>/etc/ssl/certs/yourredmatrixdomainname.bundle.
</p>
</div>
</div>
<div id="outline-container-unnumbered-31" class="outline-3">
<h3 id="unnumbered-31">Initial install</h3>
<div class="outline-text-3" id="text-unnumbered-31">
<div id="outline-container-unnumbered-32" class="outline-3">
<h3 id="unnumbered-32">Initial install</h3>
<div class="outline-text-3" id="text-unnumbered-32">
<p>
Visit the URL of your Red Matrix site and you should be taken through the rest of the installation procedure. Note that this may take a few minutes so don't be concerned if it looks as if it has crashed - just leave it running.
</p>
@ -1072,19 +1087,19 @@ When installation is complete you can register a new user.
</div>
</div>
</div>
<div id="outline-container-unnumbered-32" class="outline-2">
<h2 id="unnumbered-32">Chat Services</h2>
<div class="outline-text-2" id="text-unnumbered-32">
</div><div id="outline-container-unnumbered-33" class="outline-3">
<h3 id="unnumbered-33">IRC</h3>
<div class="outline-text-3" id="text-unnumbered-33">
<div id="outline-container-unnumbered-33" class="outline-2">
<h2 id="unnumbered-33">Chat Services</h2>
<div class="outline-text-2" id="text-unnumbered-33">
</div><div id="outline-container-unnumbered-34" class="outline-3">
<h3 id="unnumbered-34">IRC</h3>
<div class="outline-text-3" id="text-unnumbered-34">
<p>
IRC is useful for multi-user chat. The classic use case is for software development where many engineers might need to coordinate their activities, but it's also useful for meetings, parties and general socialising.
</p>
</div>
<div id="outline-container-unnumbered-34" class="outline-4">
<h4 id="unnumbered-34">Irssi</h4>
<div class="outline-text-4" id="text-unnumbered-34">
<div id="outline-container-unnumbered-35" class="outline-4">
<h4 id="unnumbered-35">Irssi</h4>
<div class="outline-text-4" id="text-unnumbered-35">
<p>
If you are using the <a href="http://www.irssi.org/">irssi</a> IRC client then you can use the following commands to connect to your IRC server.
</p>
@ -1098,9 +1113,9 @@ If you are using the <a href="http://www.irssi.org/">irssi</a> IRC client then y
</div>
</div>
</div>
<div id="outline-container-unnumbered-35" class="outline-4">
<h4 id="unnumbered-35">XChat</h4>
<div class="outline-text-4" id="text-unnumbered-35">
<div id="outline-container-unnumbered-36" class="outline-4">
<h4 id="unnumbered-36">XChat</h4>
<div class="outline-text-4" id="text-unnumbered-36">
<p>
If you are using the XChat client:
</p>
@ -1136,12 +1151,12 @@ Click <b>close</b> and then <b>connect</b>.
</div>
</div>
<div id="outline-container-unnumbered-36" class="outline-3">
<h3 id="unnumbered-36">XMPP/Jabber</h3>
<div class="outline-text-3" id="text-unnumbered-36">
</div><div id="outline-container-unnumbered-37" class="outline-4">
<h4 id="unnumbered-37">Managing users</h4>
<div class="outline-text-4" id="text-unnumbered-37">
<div id="outline-container-unnumbered-37" class="outline-3">
<h3 id="unnumbered-37">XMPP/Jabber</h3>
<div class="outline-text-3" id="text-unnumbered-37">
</div><div id="outline-container-unnumbered-38" class="outline-4">
<h4 id="unnumbered-38">Managing users</h4>
<div class="outline-text-4" id="text-unnumbered-38">
<p>
To add a user:
</p>
@ -1200,9 +1215,9 @@ prosodyctl status
</div>
</div>
<div id="outline-container-unnumbered-38" class="outline-4">
<h4 id="unnumbered-38">Using with Jitsi</h4>
<div class="outline-text-4" id="text-unnumbered-38">
<div id="outline-container-unnumbered-39" class="outline-4">
<h4 id="unnumbered-39">Using with Jitsi</h4>
<div class="outline-text-4" id="text-unnumbered-39">
<p>
Jitsi is the recommended communications client for desktop or laptop systems, since it includes the <i>off the record</i> (OTR) feature which provides some additional security beyond the usual SSL certificates.
</p>
@ -1232,9 +1247,9 @@ You can also <a href="https://www.youtube.com/watch?v=vgx7VSrDGjk">see this vide
</p>
</div>
</div>
<div id="outline-container-unnumbered-39" class="outline-4">
<h4 id="unnumbered-39">Using with Ubuntu</h4>
<div class="outline-text-4" id="text-unnumbered-39">
<div id="outline-container-unnumbered-40" class="outline-4">
<h4 id="unnumbered-40">Using with Ubuntu</h4>
<div class="outline-text-4" id="text-unnumbered-40">
<p>
The default XMPP client in Ubuntu is Empathy. Using Empathy isn't as secure as using Jitsi, since it doesn't include the <i>off the record</i> feature, but since it's the default it's what many users will have easy access to.
</p>
@ -1252,9 +1267,9 @@ Click on <b>Advanced</b> and make sure that <b>Encryption required</b> and <b>Ig
</p>
</div>
</div>
<div id="outline-container-unnumbered-40" class="outline-4">
<h4 id="unnumbered-40">Using with Android</h4>
<div class="outline-text-4" id="text-unnumbered-40">
<div id="outline-container-unnumbered-41" class="outline-4">
<h4 id="unnumbered-41">Using with Android</h4>
<div class="outline-text-4" id="text-unnumbered-41">
<p>
Install <a href="https://f-droid.org/">F-Droid</a>
</p>
@ -1281,12 +1296,12 @@ Go back to the initial screen and then using the menu you can add contacts and b
</div>
</div>
</div>
<div id="outline-container-unnumbered-41" class="outline-3">
<h3 id="unnumbered-41">VoIP (Voice chat)</h3>
<div class="outline-text-3" id="text-unnumbered-41">
</div><div id="outline-container-unnumbered-42" class="outline-4">
<h4 id="unnumbered-42">Using with Ubuntu</h4>
<div class="outline-text-4" id="text-unnumbered-42">
<div id="outline-container-unnumbered-42" class="outline-3">
<h3 id="unnumbered-42">VoIP (Voice chat)</h3>
<div class="outline-text-3" id="text-unnumbered-42">
</div><div id="outline-container-unnumbered-43" class="outline-4">
<h4 id="unnumbered-43">Using with Ubuntu</h4>
<div class="outline-text-4" id="text-unnumbered-43">
<p>
Within the software center search for "mumble" and install the client then run it. Skip through the audio setup wizard.
</p>
@ -1300,9 +1315,9 @@ Click on "add new" to add a new server and enter the default domain name for the
</p>
</div>
</div>
<div id="outline-container-unnumbered-43" class="outline-4">
<h4 id="unnumbered-43">Using with Android</h4>
<div class="outline-text-4" id="text-unnumbered-43">
<div id="outline-container-unnumbered-44" class="outline-4">
<h4 id="unnumbered-44">Using with Android</h4>
<div class="outline-text-4" id="text-unnumbered-44">
<p>
Install <a href="https://f-droid.org/">F-Droid</a>
</p>