Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Environment (please complete the following information):**
- OS: [e.g. Windows 10, Windows 11]
- PowerShell Version: [e.g. 5.1, 7.2]
- GW Router Logger Version: [e.g. v1.3.4]

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
26 changes: 26 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
## Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

## Type of change
Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

## How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.

- [ ] Manual test in Windows environment (PowerShell 5.1+)
- [ ] Installer/Uninstaller verification
- [ ] Tray App functionality test

## Checklist:
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
75 changes: 75 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Contributing to GW Router Logger

First off, thank you for considering contributing to GW Router Logger! It's people like you that make it a great tool.

## Where do I go from here?

If you've noticed a bug or have a feature request, make sure to check our Issues to see if someone else has already created one. If not, go ahead and make one!

## Fork & create a branch

If this is something you think you can fix, then fork GW Router Logger and create a branch with a descriptive name.

A good branch name would be (where issue #325 is the ticket you're working on):

```sh
# git checkout -b 325-add-new-feature
```

## Get the test suite running

This project consists of PowerShell scripts. Currently, there is no automated test suite. Please test your changes manually in a local Windows environment with PowerShell 5.1+ to ensure they do not break existing functionality. Verify that the installer, uninstaller, CLI script, and tray application all function as expected.

## Implement your fix or feature

At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first.

## Make a Pull Request

At this point, you should switch back to your main branch and make sure it's up to date with GW Router Logger's main branch. Then update your feature branch from your local copy of main, and push it!

Finally, go to GitHub and make a Pull Request :D

## Keeping your Pull Request updated

If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.

## Code of Conduct

Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,30 @@
# GW Router Logger

[![PowerShell Version](https://img.shields.io/badge/PowerShell-5.1+-blue.svg)](https://microsoft.com/PowerShell)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

`GW Router Logger` is a PowerShell syslog collector for Windows, designed for home labs, residential routers, and small-network troubleshooting.

Current release: `v1.3.4`

It focuses on the things that usually break first on normal Windows machines: elevation, pathing, firewall access, bind-address selection, log rollover, and clear on-screen status.

## Table of Contents
- [Why this exists](#why-this-exists)
- [Highlights](#highlights)
- [Requirements](#requirements)
- [Quick Start](#quick-start)
- [Install](#install)
- [CLI script](#cli-script)
- [Default behavior](#default-behavior)
- [Log layout](#log-layout)
- [Runtime controls](#runtime-controls)
- [Project goals](#project-goals)
- [Support and Troubleshooting](#support-and-troubleshooting)
- [Contributing](#contributing)
- [Notes](#notes)
- [License](#license)

## Why this exists

A lot of router logging tools assume too much:
Expand Down Expand Up @@ -141,6 +160,18 @@ While the listener is running:
- Prefer validation and fallback behavior over hidden assumptions
- Be useful as a practical router logging tool, not just a demo

## Support and Troubleshooting

If you encounter issues while using `GW Router Logger`, please refer to the following:
- Ensure you are running PowerShell as Administrator.
- Verify your router is configured to send syslog to the IP address displayed in the application.
- Check Windows Firewall settings to ensure the necessary ports (default UDP 514) are open.
- If you find a bug or need help, please [open an issue](https://github.com/Ghostwheel/GW-Router-Logger/issues).

## Contributing

We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on how to report bugs, request features, and submit pull requests. Ensure you also review our [Code of Conduct](CODE_OF_CONDUCT.md).

## Notes

- The script is intentionally PowerShell-first and Windows-focused.
Expand Down
20 changes: 20 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Security Policy

## Supported Versions

The following versions of GW Router Logger are currently being supported with security updates.

| Version | Supported |
| ------- | ------------------ |
| v1.3.x | :white_check_mark: |
| < v1.3 | :x: |

## Reporting a Vulnerability

If you discover a security vulnerability within this project, please follow these steps:

1. **Do not open a public issue.** This is to protect users from potential exploitation before a fix is available.
2. Please report it directly by emailing the maintainer(s) (or open a private security advisory on GitHub if enabled).

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Provide a concrete private security contact

When private vulnerability reporting is not enabled for the GitHub repository, this instruction leaves reporters with no actionable private channel because no maintainer email or contact link is provided anywhere else in the repo. Since the previous step explicitly tells them not to open a public issue, a security reporter can get stuck instead of disclosing privately; please replace the placeholder wording with a real email/contact URL or a definitive private advisory link.

Useful? React with 👍 / 👎.

3. Provide a detailed description of the issue, including the steps to reproduce the vulnerability.

We will acknowledge receipt of your vulnerability report and strive to address the issue in a timely manner. We will notify you when a fix is implemented and coordinate public disclosure.