From 5ba59b687e6ac138727d2c431fbfde7c0091a360 Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Sun, 28 May 2017 11:36:43 +0100 Subject: [PATCH] cryptpad documentation --- doc/EN/app_cryptpad.org | 38 +++++ doc/EN/app_etherpad.org | 4 +- doc/EN/apps.org | 4 + website/EN/app_cryptpad.html | 318 +++++++++++++++++++++++++++++++++++ website/EN/app_etherpad.html | 27 +-- website/EN/apps.html | 212 ++++++++++++----------- 6 files changed, 491 insertions(+), 112 deletions(-) create mode 100644 doc/EN/app_cryptpad.org create mode 100644 website/EN/app_cryptpad.html diff --git a/doc/EN/app_cryptpad.org b/doc/EN/app_cryptpad.org new file mode 100644 index 00000000..7c5b83f1 --- /dev/null +++ b/doc/EN/app_cryptpad.org @@ -0,0 +1,38 @@ +#+TITLE: +#+AUTHOR: Bob Mottram +#+EMAIL: bob@freedombone.net +#+KEYWORDS: freedombone, cryptpad +#+DESCRIPTION: How to use CryptPad +#+OPTIONS: ^:nil toc:nil +#+HTML_HEAD: + +#+BEGIN_CENTER +[[file:images/logo.png]] +#+END_CENTER + +#+BEGIN_EXPORT html +
+

CryptPad

+
+#+END_EXPORT + +This is similar to [[./app_etherpad.html][EtherPad]] but with better security and more document types which can be collaboratively edited in real time. It includes not just text editing but also creating presentations, voting and editing source code. + +For added security this system is only available via an onion address, so you and your collaborators will need to be using Tor compatible browsers. + +Enabling someone to edit a document is as simple as sending them the URL via a chat system. You can also send a read only URL for a document if you only want the recipient to be able to view but not edit. + +Documents are stored locally within the browser of each user and the server just acts as a coordinator. No documents are stored on the server. + +* 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 *cryptpad*. When that is complete go to *About this system* and look up the onion address. Enter that into a Tor compatible browser. + +One thing to be aware of is that on this system registration and logins are disabled, so that only anonymous or pseudanonymous editing is available. This prevents anyone who discovers the onion address from then disabling your server by creating millions of accounts. diff --git a/doc/EN/app_etherpad.org b/doc/EN/app_etherpad.org index e0da27c8..707473cb 100644 --- a/doc/EN/app_etherpad.org +++ b/doc/EN/app_etherpad.org @@ -16,7 +16,9 @@ #+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. +This is a well known system for real time collaborative editing of documents. 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. + +If security is an especially important factor then you might also want to consider installing [[./app_cryptpad.html][CryptPad]] instead. It has more features and doesn't store any documents on the server. * Installation Log into your system with: diff --git a/doc/EN/apps.org b/doc/EN/apps.org index 50c7b2da..b380609a 100644 --- a/doc/EN/apps.org +++ b/doc/EN/apps.org @@ -24,6 +24,10 @@ The base install of the system just contains an email server and Mutt client, bu [[file:images/controlpanel/control_panel_apps.jpg]] #+END_CENTER +* CryptPad +Collaborate on editing documents, presentations and source code, or vote on things. All with a good level of security. + +[[./app_cryptpad.html][How to use it]] * DLNA Enables you to use the system as a music server which any DLNA compatible devices can connect to within your home network. diff --git a/website/EN/app_cryptpad.html b/website/EN/app_cryptpad.html new file mode 100644 index 00000000..095bbb51 --- /dev/null +++ b/website/EN/app_cryptpad.html @@ -0,0 +1,318 @@ + + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+

logo.png +

+
+
+ +
+

CryptPad

+
+ +

+This is similar to EtherPad but with better security and more document types which can be collaboratively edited in real time. It includes not just text editing but also creating presentations, voting and editing source code. +

+ +

+For added security this system is only available via an onion address, so you and your collaborators will need to be using Tor compatible browsers. +

+ +

+Enabling someone to edit a document is as simple as sending them the URL via a chat system. You can also send a read only URL for a document if you only want the recipient to be able to view but not edit. +

+ +

+Documents are stored locally within the browser of each user and the server just acts as a coordinator. No documents are stored on the server. +

+ +
+

Installation

+
+

+Log into your system with: +

+ +
+
ssh myusername@mydomain -p 2222
+
+
+ +

+Using cursor keys, space bar and Enter key select Administrator controls and type in your password. +

+ +

