From f649adad95f6e317503ad6dc68bc032f98334a1d Mon Sep 17 00:00:00 2001 From: glen Date: Sat, 8 May 2021 20:26:26 -0400 Subject: [PATCH] add base files --- README.md | 118 ++++++++++++++++++++++++- installers/common.sh | 180 +++++++++++++++++++++++++++++++++++++++ installers/snappsetup.sh | 20 +++++ 3 files changed, 317 insertions(+), 1 deletion(-) create mode 100644 installers/common.sh create mode 100644 installers/snappsetup.sh diff --git a/README.md b/README.md index 48cdce8..d8b18cd 100644 --- a/README.md +++ b/README.md @@ -1 +1,117 @@ -placeholder +SNApp Setup Tool + +![](https://i.imgur.com/o1fLzMl.png) + +# `Daedalus SNAppCrafter` [![Release 1.1](https://img.shields.io/badge/Release-1.1-green.svg)](https://github.com/necro-nemesis/raspap-webgui/releases) + +Daedalus SNAppCrafter is an easy to use Lokinet webserver set up tool to rapidly configure a hidden service (SNApp) on a Linux based system which support .deb packages. The installer can configure a hosted webserver for Lokinet using Nginx or can be used to create one on a local machine running Debian, Raspberry OS or Armbian. This allows anyone to host their own privacy website using Lokinet network. After installing a fresh image, running the script and following the installers instructions the device is ready to launch your website providing you with your individual Loki address. + +![](https://i.imgur.com/IVkovK4.png) + +![](https://i.imgur.com/xnKPFd3.png) + +![](https://i.imgur.com/KDYFjEu.png) + +## Contents + + - [Prerequisites](#prerequisites) + - [Preparing the image](#preparing-the-image) + - [SBC (single board computer) Instructions](#sbc-single-board-computer-instructions) + - [Accessing the device](#accessing-the-device) + - [Quick installer](#quick-installer) + - [Creating your unique SNApp](#creating-your-unique-snapp) + - [Starting and Stopping the Webserver](#starting-and-stopping-the-webserver) + - [Support us](#support-us) + - [How to contribute](#how-to-contribute) + - [License](#license) + +## Prerequisites + +Start with a fresh install of Debian on your system or server. Daedalus will install Nginx as a dependency to run the webserver. If you have already have Apache installed it will need it's service stopped or the Apache package removed. Be sure to back up any directories that may hold any previous websites before running the script as it will overwrite any previous files held in tradtional Linux served directories. It is possible to run SNApps using Apache but for simplicy of automating the install Nginx was chosen to be installed by Daedalus and used to host SNApps. + +### SBC (single board computer) Instructions + +Start with a clean install of [Armbian](https://www.armbian.com/) or [Raspbian](https://www.raspberrypi.org/downloads/raspbian/) (currently Buster and Stretch are verified as working). Lite versions are recommended. If using Raspbian Buster elevate to root with ```sudo su``` before running the Daedalus-SNAppCrafter installer script. For Armbian you will start already elevated to root on login so ```sudo su``` is not required. + +For Orange Pi R1 use Armbian Buster found here: https://www.armbian.com/orange-pi-r1/. Recommend using "minimal" which is available for direct download at the bottom of the page or much faster download by .torrent also linked there. + +For OrangePi Zero use Armbian Buster found here": https://www.armbian.com/orange-pi-zero/ + +To burn the image to an SD card on your PC you can use Etcher: +https://www.balena.io/etcher/ + +### Preparing the image + +For Raspbian you will need to remove the SD card from the computer, reinsert it, open the boot directory up and create a new textfile file named `ssh` with no .txt file extension i.e. just `ssh` in order to remotely connect. This step is not required for Armbian. + +Insert the SD card into the device and power it up. + +### Accessing the device + +Obtain a copy of Putty and install it on your PC: +https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html + +1. Log into your router from your PC and find the address it assigned to the Pi. + +2. Start Putty up and enter this obtained address into Putty with settings: + + Host Name Address = the address obtained from router | Port `22` | connection type `SSH` | then `OPEN` + + For Raspbian the default login is `pi` password `raspberry` + For Armbian the default login is `root` password `1234` + +3. Follow any first user password instructions provided once logged in. + +4. If you want to get the lastest updates before installing Daedalus-SNAppCrafter: +``` +sudo apt-get update +sudo apt-get upgrade +sudo reboot +``` +With the prerequisites done, you can now proceed with the Quick installer. + +## Quick installer + +Install Daedalus-SNAppCrafter from shell prompt: +```sh +$ wget -q https://git.io/JepoL -O /tmp/snapp && bash /tmp/snapp +``` +The installer will update, locate, install and configure all the prerequisites for you. You will be prompted to create a new user account. In future this account and it's associate SNApp directory is used to hold your SNApp files that nginx serves. Enter a username and password, the script will automatically create and elevate privileges of this user account to root while generating the SNApp folder at /home/$USER/snapp. + +At the end of the install process you will be presented with your Lokinet address. Either by starting the test server by answer "Y" or exiting the script "N" it will allow you to highlight the address and copy/paste this to clipboard or plug it directly into your browser to test your server. Remember to have Lokinet running on the computer you are using to test the site. Lokinet privately and anonymously only communicates with Lokinet. + +## Creating your unique SNApp + +SNApps are placed in the /home/$USER/snapp directory "$USER" being substituted by the name of the user you created. The index.html file is there for initial testing. Either move it to another name or remove it and replace it with your own files. If you are using an SBC to host and have a computer that can read the SD card partitions you can simply copy over your SNApp files to the folder on the sd card otherwise sftp into the server and transfer the files you require. As shown in the image above you can use a program like FileZilla to sftp in then navigate to the directory of the SNApp on your pc and the aforementioned SNApp directory on the server then transfer the files to the server. + +## Starting and Stopping the Webserver + +Nginx installs as a service. If you need to restart the service to host different content then you will need to restart nginx's service this can be done by using the following cli entry. + +```sudo systemctl restart nginx``` + +ensure when testing for changes you clear the browser cache to freshly reload the site. + +## Support us + +Daedalus-SNAppCrafter is free software, but powered by your support. If you find it beneficial or wish to contribute to inspire ongoing development your donations of any amount; be they even symbolic, are a show of approval and are greatly appreciated. + +Oxen Donation Address: +```sh +LA8VDcoJgiv2bSiVqyaT6hJ67LXbnQGpf9Uk3zh9ikUKPJUWeYbgsd9gxQ5ptM2hQNSsCaRETQ3GM9FLDe7BGqcm4ve69bh +``` +![](https://i.imgur.com/HGVuijh.jpg) ![](https://i.imgur.com/6dMgBVr.jpg) ![](https://i.imgur.com/gIhGB1X.jpg) + +## How to contribute + +1. File an issue in the repository, using the bug tracker, describing the + contribution you'd like to make. This will help us to get you started on the + right foot. +2. Fork the project in your account and create a new branch: + `your-great-feature`. +3. Commit your changes in that branch. +4. Open a pull request, and reference the initial issue in the pull request + message. + +## License +See the [LICENSE](./LICENSE) file. diff --git a/installers/common.sh b/installers/common.sh new file mode 100644 index 0000000..e3b9820 --- /dev/null +++ b/installers/common.sh @@ -0,0 +1,180 @@ + + +#create hostname account with root privelages. +function create_user () { + +install_log "Create a SNApp host user account" + +if [ $(id -u) -eq 0 ]; then + read -p "Enter username : " username + read -s -p "Enter password : " password + egrep "^$username" /etc/passwd >/dev/null + if [ $? -eq 0 ]; then + echo "$username exists!" + exit 1 + else + pass=$(perl -e 'print crypt($ARGV[0], "password")' $password) + useradd -m -p $pass $username + sudo adduser $username sudo + [ $? -eq 0 ] && echo "User has been added to system!" || echo "Failed to add a user!" + fi +else + echo "Only root may add a user to the system" + exit 2 +fi + +} + +# Outputs a Deadalus Install log line +function install_log() { + echo -e "\033[1;32mSNApp Install: $*\033[m" +} + +# Outputs a Deadalus Install Error log line and exits with status code 1 +function install_error() { + echo -e "\033[1;37;41mSNApp Install Error: $*\033[m" + exit 1 +} + +# Outputs a Deadalus Warning line +function install_warning() { + echo -e "\033[1;33mAdvisory: $*\033[m" +} + +# Outputs a welcome message +function display_welcome() { + raspberry='\033[0;35m' + green='\033[1;32m' + cyan='\033[1;36m' + + echo -e "${cyan}\n" + echo -e " ____ _ _ " + echo -e " | _ \ __ _ ___ __| | __ _| |_ _ ___ " + echo -e " | | | |/ _ |/ _ \/ _ |/ _ | | | | / __| " + echo -e " | |_| | (_| | __/ (_| | (_| | | |_| \__ \ " + echo -e " |____/ \__,_|\___|\__,_|\__,_|_|\__,_|___/ " + echo -e "${raspberry} ____ _ _ _ ____ __ _ " + echo -e " / ___|| \ | | / \ _ __ _ __ / ___|_ __ __ _ / _| |_ ___ _ __ " + echo -e " \___ \| \| | / _ \ | _ \| _ \| | | __/ _ | |_| __/ _ \ __| " + echo -e " ___) | |\ |/ ___ \| |_) | |_) | |___| | | (_| | _| || __/ | " + echo -e " |____/|_| \_/_/ \_\ .__/| .__/ \____|_| \__,_|_| \__\___|_| " + echo -e " |_| |_| TM " + echo -e "${cyan}by Minotaurware.net " + echo -e "${green}\n" + echo -e "SNApp setup tool for Linux based operating systems." + echo -e "The Quick Installer will guide you through a few easy steps\n\n" +} + +### NOTE: all the below functions are overloadable for system-specific installs +### NOTE: some of the below functions MUST be overloaded due to system-specific installs +# Runs a system software update to make sure we're using all fresh packages + +function update_system_packages() { + # OVERLOAD THIS + install_error "No function definition for update_system_packages" +} + +# Installs additional dependencies using system package manager +function install_dependencies() { + # OVERLOAD THIS + install_error "No function definition for install_dependencies" +} + +# Halts lokinet to allow for modifications to it +function stop_lokinet(){ + sudo systemctl stop lokinet.service +} + +# Verifies existence and permissions of SNApp directory +function create_webpage_directory() { + install_log "Creating webpage directory" + snapp_dir="/home/$username/snapp" + + if [ -d "$snapp_dir" ]; then + sudo mv $snapp_dir "$snapp_dir.`date +%F-%R`" || install_error "Unable to move old '$snapp_dir' out of the way" + fi + sudo mkdir -p "$snapp_dir" || install_error "Unable to create directory '$snapp_dir'" + sudo chown -R $username:$username "$snapp_dir" || install_error "Unable to change file ownership for '$snapp_dir'" +} + +# Fetches latest files from github for basic SNapp +function download_latest_files() { + if [ -d "$snapp_dir" ]; then + sudo mv $snapp_dir "$snapp_dir.`date +%F-%R`" || install_error "Unable to remove old snap directory" + fi + + install_log "Cloning latest files from github" + git clone --depth 1 https://github.com/necro-nemesis/Daedalus-SNAppCrafter $snapp_dir || install_error "Unable to download files from github" + +#handle changes to resolvconf giving nameserver 127.3.2.1 priority. + sudo systemctl stop resolvconf + sudo mv $snapp_dir/head /etc/resolvconf/resolv.conf.d/head || install_error "Unable to move resolvconf head file" + sudo rm /etc/resolv.conf + sudo ln -s /etc/resolvconf/run/resolv.conf /etc/resolv.conf + sudo resolvconf -u || install_error "Unable to update resolv.conf" + sudo systemctl start resolvconf +} + +# Sets files ownership in SNapp directory +function change_file_ownership() { + if [ ! -d "$snapp_dir" ]; then + install_error "snapp directory doesn't exist" + fi + + install_log "Changing file ownership in SNApp directory" + sudo chown -R $username:$username "$snapp_dir" || install_error "Unable to change file ownership for 'snapp_dir'" + sudo chmod -R 0755 "$snapp_dir" || install_error "Unable to change permissions for 'snapp_dir'" + sudo mv $snapp_dir/snapp /usr/local/bin +} + +function install_complete() { + + #append /var/lib/lokinet/lokinet.ini + sed -i 's#\#keyfile=#keyfile=/var/lib/lokinet/snappkey.private#g' /var/lib/lokinet/lokinet.ini + sudo systemctl restart lokinet + + #set nginx host directory to snapp_dir + sed -i 's#/var/www/html#'"$snapp_dir"'#g' /etc/nginx/sites-enabled/default + + #clean out installer files + sudo rm -r $snapp_dir/installers || install_error "Unable to remove installers" + sudo rm -r /tmp/snapp || install_error "Unable to remove /tmp/snapp folder" + + #provide option to launch and display lokinet address + + cyan='\033[1;36m' + echo -e "${cyan}\n" + echo -e " ____ _ _ " + echo -e " | _ \ __ _ ___ __| | __ _| |_ _ __ " + echo -e " | | | |/ _ |/ _ \/ _ |/ _ | | | | / __| " + echo -e " | |_| | (_| | __/ (_| | (_| | | |_| \__ \ " + echo -e " |____/ \__,_|\___|\__,_|\__,_|_|\__,_|___/ " + echo -e " by Minotaurware.net " + install_log "Daedalus has completed your installation" + IP="127.3.2.1" + snapp_address=$(host -t cname localhost.loki $IP | awk '/alias for/ { print $6 }') + install_warning "Your Lokinet Address is:\nhttp://${snapp_address}" + install_warning "Place your SNApp in ${snapp_dir}" + echo -n "Do you wish to go live with test snapp? [y/N]: " + read answer + if [[ $answer != "y" ]]; then + echo "Server not launched. Exiting installation" + exit 0 + fi + install_log "Server Launching" + sudo systemctl restart nginx + sudo systemctl restart lokinet + exit 0 || install_error "Unable to exit" +} + +function install_Daedalus() { + display_welcome + update_system_packages + install_dependencies + stop_lokinet + create_user + create_webpage_directory + download_latest_files + change_file_ownership + install_complete +} diff --git a/installers/snappsetup.sh b/installers/snappsetup.sh new file mode 100644 index 0000000..21d1862 --- /dev/null +++ b/installers/snappsetup.sh @@ -0,0 +1,20 @@ +UPDATE_URL="https://raw.githubusercontent.com/necro-nemesis/Daedalus-SNAppCrafter/master/" +wget -q ${UPDATE_URL}/installers/common.sh -O /tmp/pihostcommon.sh +source /tmp/pihostcommon.sh && rm -f /tmp/pihostcommon.sh + +function update_system_packages() { + install_log "Updating sources" + sudo apt-get update || install_error "Unable to update package list" +} + +function install_dependencies() { + install_log "Installing required packages" + sudo apt-get -y install curl lsb-release gnupg + echo "Install public key used to sign the lokinet binaries." + curl -s https://deb.imaginary.stream/public.gpg | sudo apt-key add - + echo "deb https://deb.imaginary.stream $(lsb_release -sc) main" | sudo tee /etc/apt/sources.list.d/imaginary.stream.list + sudo apt-get update + sudo yes | apt-get install git screen nginx dnsutils python3 resolvconf lokinet || install_error "Unable to install dependencies" +} + +install_Daedalus