https://github.com/rizemon/monitormypublicip

A workflow that scans the IP address specified by the IP_ADDRESS Github secret and reports it in the form of a Github issue.
https://github.com/rizemon/monitormypublicip

Last synced: 4 months ago
JSON representation

A workflow that scans the IP address specified by the IP_ADDRESS Github secret and reports it in the form of a Github issue.

• Host: GitHub
• URL: https://github.com/rizemon/monitormypublicip
• Owner: rizemon
• Created: 2021-12-31T12:06:07.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-12T15:26:27.000Z (about 2 years ago)
• Last Synced: 2025-01-03T21:15:23.400Z (over 1 year ago)
• Language: Shell
• Homepage:
• Size: 82 KB
• Stars: 0
• Watchers: 1
• Forks: 2
• Open Issues: 6,739
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# MonitorMyPublicIP

This repository contains code for a workflow that performs a daily `nmap` scan for open ports on a target (specified by the `IP_ADDRESS` Github secret) and exports the results into an issue on this repository.

Any IP addresses in the results have been intentionally censored for privacy reasons.

## Features

* Performs a `nmap` scan daily on the target defined by the `IP_ADDRESS` secret.

* Supports on-demand scans.

* Reports results as Github issues.

## Simple Usage

1. Fork this repository to your Github account.

2. Create a new repository secret by following this [link](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) with the name `IP_ADDRESS` and its value set to the IP address that you wish to scan. (e.g `8.8.8.8`)   

![](images/github_secret.png)

3. Wait for the workflow to run or manually trigger it by following this [link](https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow#running-a-workflow).  

![](images/manual_workflow.png)

4. Observe the scan report on the Issues page of the forked repository.  

![](images/github_issues.png)

## FAQ

Question: How do I define **when** the workflow executes?  

Answer: You can set the `cron` schedule defined in `.github/workflows/scan.yml`. Read [this](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule) to learn more about it.