+Select Add/Remove Apps then cryptpad. When that is complete go to About this system and look up the onion address. Enter that into a Tor compatible browser. +

+ +

+One thing to be aware of is that on this system registration and logins are disabled, so that only anonymous or pseudanonymous editing is available. This prevents anyone who discovers the onion address from then disabling your server by creating millions of accounts. +

+
+
+
+
+ + + +
+Back to top | E-mail me +
+
+ + diff --git a/website/EN/app_etherpad.html b/website/EN/app_etherpad.html index 390e93f0..57088115 100644 --- a/website/EN/app_etherpad.html +++ b/website/EN/app_etherpad.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + @@ -71,6 +71,7 @@ pre.src-fortran:before { content: 'Fortran'; } pre.src-gnuplot:before { content: 'gnuplot'; } pre.src-haskell:before { content: 'Haskell'; } + pre.src-hledger:before { content: 'hledger'; } pre.src-java:before { content: 'Java'; } pre.src-js:before { content: 'Javascript'; } pre.src-latex:before { content: 'LaTeX'; } @@ -188,7 +189,7 @@ @licstart The following is the entire license notice for the JavaScript code in this tag. -Copyright (C) 2012-2013 Free Software Foundation, Inc. +Copyright (C) 2012-2017 Free Software Foundation, Inc. The JavaScript code in this tag is free software: you can redistribute it and/or modify it under the terms of the GNU @@ -248,19 +249,23 @@ for the JavaScript code in this tag.

-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. +This is a well known system for real time collaborative editing of documents. 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

-
+

+If security is an especially important factor then you might also want to consider installing CryptPad instead. It has more features and doesn't store any documents on the server. +

+ +
+

Installation

+

Log into your system with:

-
ssh myusername@mydomain -p 2222
-
+
ssh myusername@mydomain -p 2222
+

@@ -277,9 +282,9 @@ After the install has completed go to Security settings and select Cre

-
-

Initial setup

-
+
+

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.

diff --git a/website/EN/apps.html b/website/EN/apps.html index 4e4aa9ea..eb35abbf 100644 --- a/website/EN/apps.html +++ b/website/EN/apps.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + @@ -264,9 +264,21 @@ The base install of the system just contains an email server and Mutt client, bu
-
-

DLNA

-
+
+

CryptPad

+
+

+Collaborate on editing documents, presentations and source code, or vote on things. All with a good level of security. +

+ +

+How to use it +

+
+
+
+

DLNA

+

Enables you to use the system as a music server which any DLNA compatible devices can connect to within your home network.

@@ -276,9 +288,9 @@ Enables you to use the system as a music server which any DLNA compatible device

-
-

Dokuwiki

-
+
+

Dokuwiki

+

A databaseless wiki system.

@@ -288,9 +300,9 @@ A databaseless wiki system.

-
-

Emacs

-
+
+

Emacs

+

If you use the Mutt client to read your email then this will set it up to use emacs for composing new mail.

@@ -300,9 +312,9 @@ If you use the Mutt client to read your email then this will set it up to use em

-
-

Etherpad

-
+
+

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.

@@ -312,9 +324,9 @@ Collaborate on creating documents in real time. Maybe you're planning a holiday

-
-

Friendica

-
+
+

Friendica

+

Federated social network system.

@@ -324,9 +336,9 @@ Federated social network system.

-
-

Ghost

-
+
+

Ghost

+

Modern looking blogging system.

@@ -336,9 +348,9 @@ Modern looking blogging system.

-
-

GNU Social

-
+
+

GNU Social

+

Federated social network. You can "remote follow" other users within the GNU Social federation.

@@ -348,9 +360,9 @@ Federated social network. You can "remote follow" other users within the

-
-

Gogs

-
+
+

Gogs

+

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.

@@ -360,9 +372,9 @@ Lightweight git project hosting system. You can mirror projects from Github, or

-
-

HTMLy

-
+
+

HTMLy

+

Databaseless blogging system. Quite simple and with a markdown-like format.

@@ -372,9 +384,9 @@ Databaseless blogging system. Quite simple and with a markdown-like format.

-
-

Hubzilla

-
+
+

Hubzilla

+

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.

@@ -384,9 +396,9 @@ Web publishing platform with social network like features and good privacy contr

-
-

IRC Server (ngirc)

-
+
+

IRC Server (ngirc)

+

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.

@@ -396,18 +408,18 @@ Run your own IRC chat channel which can be secured with a password and accessibl

-
-

Jitsi Meet

-
+
+

Jitsi Meet

+

