Private Home Cloud using RaspberryPI

Create your own Private home cloud on a Raspberry Pi.

    

⚡️ Quick start

piCloud currently uses

• A version of https://filebrowser.org/; with some changes to make it work on Raspberrypi
• Sendgrid APIs to send emails
• https://ngrok.com/ to generate a dynamic public URL, so that you can access the Raspberry PI cloud from anywhere
• 🐳   Docker to keep the service up and running

As a first step you need to have a Raspberry Pi with an Operating System

Install Docker on your RaspberryPi.

Installing Docker

# update your apt repos
sudo apt-get update && sudo apt-get upgrade

# download a cool script to install docker for you
curl -fsSL https://get.docker.com -o get-docker.sh

# run the script and follow instructions
sudo sh get-docker.sh

# Add use Pi to docker user group
sudo usermod -aG docker pi

# make sure latest version of docker is installed
docker version

SendGrid API Access

In order to make your Home Cloud on Raspberry Always accessible, when the service starts, it registers to https://ngrok.com/ for a SSH Tunnel. The public URLs generated by https://ngrok.com/ are dynamic in its free version. So we use Sendgrid APIs to send you/admin of the Cloud an email with the currently active public URL. In case you intend to use a Paid version of https://ngrok.com/, this step is optional.

Note - You could use your gmail/public email to begin with

Setup ngrok

Your RaspberryPi can not be accessed publicly unless you have a static IP address. Dont worry, ngrok is here for rescue. Create a free account with ngrok - https://dashboard.ngrok.com/get-started/setup. Copy the auth token and keep it, we need it in next steps.

⚙️ Installation

If you followed steps in Quick Start, you are just one command away from installing your own Private cloud on Raspberry PI

docker run -d --env NGROK_AUTHTOKEN={ngrok_Authtoken} --env SG_APIKEY={sg_key} --env ADMIN_EMAIL={admin/sg verified email} samairtimer/homecloud:v0.3

Support Me