From 8f58f6b4c42837874cd543c087b6da449967a2ce Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Mon, 14 Nov 2016 21:31:29 +0000 Subject: [PATCH] Notes on lychee --- doc/EN/app_lychee.org | 55 ++++++ doc/EN/apps.org | 1 + doc/EN/usage.org | 1 + website/EN/app_lychee.html | 348 +++++++++++++++++++++++++++++++++++++ website/EN/apps.html | 141 +++++++-------- website/EN/usage.html | 38 ++-- 6 files changed, 498 insertions(+), 86 deletions(-) create mode 100644 doc/EN/app_lychee.org create mode 100644 website/EN/app_lychee.html diff --git a/doc/EN/app_lychee.org b/doc/EN/app_lychee.org new file mode 100644 index 00000000..ef12ddea --- /dev/null +++ b/doc/EN/app_lychee.org @@ -0,0 +1,55 @@ +#+TITLE: +#+AUTHOR: Bob Mottram +#+EMAIL: bob@freedombone.net +#+KEYWORDS: freedombone, lychee +#+DESCRIPTION: How to use Lychee +#+OPTIONS: ^:nil toc:nil +#+HTML_HEAD: + +#+BEGIN_CENTER +[[file:images/logo.png]] +#+END_CENTER + +#+BEGIN_EXPORT html +
+

Lychee

+
+#+END_EXPORT + +Lychee is a simple and lightweight photo album for the web. Whether you're an amateur or professionalal photographer, or want to publish random holiday pics or cat pictures. Lychee just does what it says it does without any fuss. There is also a photo album feature within Hubzilla if you need more sophisticated social photo sharing with individualised permissions. + +* 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 *lychee*. 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 /code.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 Lychee. 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 Lychee 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 + +In a browser navigate to your Lychee site and click the *Register* button. The first user registered on the system becomes the administrator. Once you've done that then it's a good idea to disable further registrations. Currently that's a little complicated, but you can do it as follows: + +#+begin_src bash :tangle no +sudo username@domainname -p 2222 +#+end_src + +Within a browser navigate to your lychee domain name or onion address, enter settings for the database as follows, using the MariaDB password which appears within the README file in your home directory. + +#+BEGIN_CENTER +[[file:images/lychee_setup.jpg]] +#+END_CENTER + +After that create a username and password and store them in your favourite password manager. And you're done. Add photos and albums as you wish. diff --git a/doc/EN/apps.org b/doc/EN/apps.org index 19404a23..fc0b0bad 100644 --- a/doc/EN/apps.org +++ b/doc/EN/apps.org @@ -66,6 +66,7 @@ Experimental WebRTC video conferencing system, similar to Google Hangouts. This * Lychee Make your photo albums available on the web. +[[./app_lychee.html][How to use it]] * Mailpile Modern email client which supports GPG encryption. diff --git a/doc/EN/usage.org b/doc/EN/usage.org index 4fb5a8cd..ef1c5b3d 100644 --- a/doc/EN/usage.org +++ b/doc/EN/usage.org @@ -27,6 +27,7 @@ | [[./app_ghost.html][Blogging with Ghost]] | | [[./app_htmly.html][Blogging with HTMLy]] | | [[./app_hubzilla.html][Social Network]] | +| [[./app_lychee.html][Photo albums]] | | [[./app_dokuwiki.html][Wiki]] | | [[./app_etherpad.html][Collaborative document editing]] | | [[./app_irc.html][Multi-user chat with IRC]] | diff --git a/website/EN/app_lychee.html b/website/EN/app_lychee.html new file mode 100644 index 00000000..f279331d --- /dev/null +++ b/website/EN/app_lychee.html @@ -0,0 +1,348 @@ + + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+

logo.png +

+
+
+ +
+

Lychee

+
+ +

+Lychee is a simple and lightweight photo album for the web. Whether you're an amateur or professionalal photographer, or want to publish random holiday pics or cat pictures. Lychee just does what it says it does without any fuss. There is also a photo album feature within Hubzilla if you need more sophisticated social photo sharing with individualised permissions. +