Experimental WebRTC video conferencing system, similar to Google Hangouts. This may not be fully functional, but is hoped to be in the near future.

-
-

Koel

-
+
+

Koel

+

Access your music collection from any internet connected device.

@@ -417,9 +429,9 @@ Access your music collection from any internet connected device.

-
-

Lychee

-
+
+

Lychee

+

Make your photo albums available on the web.

@@ -429,9 +441,9 @@ Make your photo albums available on the web.

-
-

Mailpile

-
+
+

Mailpile

+

Modern email client which supports GPG encryption.

@@ -441,9 +453,9 @@ Modern email client which supports GPG encryption.

-
-

Matrix

-
+
+

Matrix

+

Multi-user chat with some security and moderation controls.

@@ -453,9 +465,9 @@ Multi-user chat with some security and moderation controls.

-
-

Mediagoblin

-
+
+

Mediagoblin

+

Publicly host video and audio files so that you don't need to use YouTube/Vimeo/etc.

@@ -465,9 +477,9 @@ Publicly host video and audio files so that you don't need to use YouTube/Vimeo/

-
-

Mumble

-
+
+

Mumble

+

The popular VoIP and text chat system. Say goodbye to old-fashioned telephony conferences with silly dial codes. Also works well on mobile.

@@ -477,9 +489,9 @@ The popular VoIP and text chat system. Say goodbye to old-fashioned telephony co

-
-

NextCloud

-
+
+

NextCloud

+

Store files on your server and sync them with laptops or mobile devices. Includes many plugins including videoconferencing and collaborative document editing.

@@ -489,9 +501,9 @@ Store files on your server and sync them with laptops or mobile devices. Include

-
-

PI-Hole

-
+
+

PI-Hole

+

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.

@@ -501,9 +513,9 @@ The black hole for web adverts. Block adverts at the domain name level within yo

-
-

PostActiv

-
+
+

PostActiv

+

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.

@@ -513,9 +525,9 @@ An alternative federated social networking system compatible with GNU Social. It

-
-

Profanity

-
+
+

Profanity

+

A shell based XMPP client which you can run on the Freedombone server via ssh.

@@ -525,9 +537,9 @@ A shell based XMPP client which you can run on the Freedombone server via ssh.

-
-

Radicale

-
+
+

Radicale

+

Calendar system compatible with CalDAV and CardDAV. Synch your calendar events easily and securely across all your devices.

@@ -537,9 +549,9 @@ Calendar system compatible with CalDAV and CardDAV. Synch your calendar events e

-
-

Riot Web

-
+
+

Riot Web

+

A browser based user interface for the Matrix federated communications system, including WebRTC audio and video chat.

@@ -549,9 +561,9 @@ A browser based user interface for the Matrix federated communications system, i

-
-

Scuttlebot

-
+
+

Scuttlebot

+

A pub service to help synchronize your messages.

@@ -562,9 +574,9 @@ A pub service to help synchronize your messages.

-
-

SearX

-
+
+

SearX

+

A metasearch engine for customised and private web searches.

@@ -574,9 +586,9 @@ A metasearch engine for customised and private web searches.

-
-

tt-rss

-
+
+

tt-rss

+

Private RSS reader. Pulls in RSS/Atom feeds via Tor and is only accessible via an onion address. Have "the right to read" 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.

@@ -586,9 +598,9 @@ Private RSS reader. Pulls in RSS/Atom feeds via Tor and is only accessible via a

-
-

Syncthing

-
+
+

Syncthing

+

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.

@@ -598,9 +610,9 @@ Possibly the best way to synchronise files across all of your devices. Once it h

-
-

Tahoe-LAFS

-
+
+

Tahoe-LAFS

+

Robust and encrypted storage of files on one or more server.

@@ -610,9 +622,9 @@ Robust and encrypted storage of files on one or more server.

-
-

Tox

-
+
+

Tox

+

Client and bootstrap node for the Tox chat/VoIP system.

@@ -622,9 +634,9 @@ Client and bootstrap node for the Tox chat/VoIP system.

-
-

Turtl

-
+
+

Turtl

+

A system for privately creating and sharing notes and images, similar to Evernote but without the spying.

@@ -634,18 +646,18 @@ A system for privately creating and sharing notes and images, similar to Evernot

-
-

Vim

-
+
+

Vim

+

If you use the Mutt client to read your email then this will set it up to use vim for composing new mail.

-
-

XMPP

-
+
+

XMPP

+

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 client state notification to save battery power on your mobile devices, support for seamless roaming between networks and message carbons so that you can receive the same messages while being simultaneously logged in to your account on more than one device.