🌏 Update your public ip information in a git repository.
JavaScript
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
.gitignore
CONTRIBUTING.md
DOCUMENTATION.md
LICENSE
README.md
package.json

README.md

$ machine-ip

Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads

Update your public ip information in a git repository.

How to use

  1. Create a GitHub repository
  2. Clone it locally
  3. cd into that directory
  4. Run machine-ip
  5. If it works, you should see some IP information in the GitHub repository.
  6. Run automatically as a cron job (e.g. every hour).

Why?

When traveling, I do not have access to my home computer. It is a powerful machine with a fast internet connection.

Also, I do not have a static public ip assigned to that network. The machine does get a static ip from the router. The router does port forwarding on a specific range.

SSH is running on it and it listens on a specific port, exposed in the router.

Whereever I am, I can now ssh to my home computer and do tasks that require more performance (e.g. AI training etc).

Just in case the public ip is going to change, I will see it in my GitHub repository.

Getting a static ip from the router

For posterity, this is my /etc/network/interfaces file:

auto lo
iface lo inet loopback

auto enp5s0
iface enp5s0 inet static
address 192.168.2.xxx
netmask 255.255.255.0
gateway 192.168.2.1
dns-nameservers 8.8.8.8 192.168.1.1

## Listening for ssh connections


In `/etc/ssh/sshd_config`, change the `Port` value to whatever value you want

Port 4242



**Do use SSH keys for authentication, instead of passwords.**

## Connecting

```sh
ssh -A <username>@<public-ip> -p <port>

Cron job

I added the cron job by running crontab -e and writing in that file:

SHELL=/bin/sh
PATH=/home/testing/.nvm/versions/node/v6.7.0/bin:/home/testing/bin:/home/testing/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bi

# Min Hour Day Month Weekday Command
*/10  *    *   *     *       /johnnysapps/ip

The /johnnysapps/ip script contains. This is executed every 10 minutes. In case the electricity goes down, I assume the laptop battery will resist for an hour or so until the electricity is back.

echo "Adding the ssh key"
ssh-add /home/testing/.ssh/id_rsa
echo "Changing directory"
cd /johnnysapps/notebook
ls
echo "Getting the ip"
date > last_updated.txt
machine-ip

☁️ Installation

You can install the package globally and use it as command line tool:

# Using npm
npm install --global machine-ip

# Using yarn
yarn global add machine-ip

Then, run machine-ip --help and see what the CLI tool can do.

$ machine-ip --help
Usage: machine-ip [options]

Update your public ip information in a git repository.

Options:
  -v, --version  Displays version information.
  -h, --help     Displays this help.

Documentation can be found at https://github.com/IonicaBizau/machine-ip#readme.

📝 Documentation

For full API reference, see the DOCUMENTATION.md file.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💖 Support my projects

I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

  • Starring and sharing the projects you like 🚀

  • Buy me a book—I love books! I will remember you after years if you buy me one. 😁 📖

  • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

  • Support me on Patreon—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

  • Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! ❤️

Related

📜 License

MIT © Ionică Bizău