From 3d09c7a09c88f9f262a857e15aaf947187130bf1 Mon Sep 17 00:00:00 2001 From: rabsondev Date: Thu, 28 Mar 2024 16:12:25 +0000 Subject: [PATCH] Replace HTML with markdown in the `README.md` and `ostorlab.yaml`. --- README.md | 38 ++++++++++++--------------- ostorlab.yaml | 72 ++++++++++++++++++++++++++++++++------------------- 2 files changed, 63 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index a960e37..13695e1 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,12 @@ -

Agent Ip2Geo

+# Agent Ip2Geo -

- - - -

+![image](https://img.shields.io/badge/License-Apache_2.0-brightgreen.svg) +![image](https://img.shields.io/github/languages/top/ostorlab/agent_ip2geo) +![image](https://img.shields.io/badge/PRs-welcome-brightgreen.svg) _Ip2Geo agent is part of the auto-discovery agents, responsible for detecting the geolocation details of an IP address._ -

-agent-ip2geo -

+![image](https://raw.githubusercontent.com/Ostorlab/agent_ip2geo/main/images/logo.png) This repository is an implementation of [OXO Agent](https://pypi.org/project/ostorlab/). @@ -55,22 +51,22 @@ pip3 install ostorlab git clone https://github.com/Ostorlab/agent_ip2geo.git && cd agent_ip2geo ``` - 3. Build the agent image using oxo cli. +3. Build the agent image using oxo cli. ```shell oxo agent build --file=ostorlab.yaml ``` - You can pass the optional flag `--organization` to specify your organisation. The organization is empty by default. - - 4. Run the agent using one of the following commands: - * If you did not specify an organization when building the image: - ```shell - oxo scan run --agent agent//ip2geo --agent agent//autodiscovery_persist_graph ip 8.8.8.8 - ``` - * If you specified an organization when building the image: - ```shell - oxo scan run --agent agent/[ORGANIZATION]/ip2geo --agent agent/[ORGANIZATION]/autodiscovery_persist_graph ip 8.8.8.8 - + You can pass the optional flag `--organization` to specify your organization. The organization is empty by default. + +4. Run the agent using on of the following commands: + * If you did not specify an organization when building the image: + ```shell + oxo scan run --agent agent//ip2geo --agent agent//autodiscovery_persist_graph ip 8.8.8.8 + ``` + * If you specified an organization when building the image: + ```shell + oxo scan run --agent agent/[ORGANIZATION]/ip2geo --agent agent/[ORGANIZATION]/autodiscovery_persist_graph ip 8.8.8.8 + ``` ## License [Apache](./LICENSE) diff --git a/ostorlab.yaml b/ostorlab.yaml index a12cfc5..e20ca77 100644 --- a/ostorlab.yaml +++ b/ostorlab.yaml @@ -3,56 +3,76 @@ name: ip2geo version: 0.2.10 image: images/logo.png description: | -

Agent Ip2Geo

-

- - - -

+ # Agent Ip2Geo + + ![image](https://img.shields.io/badge/License-Apache_2.0-brightgreen.svg) + ![image](https://img.shields.io/github/languages/top/ostorlab/agent_ip2geo) + ![image](https://img.shields.io/badge/PRs-welcome-brightgreen.svg) + _Ip2Geo agent is part of the auto-discovery agents, responsible for detecting the geolocation details of an IP address._ -

- agent-ip2geo -

- This repository is an implementation of [Ostorlab Agent](https://pypi.org/project/ostorlab/). + + ![image](https://raw.githubusercontent.com/Ostorlab/agent_ip2geo/main/images/logo.png) + + This repository is an implementation of [OXO Agent](https://pypi.org/project/ostorlab/). + ## Getting Started - The Ip2Geo Agent works collectively with other agents. Its job; Finds all geolocation details of an IP address and emits back these findings. - To perform your first scan, simply run the following command: + The Ip2Geo Agent works collectively with other agents. Its job; Find all geolocation details of an IP address and emit back these findings. + + To use the agent in a scan, simply run the following command: + ```shell oxo scan run --install --agent agent/ostorlab/ip2geo \ - --agent agent/ostorlab/subfinder \ - --agent agent/ostorlab/autodiscovery_persist_graph \ - ip 8.8.8.8 + --agent agent/ostorlab/subfinder \ + --agent agent/ostorlab/autodiscovery_persist_graph \ + ip 8.8.8.8 ``` + This command will download and install the agents :`ip2geo`, `subfinder` and `autodiscovery_persist_graph` and target the IP address `8.8.8.8`. - For more information, please refer to the [Ostorlab Documentation](https://oxo.ostorlab.co/docs) + + For more information, please refer to the [OXO Documentation](https://oxo.ostorlab.co/docs) + + ## Usage + Agent Ip2Geo can be installed directly from the oxo agent store or built from this repository. + ### Install directly from oxo agent store + ```shell oxo agent install agent/ostorlab/ip2geo ``` + ### Build directly from the repository + 1. To build the Ip2Geo agent you need to have [oxo](https://pypi.org/project/ostorlab/) installed in your machine. If you have already installed oxo, you can skip this step. + ```shell pip3 install ostorlab ``` + 2. Clone this repository. + ```shell git clone https://github.com/Ostorlab/agent_ip2geo.git && cd agent_ip2geo ``` - 3. Build the agent image using oxo cli. + + 3. Build the agent image using oxo cli. + ```shell oxo agent build --file=ostorlab.yaml ``` - You can pass the optional flag `--organization` to specify your organisation. The organization is empty by default. - 4. Run the agent using one of the following commands: - * If you did not specify an organization when building the image: - ```shell - oxo scan run --agent agent//ip2geo --agent agent//autodiscovery_persist_graph ip 8.8.8.8 - ``` - * If you specified an organization when building the image: - ```shell - oxo scan run --agent agent/[ORGANIZATION]/ip2geo --agent agent/[ORGANIZATION]/autodiscovery_persist_graph ip 8.8.8.8 + You can pass the optional flag `--organization` to specify your organization. The organization is empty by default. + + 4. Run the agent using on of the following commands: + * If you did not specify an organization when building the image: + ```shell + oxo scan run --agent agent//ip2geo --agent agent//autodiscovery_persist_graph ip 8.8.8.8 + ``` + * If you specified an organization when building the image: + ```shell + oxo scan run --agent agent/[ORGANIZATION]/ip2geo --agent agent/[ORGANIZATION]/autodiscovery_persist_graph ip 8.8.8.8 + ``` + ## License [Apache](./LICENSE) license: Apache-2.0