Skip to content

CONFIG_SETUP_QUICK.md

Latest commit

 

History

History
183 lines (130 loc) · 3.82 KB

CONFIG_SETUP_QUICK.md

File metadata and controls

183 lines (130 loc) · 3.82 KB
Raw

Quick Config Setup Guide

There are 3 ways to provide credentials to Mind_Finder. Pick the method that works best for you!

Method 1: config.yaml (Recommended - Easy to manage)

Setup:

cd /home/kali/Git/MindSeeker_Suite
cp config.yaml.example config.yaml
nano config.yaml  # or vi, vim, code, etc.

Fill in your credentials:

github:
  token: "ghp_YOUR_ACTUAL_TOKEN_HERE"

google:
  api_key: "YOUR_GOOGLE_API_KEY"
  cse_id: "YOUR_CSE_ID"

# Optional
gitlab:
  token: "glpat_YOUR_TOKEN"

Run the tool:

python3 Mind_Finder.py -c PayPal -d paypal.com

Benefit: Easy to read, organized, supports comments

Method 2: .env file (Simple key=value format)

Setup:

cd /home/kali/Git/MindSeeker_Suite
cp .env.example .env
nano .env

Fill in your credentials:

GITHUB_TOKEN=ghp_YOUR_ACTUAL_TOKEN_HERE
GOOGLE_CSE_API_KEY=YOUR_GOOGLE_API_KEY
GOOGLE_CSE_ID=YOUR_CSE_ID

# Optional
GITLAB_TOKEN=glpat_YOUR_TOKEN
LINKEDIN_EMAIL=your@email.com
LINKEDIN_PASSWORD=yourpassword

Run the tool:

python3 Mind_Finder.py -c PayPal -d paypal.com

Benefit: Simple, works without PyYAML library

Method 3: Environment Variables (Traditional)

Set once per session:

export GITHUB_TOKEN=ghp_YOUR_ACTUAL_TOKEN_HERE
export GOOGLE_CSE_API_KEY=YOUR_GOOGLE_API_KEY
export GOOGLE_CSE_ID=YOUR_CSE_ID

Make permanent (add to ~/.bashrc):

echo 'export GITHUB_TOKEN=ghp_YOUR_ACTUAL_TOKEN_HERE' >> ~/.bashrc
source ~/.bashrc

Run the tool:

python3 Mind_Finder.py -c PayPal -d paypal.com

Benefit: Works system-wide, no files needed

Priority Order

If you have credentials in multiple places, Mind_Finder uses this priority:

  1. config.yaml (highest priority)
  2. .env file
  3. Environment variables (lowest priority)

Example: If you have GITHUB_TOKEN in both config.yaml and .env, the config.yaml value will be used.

Security Notes

✅ Safe files (can commit to git):

  • .env.example
  • config.yaml.example

❌ NEVER commit these (already in .gitignore):

  • .env
  • config.yaml
  • Any file with real credentials

Quick Start (Minimal Setup)

For GitHub only (minimum to run the tool):

# Option A: config.yaml
cp config.yaml.example config.yaml
# Edit config.yaml and add your GitHub token

# Option B: .env
cp .env.example .env
# Edit .env and add GITHUB_TOKEN=your_token

# Option C: Environment variable
export GITHUB_TOKEN=ghp_your_token_here

Then run:

python3 Mind_Finder.py -c TestCompany -d test.com

Optional: Install Libraries for Better Support

# For config.yaml support
pip3 install pyyaml

# For .env support (with auto-loading)
pip3 install python-dotenv

Note: The tool works WITHOUT these libraries - it has built-in parsers as fallback!

Troubleshooting

"No credentials loaded"

  • Check your file is named exactly .env or config.yaml (not .env.txt or config.yaml.example)
  • Make sure the file is in the same directory as Mind_Finder.py
  • Verify credentials don't have placeholder values like "ghp_your_github_token_here"

"YAML not found" warning

  • This is normal if you don't have PyYAML installed
  • The tool will try .env instead
  • To install: pip3 install pyyaml

Credentials not working

  • Verify your GitHub token is valid: curl -H "Authorization: token YOUR_TOKEN" https://api.github.com/user
  • Check for typos in token
  • Make sure token has correct scopes (see CREDENTIALS_SETUP.md)

What's Next?

  1. Test your setup: python3 Mind_Finder.py -c Slack -d slack.com
  2. Set up Google CSE (for 300% more results): See CREDENTIALS_SETUP.md
  3. Run on real target: python3 Mind_Finder.py -c YourTarget -d target.com

Need detailed credential setup instructions? See CREDENTIALS_SETUP.md