pulsar

(β˜… 430)

Network footprint scanner platform. Discover domains and run your custom checks periodically.

  • .deepsource.toml
  • .gitignore
  • _config.yml
  • docker-compose.yml
  • Dockerfile
  • install.ps1
  • install.sh
  • LICENSE
  • LICENSE.md
  • README.md
  • TROUBLESHOOTING.md
  • USAGE.md

# Installation Guide

1. Get the code
git clone https://github.com/0x0FB0/pulsar

Downloads the entire project code from GitHub to your computer.

cd pulsar

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • APT (Debian/Ubuntu 계열) Built into Debian/Ubuntu-based Linux distributions.
sudo apt install git

Installs directly from the APT package repository (Debian/Ubuntu-based).

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install -r portal/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <μ‹€ν–‰ν•  파일λͺ…>.py # READMEμ—μ„œ μ •ν™•ν•œ μ‹€ν–‰ 파일λͺ…을 ν™•μΈν•˜μ„Έμš”

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.
// repository documentation