Skip to content

Subnet24 Scanner Setup Guide

Last updated

All documentation

This guide explains how to set up and run the Subnet24 Scanner container, which integrates with the Subnet24 SaaS platform for subnet scanning capabilities.

Prerequisites

  • Docker installed on your system
  • A Subnet24 account (register at app.subnet24.com)
  • Account credentials and API key from your Subnet24 account

Step 1: Pull the Docker Container

To download the Subnet24 Scanner container from Docker Hub, run the following command:

docker pull mikewconsulting/subnet24-scanner

Step 2: Collect Required Credentials

Before running the container, you’ll need to gather two essential pieces of information from your Subnet24 account:

  1. ACCOUNTID:
    • Log into app.subnet24.com
    • Navigate to “Settings” → “Account Info” section
    • Copy your Account ID
  2. API Key:
    • Log into app.subnet24.com
    • Navigate to “Settings” → “Scanner” section
    • Create a new Scanner if you haven’t already
    • Set the scanner Name and Subnets to scan
    • Copy the generated API key

Step 3: Run the Container

Run the container with your credentials using the following command:

docker run -d \
  --name subnet24-scanner \
  -e ACCOUNTID=your_account_id \
  -e APIKEY=your_api_key \
  mikewconsulting/subnet24-scanner

Replace your_account_id and your_api_key with your actual credentials from Step 2.

Step 4: Verify the Scanner is Running

Check if your container is running correctly:

docker ps | grep subnet24-scanner

You should see your container listed with its status.

Managing Your Scanner

View Scanner Logs

To see the scanner logs:

docker logs subnet24-scanner

Add the -f flag to follow logs in real-time:

docker logs -f subnet24-scanner

Stop the Scanner

To stop the scanner container:

docker stop subnet24-scanner

Restart the Scanner

To restart an existing scanner container:

docker start subnet24-scanner

Remove the Scanner Container

If you need to remove the container completely:

docker rm subnet24-scanner

Troubleshooting

If you encounter issues:

  1. Verify your ACCOUNTID and APIKEY are correct
  2. Check the container logs for error messages
  3. Ensure your Docker environment has internet access
  4. Contact Subnet24 support if problems persist

Additional Resources

For more information about Subnet24 and its capabilities, visit:

This container is provided by MikeW Consulting for use with the Subnet24 SaaS platform.