README.md

🪝
Fisherman

Fisherman is a simple express.js server, that collects basic client's data on every connection.

✨ Features

• Showing Client's Data

  
  Including:
  • IP Address
  • Geolocation
  • Web Browser
  • Operating System
• Easy to use (ready to use in less than 15 minutes)
• Secure (even though it's a simple server, we will develop better and better security)
• Clarity of use (because of used colors pallete)

🖼️ Preview

Default landing page:

Command-Line:

⚡ Requirements

• Node.js (and npm)
• NPM Dependencies

  • Express.js
  • GeoIP-Lite
  • Ngrok

🛠️ Installation

Linux

sudo apt-get update  # Update apt-get
sudo apt-get install nodejs npm git  # Install all dependencies
git clone https://github.com/dox-dev/fisherman.git  # Clone Fisherman repository
cd fisherman  # Enter Fisherman directory
/usr/bin/npm install --save  # npm will install all required dependencies

Windows

1. Install Node.js
2. Download repository zip file and extract it to another folder
3. Open the folder, where you extracted repository files with Command Prompt
4. Run npm install --save to install all required dependencies

📦 Setup

Create Free Ngrok Account

To use Fisherman you need to have Ngrok account To create one, just visit dashboard.ngrok.com/signup and follow all instructions.

Set Your Ngrok Authentication Token

After creating free Ngrok account, go to dashboard.ngrok.com/get-started/your-authtoken and copy your auth token.
Then open app.js file and paste your auth token into the "token" variable. Right here:

const app = express()
const port = 8080


// Your ngrok auth token (Get it here: https://dashboard.ngrok.com/get-started/your-authtoken)
const token = 'PUT YOUR AUTH TOKEN HERE'
 

Finishing Touches

When you'll add your authentication token, you're all set to go. Right now you can upload your index.html file into /public/ directory.

And that's it! Now you can start your Fisherman server, by typing:

.\fisherman.sh #Windows

or

sh fisherman.sh #Linux

into your Command-Line.

📝 Todo List

• Better Routing
• Faster Response Time
• Better Security
• More Feedback From Client's Connection

Keep in mind that this tool is in its early development, so there still may be some bugs. Sorry for any inconvenience.