fixed links
This commit is contained in:
remotenemesis
parent
4506698224
commit
7a9c7b0b74
54
README.md
54
README.md
|
|
@ -15,46 +15,46 @@ The Lollipop Cloud project is a way to self-host internet services, such as a we
|
|||
- We have generated Armbian builds specifically for the Lollipop's supported boards. You can [download Armbian builds for Lollipops here](https://dl.lollipopcloud.solutions/).
|
||||
- **Note about the Raspberry Pi:** The [Raspberry Pi 3](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 interact with the SBC (monitor/keyboard, serial adapter, or ssh via ethernet).
|
||||
- A wifi adapter, USB cellular modem (3G/4G/WCDMA/LTE), [GPS module](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/hardware/gps.md), [RTC (Real Time Clock)](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/hardware/rtc.md), [Bluetooth Serial Terminal](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/hardware/bluetooth_terminal.md), other hardware you need for your custom setup. See also: [Hardware Considerations](https://git.lollipopcloud.solutions/lollipop-cloud/lollipop-docs/src/branch/master/hardware).
|
||||
- A wifi adapter, USB cellular modem (3G/4G/WCDMA/LTE), [GPS module](hardware/gps.md), [RTC (Real Time Clock)](hardware/rtc.md), [Bluetooth Serial Terminal](hardware/bluetooth_terminal.md), other hardware you need for your custom setup. See also: [Hardware Considerations](hardware/README.md).
|
||||
|
||||
## Initial Setup
|
||||
[Setup For Beginners](https://git.lollipopcloud.solutions/lollipop-cloud/lollipop-docs/src/branch/master/for-beginners): 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.
|
||||
[Setup For Beginners](for-beginners/README.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 Setup](#networking-setup)) when you're ready.
|
||||
|
||||
If you're not using the [link for beginners](https://git.lollipopcloud.solutions/lollipop-cloud/lollipop-docs/src/branch/master/for-beginners), the following links are good first steps:
|
||||
If you're not using the [link for beginners](for-beginners/README.md), the following links are good first steps:
|
||||
- [Download Armbian](https://dl.lollipopcloud.solutions/files/armbian)
|
||||
- [First Boot](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/armbian/first_boot.md)
|
||||
- [Base Setup](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/armbian/base_setup.md)
|
||||
- [First Boot](armbian/first_boot.md)
|
||||
- [Base Setup](armbian/base_setup.md)
|
||||
|
||||
|
||||
## Networking Setup
|
||||
|
||||
- [Network Manager (networking setup tool)](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/armbian/network_manager.md)
|
||||
- [Modem Manager (3G/LTE modems)](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/armbian/modem_manager.md)
|
||||
- [FirewallD (firewall/routing)](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/armbian/firewalld.md)
|
||||
- [Unbound (Non ISP DNS)](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/armbian/unbound.md)
|
||||
- [Network Manager (networking setup tool)](armbian/network_manager.md)
|
||||
- [Modem Manager (3G/LTE modems)](armbian/modem_manager.md)
|
||||
- [FirewallD (firewall/routing)](armbian/firewalld.md)
|
||||
- [Unbound (Non ISP DNS)](armbian/unbound.md)
|
||||
- VPN Options
|
||||
- [Private Internet Access (VPN)](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/armbian/vpn/pia.md)
|
||||
- [vpn.ac (VPN)](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/armbian/vpn/vpn_ac.md)
|
||||
- [VPN Autoconnect](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/armbian/vpn/vpn_autoconnect.md)
|
||||
- [Private Internet Access (VPN)](armbian/vpn/pia.md)
|
||||
- [vpn.ac (VPN)](armbian/vpn/vpn_ac.md)
|
||||
- [VPN Autoconnect](armbian/vpn/vpn_autoconnect.md)
|
||||
|
||||
## Fundamental Tools
|
||||
|
||||
- [Cockpit (recommended)](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/armbian/cockpit.md): simple browser-based management console/UI
|
||||
- [Chrony](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/armbian/chrony.md): clock synchronization
|
||||
- [Borg Backups](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/services/borg.md): simple, effective backups
|
||||
- [Docker](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/armbian/docker.md): containerize your services
|
||||
- [Let's Encrypt](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/services/acme_sh.md): SSL/TLS certificates for secure web communications
|
||||
- [Incron](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/armbian/incron.md): a way to watch the filesystem for configuration changes and restart services
|
||||
- [Caddy](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/services/caddy.md): web server and reverse https proxy
|
||||
- [Pi Hole](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/services/pi_hole.md): ad-blocking that blocks ads before they are loaded, can help conserve bandwidth and data transfer
|
||||
- [Searx](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/services/searx.md): self-hosted meta search engine
|
||||
- [Cockpit (recommended)](armbian/cockpit.md): simple browser-based management console/UI
|
||||
- [Chrony](armbian/chrony.md): clock synchronization
|
||||
- [Borg Backups](services/borg.md): simple, effective backups
|
||||
- [Docker](armbian/docker.md): containerize your services
|
||||
- [Let's Encrypt](services/acme_sh.md): SSL/TLS certificates for secure web communications
|
||||
- [Incron](armbian/incron.md): a way to watch the filesystem for configuration changes and restart services
|
||||
- [Caddy](services/caddy.md): web server and reverse https proxy
|
||||
- [Pi Hole](services/pi_hole.md): ad-blocking that blocks ads before they are loaded, can help conserve bandwidth and data transfer
|
||||
- [Searx](services/searx.md): self-hosted meta search engine
|
||||
|
||||
## Additional Services
|
||||
|
||||
- [Postgresl](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/services/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/docs/src/branch/master/armbian/monitoring.md): basic system monitoring
|
||||
- [NextCloud](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/services/nextcloud.md): file syncing, calendar syncing, contact syncing; an alternative to Dropbox and iCloud
|
||||
- [Syncthing](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/services/syncthing.md): sync for large numbers or large sized files, an alternative to NextCloud
|
||||
- [Postgresl](services/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](armbian/monitoring.md): basic system monitoring
|
||||
- [NextCloud](services/nextcloud.md): file syncing, calendar syncing, contact syncing; an alternative to Dropbox and iCloud
|
||||
- [Syncthing](services/syncthing.md): sync for large numbers or large sized files, an alternative to NextCloud
|
||||
- Gitea (documentation needed): self-hosted git, alternative to GitHub and GitLab
|
||||
- [Wallabag](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/services/wallabag.md): save websites for later, alternative to Read it Later and Pocket
|
||||
- [TT-RSS](https://git.lollipopcloud.solutions/lollipop-cloud/docs/src/branch/master/services/ttrss.md): self-hosted RSS reader, alternative to Google Reader
|
||||
- [Wallabag](services/wallabag.md): save websites for later, alternative to Read it Later and Pocket
|
||||
- [TT-RSS](services/ttrss.md): self-hosted RSS reader, alternative to Google Reader
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ The author *strongly* recommends reading through this and adapting/tuning well a
|
|||
- [https://unix.stackexchange.com/questions/301845/scripting-a-way-to-quickly-import-ovpn-files-to-networkmanager-on-ubuntu](https://unix.stackexchange.com/questions/301845/scripting-a-way-to-quickly-import-ovpn-files-to-networkmanager-on-ubuntu)
|
||||
- [https://www.privateinternetaccess.com/pages/client-support/](https://www.privateinternetaccess.com/pages/client-support/)
|
||||
|
||||
## Pep Work
|
||||
## Prep Work
|
||||
|
||||
Download PIA OpenVPN advanced configs, drop them in a good place on the filesystem and script import.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Contributing
|
||||
We use a modified kanban methodology called SOSASA (Structuring your project for the purposes Of Social Activism and Accessibility) for contributions. You can read about [our adaptation of SOSASA here (link)](sosasa-kanban.md), and creator hoodie aida kitten's complete onboarding article and [detailed SOSASA description here (link)](https://medium.com/@novemberninerniner/the-lifetime-of-an-issue-feature-request-f0ae1210e8c2).
|
||||
|
||||
If you'd like to contribute, welcome!! We are so glad you are here. We hope you will take a moment to read our [code of conduct (link)](code-of-conduct.md) before continuing.
|
||||
If you'd like to contribute, welcome!! We are so glad you are here. We hope you will take a moment to read our [code of conduct (link)](../code-of-conduct.md) before continuing.
|
||||
|
||||
To contribute, please read [our adaptation of SOSASA here (link)](sosasa-kanban.md), which contains more detail about how you can contribute, then join our [kanban boards (link)](https://kanban.lollipopcloud.solutions/) by signing up for an account and logging in.
|
||||
|
||||
|
|
@ -15,7 +15,7 @@ If you already have code or documentation to contribute, our [documentation repo
|
|||
|
||||
Lowering the barrier for contributions is important: we value your input, regardless of your level of experience or area of expertise. If you would rather [contact us directly (link)](https://lollipopcloud.solutions/page/contact/), please do not hesitate to reach out through email or chat. We can also provide assistance walking you through our contribution process if you'd like to learn SOSASA or Gitea.
|
||||
|
||||
Note: by submitting a PR, you agree to your contribution(s) being licensed as described in our [LICENSE.md (link)](LICENSE.md).
|
||||
Note: by submitting a PR, you agree to your contribution(s) being licensed as described in our [LICENSE.md (link)](../LICENSE.md).
|
||||
|
||||
## Documentation
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ This is complex stuff. If you're new to installing operating systems or setting
|
|||
|
||||
If you're looking to set up your own Lollipop device, you'll want to check out the [for-beginners.md](for-beginners.md) page.
|
||||
|
||||
If you're looking to contribute to the project, please check out the [our section regarding contributions](https://git.lollipopcloud.solutions/lollipop-cloud/lollipop-docs/src/branch/master/contributing), and if you're looking for a git/Gitea tutorial, check out the [how-to-gitea.md](how-to-gitea.md) link.
|
||||
If you're looking to contribute to the project, please check out the [our section regarding contributions](../contributing/README.md), and if you're looking for a git/Gitea tutorial, check out the [how-to-gitea.md](how-to-gitea.md) link.
|
||||
|
||||
## If you run into trouble...
|
||||
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ You will also need an SD card formatted with Armbian installed.
|
|||
|
||||
__NOTE:__ Raspberry Pi 3 users will need to use [Raspbian (link)](https://www.raspberrypi.org/downloads/raspbian/) instead of Armbian.
|
||||
|
||||
You will need to [download Armbian (link)](https://dl.lollipopcloud.solutions/files/armbian) for the board you're setting up, and save it to your computer. We highly recommend using an HDMI connection if you've never set up a serial connection before, because additional drivers and software are required to get your development computer to communicate with the Lollipop via serial connection. Your "development computer" will be the laptop or desktop computer you use daily, or have borrowed for this purpose.
|
||||
You will need to [download Armbian (link)](https://dl.lollipopcloud.solutions/armbian/) for the board you're setting up, and save it to your computer. We highly recommend using an HDMI connection if you've never set up a serial connection before, because additional drivers and software are required to get your development computer to communicate with the Lollipop via serial connection. Your "development computer" will be the laptop or desktop computer you use daily, or have borrowed for this purpose.
|
||||
|
||||
__NOTE:__ experienced users might want to use the experimental versions, but the rest of us should stick to the supported and stable builds.
|
||||
|
||||
|
|
@ -105,7 +105,7 @@ Now restart the service with `systemctl restart sshd`.
|
|||
|
||||
# Congratulations! You've installed an entire operating system and completed the base setup! Time to customize your Lollipop!
|
||||
|
||||
Now you're ready to head back to the [README (link)](docs/README.md) and get started on the networking section.
|
||||
Now you're ready to head back to the [README (link)](../README.md) and get started on the networking section.
|
||||
|
||||
**Closing suggestions:**
|
||||
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ This is a great choice if you're looking for something pocket sized and/or minim
|
|||
|
||||
### USB Storage
|
||||
|
||||
If you're going to run services like NextCloud, Syncthing and/or Samba you will want to consider what kind of USB disk to use. I'd recommend a [Sandisk Cruzer Fit (link)](https://www.sandisk.com/home/usb-flash/cruzer-fit) or [Sandisk Ultra Fit (link)](https://www.sandisk.com/home/usb-flash/ultra-fit-usb) or similar, low power flash drive. Full hard disks that aren't SSD's tend to be power hungry and can cause problems with SBCs.
|
||||
If you're going to run services like NextCloud, Syncthing and/or Samba you will want to consider what kind of USB disk to use. I'd recommend a [Sandisk Cruzer Fit (link)](https://www.sandisk.com/home/usb-flash/cruzer-fit) or [Sandisk Ultra Fit (link)](https://www.sandisk.com/home/usb-flash/ultra-fit) or similar, low power flash drive. Full hard disks that aren't SSD's tend to be power hungry and can cause problems with SBCs.
|
||||
|
||||
### WiFi
|
||||
|
||||
|
|
|
|||
Reference in New Issue