DirectoryStructure.md

Directory Structure

Explains directory structure used in this repository
Most directories also contain a README.md with additional information

In the following table duplicate folder names (in different trees) are excluded since the meaning is same or similar.

Table of Contents

• Directory Structure
  • Table of Contents
  • .github
    • ISSUE_TEMPLATE
    • workflows
  • .vscode
  • Actions
    • PSScriptAnalyzer
    • publish_sitemap
  • Config
    • cSpell
    • HelpContent
    • mTail
    • procmon
    • SSH
    • System
    • WPA
  • docs
    • LAN Setup
    • Screenshots
  • Exports
  • Logs
    • Audit
    • Firewall
    • Test
    • UpdateHelp
  • Modules
    • en-US
    • Help
      • en-US
    • Private
    • Public
    • Scripts
  • Rules
    • IPv4
    • IPv6
      • Outbound rules
        • Development
        • Games
        • Server
        • Software
          • Microsoft
      • Inbound rules
  • Scripts
    • Experiment
    • Security
    • Utility
  • Templates
  • Test

.github

Contains GitHub templates and workflows

ISSUE_TEMPLATE

Issue templates

workflows

Github workflows

.vscode

Contains Visual Studio Code configuration and settings for extensions

Actions

Contains actions for github workflows

PSScriptAnalyzer

PSScriptAnalyzer action

publish_sitemap

Contains code to publish generated sitemap of docs directory to google

Config

Project configuration and configuration for external programs

cSpell

Contains dictionaries for spell checker extension

HelpContent

Contains CAB files for Update-Help commandlet

mTail

Configurations files for mTail program

procmon

Configurations files for process monitor from sysinternals site

SSH

SSH configuration files for Remote-SSH extension

System

Settings for OS related software

WPA

Contains settings for Windows Performance Analyzer

docs

Contains detailed project documentation

LAN Setup

Contains notes for OS network setup

Screenshots

Screenshots for markdown documentation

Exports

Contains exported firewall rules ready to be reimported

Logs

Contains logs made by modules and scripts

Audit

Contains audit logs generated by packet capture tools or scripts

Firewall

Contains logs generated by Windows Firewall if the firewall was set so

Test

Log files generated by tests

UpdateHelp

Log files generated while updating online help

Modules

Root directory for modules that are part of repository

en-US

Help info files for updatable help

Help

Contains per language subdirectories for markdown help files

en-US

Contains markdown help files for specific language

Private

Functions private to module

Public

Functions exposed by module

Scripts

Contains module scripts that are not functions

Rules

Root directory for all firewall rules

IPv4

IPv4 rules

IPv6

IPv6 rules

Outbound rules

Rules which apply to outbound traffic

Development

Rules which apply to development programs

Games

Rules which apply to games

Server

Rules which are specific to server platforms

Software

Rules which apply to 3rd party programs

Microsoft

Rules which apply Microsoft programs

Inbound rules

Rules which apply to inbound traffic

Scripts

Scripts which are not part of modules

Experiment

Experimental scripts, can be used for study and arequire improvements

Security

Contains scripts used to manage Windows security

Utility

Contains utility scripts that can help in development and to troubleshoot issues

Templates

Contains script and module templates with boilerplate code

Test

Contains test scripts sorted by module to test out individual functions and concepts

Table of Contents