Skip to content

GITHUB_SETUP.md

Latest commit

 

History

History
161 lines (128 loc) · 4.83 KB

GITHUB_SETUP.md

File metadata and controls

161 lines (128 loc) · 4.83 KB

Manual GitHub Repository Setup Instructions

If you prefer to set up the GitHub repository manually or the automated scripts don't work, follow these steps:

1. Create GitHub Repository

Using GitHub Web Interface:

  1. Go to GitHub.com
  2. Click the "+" icon in the top right → "New repository"
  3. Repository name: sysops.aws.securitygroup
  4. Description: 🔒 AWS Security Groups Traffic Analysis Tool - Comprehensive multi-account security group analysis and visualization dashboard for identifying vulnerabilities and mapping traffic patterns
  5. Make it Public (or Private if preferred)
  6. Do NOT initialize with README, .gitignore, or license (we already have these)
  7. Click "Create repository"

Using GitHub CLI:

gh repo create Tranzact/sysops.aws.securitygroup \
    --description "🔒 AWS Security Groups Traffic Analysis Tool - Comprehensive multi-account security group analysis and visualization dashboard for identifying vulnerabilities and mapping traffic patterns" \
    --public \
    --push \
    --source .

2. Initialize Local Git Repository

# Initialize Git (if not already done)
git init
git branch -M main

# Add all files
git add .

# Commit with descriptive message
git commit -m "Initial commit: AWS Security Groups Analysis Tool v1.0.0

- Multi-account security group analysis
- Interactive Streamlit dashboard  
- Risk assessment and compliance reporting
- Cross-account IAM role support
- Comprehensive CSV export functionality
- Network visualization and traffic mapping"

3. Connect Local Repository to GitHub

# Add remote origin for Tranzact organization
git remote add origin https://github.com/Tranzact/sysops.aws.securitygroup.git

# Push to GitHub
git push -u origin main

4. Configure Repository Settings

Topics (for discoverability):

Go to your repository → Settings → General → Topics, and add:

  • aws
  • security-groups
  • security-analysis
  • aws-security
  • security-audit
  • multi-account
  • traffic-analysis
  • dashboard
  • python
  • streamlit
  • security-tools
  • aws-cli
  • devops
  • sysops
  • network-security

Security Features:

Go to Settings → Security & analysis:

  • ✅ Enable "Secret scanning"
  • ✅ Enable "Secret scanning push protection"
  • ✅ Enable "Dependabot alerts"
  • ✅ Enable "Dependabot security updates"

Branch Protection (Optional but Recommended):

Go to Settings → Branches → Add rule for main:

  • ✅ Require pull request reviews before merging
  • ✅ Require status checks to pass before merging
  • ✅ Dismiss stale pull request approvals when new commits are pushed

5. Create Initial Release

Using GitHub Web Interface:

  1. Go to your repository → Releases → "Create a new release"
  2. Tag version: v1.0.0
  3. Release title: AWS Security Groups Analysis Tool v1.0.0
  4. Description: Copy from the release notes in the automated script
  5. Click "Publish release"

Using GitHub CLI:

gh release create v1.0.0 \
    --title "AWS Security Groups Analysis Tool v1.0.0" \
    --notes "Initial release with multi-account security group analysis, interactive dashboard, and comprehensive reporting capabilities."

6. Verify Repository Setup

Your repository should now have:

  • ✅ All project files committed
  • ✅ README.md with comprehensive documentation
  • ✅ LICENSE file (MIT)
  • ✅ CONTRIBUTING.md guidelines
  • ✅ SECURITY.md policy
  • ✅ CODE_OF_CONDUCT.md
  • ✅ GitHub Actions workflow (.github/workflows/ci.yml)
  • ✅ Repository topics for discoverability
  • ✅ Security features enabled
  • ✅ Initial v1.0.0 release

7. Next Steps

  1. Clone and test: Clone the repository and test the installation
  2. Add collaborators: Invite team members if this is a shared project
  3. Set up CI/CD: Configure any additional automation
  4. Documentation: Add any organization-specific setup instructions
  5. Share: Share the repository URL with your team

Repository URLs

After setup, your repository will be available at:

  • HTTPS: https://github.com/Tranzact/sysops.aws.securitygroup.git
  • SSH: git@github.com:Tranzact/sysops.aws.securitygroup.git
  • Web: https://github.com/Tranzact/sysops.aws.securitygroup

This repository will be created under the Tranzact organization.

Troubleshooting

Authentication Issues:

# Check GitHub CLI authentication
gh auth status

# Login if needed
gh auth login

Git Configuration:

# Set up Git user (if not already done)
git config --global user.name "Your Name"
git config --global user.email "your.email@example.com"

Repository Already Exists:

If you get an error that the repository already exists, either:

  1. Choose a different name, or
  2. Delete the existing repository and try again

Note: Remember to keep your AWS credentials secure and never commit them to the repository!