Skip to content

Latest commit

 

History

History
87 lines (57 loc) · 3.31 KB

tutorial.md

File metadata and controls

87 lines (57 loc) · 3.31 KB

Step by step beginners tutorial

Welcome, this is a tutorial for absolute beginners. If you have no previous experience with hosting a server, or working with a Raspberry Pi, this is for you. If you have any questions along the way, feel free to ask for help in our Telegram community.

If you do not yet have a working Raspberry Pi

  1. Flash Raspbian to your Pi. The Raspberry Pi Imager tool works well. Make sure to enable SSH if you don't have a display to connect your Pi to. For the remainder of this tutorial we'll assume you're logging into your Pi remotely via SSH. Also make sure to set a login and password.
  2. Connect your Pi to power and wifi/ethernet.

Connecting, logging in & installing

  1. In your router, assign a static IP-address to your Pi. How this works is different for every router so you'll have to figure this one out yourself.
  2. Log into your Pi by opening a terminal and entering the following, followed by your password (this remains hidden).
ssh yourusername@theIP-addressofyourpi
  1. Enter the following commands one by one to prepare your Pi for installing the tool. Don't worry if you get a notification that something is already installed; that's a good thing.
sudo apt-get update && sudo apt-get upgrade -y
sudo apt-get install git libxml2-dev libxslt-dev python3-venv -y
export EDITOR=nano
  1. Now follow step 1 and 2 from the README file, which can be found here

Finetuning your configuration before launch

  1. Good work! Now go to ScraperAPI and create a free account. After signing up you'll immediately see an API key. Copy this for later use.

  2. Enter the following:

make config

  1. An text editor now opens. We're changing a few things here.

  2. Under GENERAL SETTINGS:

PODIMO_HOSTNAME= should be followed by your public IP-address (which you can find here). It should look like this:

PODIMO_HOSTNAME="YOURPUBLICIP:12104"

PODIMO_BIND_HOST= you should change to the following:

PODIMO_BIND_HOST="0.0.0.0:12104"

  1. Under PROXIES, remove the # in front of SCRAPER_API= and add the api key you copied earlier between the "".

  2. Hit ctrl-x, followed by y to save and close the file.

Starting the tool

  1. Type the following:
make start

Done! If all went well you can now enter YOURIPADDRESS:12104 into your browser and it'll show your tool.

A few smart things to end this tutorial

  1. Enable port forwarding to the external 12104 port on your router. This enables you to use the tool when you're not home.

  2. If you encounter problems and ask the community for help, they'll probably ask for logs. You can find these by entering one of the the following:

make logs
  1. If you want to update the tool, type the following while being in the /podimo folder:
make update

Support

If you find this tool to be helpful, please consider buying me a coffee! It is greatly appreciated!