Skip to content

docs: add blocklist documentation to docs-site#150

Merged
Mossaka merged 2 commits intomainfrom
copilot/improve-docs-on-firewall
Dec 19, 2025
Merged

docs: add blocklist documentation to docs-site#150
Mossaka merged 2 commits intomainfrom
copilot/improve-docs-on-firewall

Conversation

Copy link
Contributor

Copilot AI commented Dec 19, 2025

Updates docs-site to document the blocklist feature added in PR #114.

Changes

  • index.md: Updated "Key Capabilities" to mention blocklist, added blocklist usage examples
  • guides/domain-filtering.md: New comprehensive guide covering allowlists, blocklists, wildcard patterns, file-based config, and common use cases
  • reference/security-architecture.md: Updated Squid ACL section to explain blocklist precedence, updated traffic flow diagram
  • reference/cli-reference.md: Updated cross-links

Example from new guide

# Allow example.com but block internal.example.com
sudo awf \
  --allow-domains example.com \
  --block-domains internal.example.com \
  -- curl https://api.example.com  # ✓ allowed

# Wildcard blocklist
sudo awf \
  --allow-domains '*.example.com' \
  --block-domains '*.secret.example.com' \
  -- <command>

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • telemetry.astro.build
    • Triggering command: /usr/local/bin/node node /home/REDACTED/work/gh-aw-firewall/gh-aw-firewall/docs-site/node_modules/.bin/astro build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

improve docs on #114 (DO NOT MODIFY README)

Custom agent used: technical-doc-writer
AI technical documentation writer for awf library using Astro Starlight


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Copilot AI changed the title [WIP] Improve documentation for firewall features docs: add blocklist documentation to docs-site Dec 19, 2025
Copilot AI requested a review from Mossaka December 19, 2025 22:25
@Mossaka Mossaka marked this pull request as ready for review December 19, 2025 23:09
@github-actions
Copy link

Test Coverage Report

Metric Coverage Covered/Total
Lines 71.29% 991/1390
Statements 71.39% 1016/1423
Functions 69.42% 109/157
Branches 66.33% 337/508
Coverage Thresholds

The project has the following coverage thresholds configured:

  • Lines: 38%
  • Statements: 38%
  • Functions: 35%
  • Branches: 30%

Coverage report generated by `npm run test:coverage`

@Mossaka
Copy link
Collaborator

Mossaka commented Dec 19, 2025

@copilot try this again: /usr/local/bin/node node /home/REDACTED/work/gh-aw-firewall/gh-aw-firewall/docs-site/node_modules/.bin/astro build

Copy link
Contributor Author

Copilot AI commented Dec 19, 2025

@copilot try this again: /usr/local/bin/node node /home/REDACTED/work/gh-aw-firewall/gh-aw-firewall/docs-site/node_modules/.bin/astro build

Build succeeded with node ./node_modules/.bin/astro build:

  • 5 pages built in 17.33s
  • 4 pages indexed by Pagefind (1079 words)
  • Static output to docs-site/dist/

Generated pages:

  • /guides/domain-filtering/index.html
  • /index.html
  • /reference/cli-reference/index.html
  • /reference/security-architecture/index.html

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • telemetry.astro.build
    • Triggering command: /usr/local/bin/node node ./node_modules/.bin/astro build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI requested a review from Mossaka December 19, 2025 23:13
@Mossaka Mossaka merged commit 87ed8b1 into main Dec 19, 2025
14 checks passed
@Mossaka Mossaka deleted the copilot/improve-docs-on-firewall branch December 19, 2025 23:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants