removed unused features; clarified introduction, verbiage, and hardware
This commit is contained in:
Jennifer
parent
0aee005a38
commit
23bf13535d
40
README.md
40
README.md
|
|
@ -1,18 +1,19 @@
|
|||
# The Lollipop Cloud Project
|
||||
|
||||
The Lollipop Cloud project is an attempt to make hosting personal internet services such as a website, contact list, remote file storage, or a calendar more accessible to users through open source technology and [ARM boards (link)](https://en.wikipedia.org/wiki/ARM_architecture). It allows for anyone with an ARM computer to host their own services.
|
||||
The Lollipop Cloud project is a way to self-host internet services, such as a website, contact list, file storage, or a calendar, through open-source technology and [ARM boards (link)](https://en.wikipedia.org/wiki/ARM_architecture). It allows for anyone with an ARM computer to host their own services.
|
||||
|
||||
(The above blurb came from [our website (link)](https://lollipopcloud.solutions/), in case you're just joining us.)
|
||||
|
||||
## Recommended Hardware
|
||||
* a single-board computer (SBC) like [Pine64](https://www.pine64.org/) or [Orange Pi (link)](http://www.orangepi.org/) with [Armbian](https://www.armbian.com/) installed.
|
||||
* a means to work with the SBC (monitor/keyboard, serial adapter, ssh via ethernet)
|
||||
* wifi adapter, cell modem, [GPS](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/hardware/gps.md), [RTC (Real Time Clock)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/hardware/rtc.md), [Bluetooth Serial Terminal](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/hardware/bluetooth_terminal.md), other hardware you need for your custom setup. see also: [Hardware Considerations (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/hardware_notes.md)
|
||||
* A [single-board computer (SBC) (link)](https://en.wikipedia.org/wiki/Single-board_computer) like the [Pine64 (link)](https://www.pine64.org/) or [Orange Pi (link)](http://www.orangepi.org/) with [Armbian](https://www.armbian.com/) installed. Any SBC with 512MB RAM or better, and an ARM64 chip should be sufficient.
|
||||
* **Note about the Raspberry Pi:** The [Raspberry Pi 3 (link)](https://www.raspberrypi.org/documentation/hardware/raspberrypi/README.md) with the BCM2837 processor, at least 512MB RAM, and Raspbian may work well as a Lollipop; however, we have not tested this configuration at this time.
|
||||
* A means to work with the SBC (monitor/keyboard, serial adapter, ssh via ethernet).
|
||||
* A wifi adapter, USB cellular modem (3G/4G/WCDMA/LTE), [GPS module (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/hardware/gps.md), [RTC (Real Time Clock) (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/hardware/rtc.md), [Bluetooth Serial Terminal (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/hardware/bluetooth_terminal.md), other hardware you need for your custom setup. See also: [Hardware Considerations (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/hardware_notes.md).
|
||||
|
||||
## Initial Setup
|
||||
[Setup For Beginners!! (link)](for-beginners.md): If you are new to installing Linux, or would like a little extra help walking through the initial creation of your Lollipop, please take a look our document written especially for beginners. Come back here and skip down to the next section ([Networking](#Networking)) when you're ready.
|
||||
[Setup For Beginners (link)](for-beginners.md): If you are new to installing Linux, or would like a little extra help walking through the initial creation of your Lollipop, please take a look our documentation written especially for beginners. Then skip down to the next section ([Networking](#Networking)) when you're ready.
|
||||
|
||||
If you're not using the [link for beginners](for-beginners.md), you can start here:
|
||||
If you're not using the [link for beginners](for-beginners.md), the following links are good first steps:
|
||||
* [First Boot (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/first_boot.md)
|
||||
* [Base Setup (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/base_setup.md)
|
||||
|
||||
|
|
@ -30,25 +31,22 @@ If you're not using the [link for beginners](for-beginners.md), you can start he
|
|||
|
||||
## Fundamental Tools
|
||||
|
||||
- [Cockpit (recommended!) (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/cockpit.md): simple browser-based management console/UI
|
||||
- [Cockpit (recommended) (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/cockpit.md): simple browser-based management console/UI
|
||||
- [Chrony (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/chrony.md): clock synchronization
|
||||
- [Borg Backups (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/borg.md): simple, effective, efficient backups
|
||||
- [Borg Backups (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/borg.md): simple, effective backups
|
||||
- [Docker (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/docker.md): containerize your services
|
||||
- [Let's Encrypt (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/lets_encrypt.md): SSL/TLS certificates
|
||||
- [Incron (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/incron.md): inotify-based cron, useful for automatic service reloads
|
||||
- [Caddy (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/caddy.md): web server/proxy
|
||||
- [Pi Hole (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/pi_hole.md): ad-blocking to save bandwidth and data
|
||||
- [Searx (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/searx.md): self-hosted search engine
|
||||
- [Let's Encrypt (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/lets_encrypt.md): SSL/TLS certificates for secure web communications
|
||||
- [Incron (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/incron.md): a way to watch the filesystem for configuration changes and restart services
|
||||
- [Caddy (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/caddy.md): web server and reverse https proxy
|
||||
- [Pi Hole (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/pi_hole.md): ad-blocking that blocks ads before they are loaded, can help conserve bandwidth and data transfer
|
||||
- [Searx (link)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/searx.md): self-hosted meta search engine
|
||||
|
||||
## Additional Services
|
||||
|
||||
- [Postgresl](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/postgres.md): database management, required for NextCloud, Gogs, Wallabag, TT-RSS, and Turtl, if desired, and possibly additional services
|
||||
- [Monitoring](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/monitoring.md): basic monitoring with munin
|
||||
- [ElasticBeats (incomplete)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/elasticbeats.md): Logs/Monitoring
|
||||
- [NextCloud](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/nextcloud.md): file syncing, alternative to Dropbox
|
||||
- [Postgresl](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/postgres.md): database server, required for NextCloud, Gitea, Wallabag, and TT-RSS, and other services; helpful if you will be a heavy user of your Lollipop Cloud
|
||||
- [Monitoring](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/monitoring.md): basic system monitoring
|
||||
- [NextCloud](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/nextcloud.md): file syncing, calendar syncing, contact syncing; an alternative to Dropbox and iCloud
|
||||
- [Syncthing](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/syncthing.md): sync for large numbers or large sized files, an alternative to NextCloud
|
||||
- [Gogs](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/gogs.md): self-hosted git, alternative to GitHub
|
||||
- [Gitea (incomplete)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/gitea.md): self-hosted git
|
||||
- [Wallabag](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/wallabag.md): save websites for later, alternative to Read it Later or Pocket
|
||||
- [Gitea (incomplete)](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/gitea.md): self-hosted git, alternative to GitHub and GitLab
|
||||
- [Wallabag](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/wallabag.md): save websites for later, alternative to Read it Later and Pocket
|
||||
- [TT-RSS](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/ttrss.md): self-hosted RSS reader, alternative to Google Reader
|
||||
- [Turtl](https://git.lollipopcloud.solutions/lollipop-cloud/lolipop_lan_cloud/src/branch/master/docs/armbian/turtl.md): self-hosted notes synchronization, alternative to Evernote or OneNote
|
||||
|
|
|
|||
Reference in New Issue