From 7bf5b9516bafd01a7ea4f2e9f36b4716a30b61f6 Mon Sep 17 00:00:00 2001 From: glen Date: Sat, 8 May 2021 22:14:24 -0400 Subject: [PATCH] First major commit --- README.md | 42 +++------- installers/common.sh | 177 ++++++++++++++++++++------------------- installers/snappsetup.sh | 8 +- 3 files changed, 106 insertions(+), 121 deletions(-) diff --git a/README.md b/README.md index d8b18cd..5814ed0 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,10 @@ -SNApp Setup Tool +SBC Lokinet Micro Exit ![](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) +# `SBC Lokinet Micro Exit` [![Release 1.0](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) +SBC Lokinet Micro Exit is an easy to use Lokinet Exit set up tool to rapidly configure an Exit on a Debian based Single Board Computer (SBC) utilizing .deb packages. The installer can configure an exit for Lokinet on an SBC running Debian, Raspberry OS or Armbian. This allows anyone to host their own exit using Lokinet network. After installing a fresh image, running the script and following the installers instructions the device will launch your exit providing you with your individual exit address. ## Contents @@ -19,19 +13,17 @@ Daedalus SNAppCrafter is an easy to use Lokinet webserver set up tool to rapidly - [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. +Start with a fresh install of Debian on your system or server. ### 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. +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 Micro Exit 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. @@ -62,7 +54,7 @@ https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html 3. Follow any first user password instructions provided once logged in. -4. If you want to get the lastest updates before installing Daedalus-SNAppCrafter: +4. If you want to get the lastest updates before installing Micro Exit installer: ``` sudo apt-get update sudo apt-get upgrade @@ -72,29 +64,17 @@ With the prerequisites done, you can now proceed with the Quick installer. ## Quick installer -Install Daedalus-SNAppCrafter from shell prompt: +Install SBC Lokinet Micro Exit from shell prompt: ```sh -$ wget -q https://git.io/JepoL -O /tmp/snapp && bash /tmp/snapp +$ wget -q https://git.io/JepoL -O /tmp/microexit && bash /tmp/microexit ``` -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``` +The installer will update, locate, install and configure all the prerequisites for you. You will be prompted to create a new user account. -ensure when testing for changes you clear the browser cache to freshly reload the site. +At the end of the install process you will be presented with your Lokinet address. Either by starting the exit 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 Lokinet client to test your exit. ## 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. +SBC Lokinet Micro Exit 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 diff --git a/installers/common.sh b/installers/common.sh index e3b9820..4f56e8b 100644 --- a/installers/common.sh +++ b/installers/common.sh @@ -3,7 +3,7 @@ #create hostname account with root privelages. function create_user () { -install_log "Create a SNApp host user account" +install_log "Create Exit user account" if [ $(id -u) -eq 0 ]; then read -p "Enter username : " username @@ -25,18 +25,18 @@ fi } -# Outputs a Deadalus Install log line +# Outputs a Exit Install log line function install_log() { - echo -e "\033[1;32mSNApp Install: $*\033[m" + echo -e "\033[1;32mexit Install: $*\033[m" } -# Outputs a Deadalus Install Error log line and exits with status code 1 +# Outputs a Exit Install Error log line and exits with status code 1 function install_error() { - echo -e "\033[1;37;41mSNApp Install Error: $*\033[m" + echo -e "\033[1;37;41mexit Install Error: $*\033[m" exit 1 } -# Outputs a Deadalus Warning line +# Outputs a Exit Warning line function install_warning() { echo -e "\033[1;33mAdvisory: $*\033[m" } @@ -48,20 +48,20 @@ function display_welcome() { 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 " ____ _ _ " + # 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 "Exit setup tool for SBCs." echo -e "The Quick Installer will guide you through a few easy steps\n\n" } @@ -85,96 +85,101 @@ 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() { +# # Verifies existence and permissions of exit directory +# function create_exit_directory() { +# install_log "Creating exit files directory" +# exit_dir="/home/$username/exit" +# +# if [ -d "$exit_dir" ]; then +# sudo mv $exit_dir "$exit_dir.`date +%F-%R`" || install_error "Unable to move old '$exit_dir' out of the way" +# fi +# sudo mkdir -p "$exit_dir" || install_error "Unable to create directory '$exit_dir'" +# sudo chown -R $username:$username "$exit_dir" || install_error "Unable to change file ownership for '$exit_dir'" +# } +# +# # Fetches latest files from github for basic exit +# function download_latest_files() { +# if [ -d "$exit_dir" ]; then +# sudo mv $exit_dir "$exit_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/SBC-Lokinet-Micro-Exit $exit_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 $exit_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 exit directory +# function change_file_ownership() { +# if [ ! -d "$exit_dir" ]; then +# install_error "exit directory doesn't exist" +# fi +# +# install_log "Changing file ownership in exit directory" +# sudo chown -R $username:$username "$exit_dir" || install_error "Unable to change file ownership for 'exit_dir'" +# sudo chmod -R 0755 "$exit_dir" || install_error "Unable to change permissions for 'exit_dir'" +# sudo mv $exit_dir/exit /usr/local/bin +# } + +function configure_exit() { #append /var/lib/lokinet/lokinet.ini - sed -i 's#\#keyfile=#keyfile=/var/lib/lokinet/snappkey.private#g' /var/lib/lokinet/lokinet.ini + sed -i 's#\#keyfile=#keyfile=/var/lib/lokinet/exit.private#g' /var/lib/lokinet/lokinet.ini + sed -i 's#\#min-connections=4#min-connections=8#g' /var/lib/lokinet/lokinet.ini + sed -i 's#\#max-connections=6#max-connections=16#g' /var/lib/lokinet/lokinet.ini + sed -i 's#\#exit=0#exit=true#g' /var/lib/lokinet/lokinet.ini + sed -i 's#\#reachable=1#reachable=1#g' /var/lib/lokinet/lokinet.ini + sed -i 's#\#ifaddr=#ifaddr=172.16.0.1/16#g' /var/lib/lokinet/lokinet.ini + sed -i 's#\#paths=6#paths=8#g' /var/lib/lokinet/lokinet.ini + sed -i 's#\#net.ipv4.ip_forward=1#net.ipv4.ip_forward = 1#g' /etc/sysctl.conf + sudo sysctl -p /etc/sysctl.conf 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" + sudo rm -r $exit_dir/installers || install_error "Unable to remove installers" + sudo rm -r /tmp/exit || install_error "Unable to remove /tmp/exit folder" #provide option to launch and display lokinet address - - cyan='\033[1;36m' + + cyan='\033[1;36m' echo -e "${cyan}\n" - echo -e " ____ _ _ " - echo -e " | _ \ __ _ ___ __| | __ _| |_ _ __ " - echo -e " | | | |/ _ |/ _ \/ _ |/ _ | | | | / __| " - echo -e " | |_| | (_| | __/ (_| | (_| | | |_| \__ \ " - echo -e " |____/ \__,_|\___|\__,_|\__,_|_|\__,_|___/ " + # echo -e " ____ _ _ " + # echo -e " | _ \ __ _ ___ __| | __ _| |_ _ __ " + # echo -e " | | | |/ _ |/ _ \/ _ |/ _ | | | | / __| " + # echo -e " | |_| | (_| | __/ (_| | (_| | | |_| \__ \ " + # echo -e " |____/ \__,_|\___|\__,_|\__,_|_|\__,_|___/ " echo -e " by Minotaurware.net " - install_log "Daedalus has completed your installation" + install_log "SBC Lokinet Micro Exit setup 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]: " + exit_address=$(host -t cname localhost.loki $IP | awk '/alias for/ { print $6 }') + install_warning "Your Lokinet Address is:\nhttp://${exit_address}" + install_warning "Place your exit in ${exit_dir}" + echo -n "Do you wish to go live with exit? [y/N]: " read answer if [[ $answer != "y" ]]; then - echo "Server not launched. Exiting installation" + echo "Exit not launched. Exiting installation" exit 0 fi - install_log "Server Launching" - sudo systemctl restart nginx + install_log "Exit Launching" sudo systemctl restart lokinet exit 0 || install_error "Unable to exit" } -function install_Daedalus() { +function install_Exit() { display_welcome update_system_packages install_dependencies stop_lokinet create_user - create_webpage_directory - download_latest_files - change_file_ownership - install_complete + # create_exit_directory + # download_latest_files + # change_file_ownership + configure_exit } diff --git a/installers/snappsetup.sh b/installers/snappsetup.sh index 21d1862..30ed1e1 100644 --- a/installers/snappsetup.sh +++ b/installers/snappsetup.sh @@ -1,6 +1,6 @@ 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 +wget -q ${UPDATE_URL}/installers/common.sh -O /tmp/exitcommon.sh +source /tmp/exitcommon.sh && rm -f /tmp/exitcommon.sh function update_system_packages() { install_log "Updating sources" @@ -14,7 +14,7 @@ function install_dependencies() { 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" + sudo yes | apt-get install git screen dnsutils python3 resolvconf lokinet || install_error "Unable to install dependencies" } -install_Daedalus +install_Exit