+ +
+

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 lychee. 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. Typically the domain name you use will be a subdomain, such as code.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 Lychee. 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 Lychee 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: +

+ +
+
editor README
+
+
+ +

+In a browser navigate to your Lychee site and click the Register button. The first user registered on the system becomes the administrator. Once you've done that then it's a good idea to disable further registrations. Currently that's a little complicated, but you can do it as follows: +

+ +
+
sudo username@domainname -p 2222
+
+
+ +

+Within a browser navigate to your lychee domain name or onion address, enter settings for the database as follows, using the MariaDB password which appears within the README file in your home directory. +

+ +
+ +
+

lychee_setup.jpg +

+
+
+ +

+After that create a username and password and store them in your favourite password manager. And you're done. Add photos and albums as you wish. +

+
+
+
+
+ + + +
+Back to top | E-mail me +
+
+ + diff --git a/website/EN/apps.html b/website/EN/apps.html index 57f1f53c..72f12523 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"> - + @@ -257,9 +257,9 @@ The base install of the system just contains an email server and Mutt client, bu -
-

DLNA

-
+
+

DLNA

+

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

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

-
-

Dokuwiki

-
+
+

Dokuwiki

+

A databaseless wiki system.

@@ -281,9 +281,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.

@@ -293,9 +293,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.

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

-
-

Ghost

-
+
+

Ghost

+

Modern looking blogging system.

@@ -317,9 +317,9 @@ Modern looking blogging system.

-
-

GNU Social

-
+
+

GNU Social

+

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

@@ -329,9 +329,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.

@@ -341,9 +341,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.

@@ -353,9 +353,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.

@@ -365,9 +365,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.

@@ -377,27 +377,30 @@ 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.

-
-

Lychee

-
+
+

Lychee

+

Make your photo albums available on the web.

-
-
-
-

Mailpile

-
+

+How to use it +

+
+
+
+

Mailpile

+

Modern email client which supports GPG encryption.

@@ -407,9 +410,9 @@ Modern email client which supports GPG encryption.

-
-

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.

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

-
-

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.

@@ -431,27 +434,27 @@ 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.

-
-

Radicale

-
+
+

Radicale

+

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

-
-

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.

@@ -461,9 +464,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.

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

-
-

Tox

-
+
+

Tox

+

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

@@ -485,18 +488,18 @@ Client and bootstrap node for the Tox chat/VoIP system.

-
-

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.

diff --git a/website/EN/usage.html b/website/EN/usage.html index 0e400821..fca0694e 100644 --- a/website/EN/usage.html +++ b/website/EN/usage.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + @@ -255,15 +255,15 @@ for the JavaScript code in this tag. -Readme +Readme -Improving ssh security +Improving ssh security -Administrating the system via an onion address (Tor) +Administrating the system via an onion address (Tor) @@ -298,6 +298,10 @@ for the JavaScript code in this tag. Social Network + +Photo albums + + Wiki @@ -335,7 +339,7 @@ for the JavaScript code in this tag. -Adding or removing users +Adding or removing users @@ -344,9 +348,9 @@ for the JavaScript code in this tag. -
-

Readme

-
+
+

Readme

+

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:

@@ -366,9 +370,9 @@ To exit you can either just close the terminal or use CTRL-x CTRL-c follo

-
-

Improving ssh security

-
+
+

Improving ssh security

+

To improve ssh security you can generate an ssh key pair on your system and then upload the public key to the Freedombone.

@@ -418,9 +422,9 @@ If you wish to only use ssh keys then log in to the Freedombone, become the root
-
-

Administrating the system via an onion address (Tor)

-
+
+

Administrating the system via an onion address (Tor)

+

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:

@@ -462,9 +466,9 @@ Subsequently even if dynamic DNS isn't working you may still be able to administ

-
-

Adding or removing users

-
+
+

Adding or removing users

+

Log into the system with: