mirror of
https://github.com/Yamato-Security/WELA.git
synced 2026-07-19 15:23:38 +02:00
docs: add Material for MkDocs documentation site (English + Japanese)
Add a documentation website under website/, built from README.md and README-Japanese.md and laid out with top-tab topics and a left sidebar (same style as the Hayabusa docs). Designed to be hosted free on GitHub Pages. - Pages: Overview (About, Features, Screenshots), Getting Started, Commands (Command List, Command Usage), Resources (Companion Projects, Other Resources, Changelog, Contributing) - Custom landing page, theme, click-to-zoom screenshots - Changelog synced from CHANGELOG.md at build time - 15-language switcher via mkdocs-static-i18n: English + Japanese full content; the other 13 localize the UI and fall back to English until translated - .github/workflows/docs.yml builds (mkdocs --strict) + deploys to GitHub Pages Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
Shirofune-Security
co-authored by
Claude Opus 4.8
Claude Opus 4.8
parent
afe91eea3b
commit
a95f0f5eec
@@ -0,0 +1,31 @@
|
||||
# 変更履歴
|
||||
|
||||
!!! info "情報"
|
||||
このページはプロジェクトの [`CHANGELOG.md`](https://github.com/Yamato-Security/WELA/blob/main/CHANGELOG-Japanese.md) を反映したものです。ダウンロードは [リリースページ](https://github.com/Yamato-Security/WELA/releases) をご覧ください。
|
||||
|
||||
## 2.1.0 [2026/02/13] - Winter Release
|
||||
|
||||
**バグ修正:**
|
||||
|
||||
- 設定によりドメインコントローラのNetlogonが破損する可能性があった。 (#243) (@fukusuket) (この件を報告してくれた@feiglein74に感謝!)
|
||||
|
||||
## 2.0.0 [2025/11/16] - CODE BLUE リリース
|
||||
|
||||
**新機能:**
|
||||
|
||||
- MITRE ATT&CK Navigatorヒートマップに対応した。 (#11) (@fukusuket)
|
||||
- Windows設定を様々なベースラインに構成するための`configure`コマンドを追加した。 (#12) (@fukusuket)
|
||||
- Defender for Identityの必要なログに対応した。 (#114) (@fukusuket)
|
||||
|
||||
**バグ修正:**
|
||||
|
||||
- ルールカウントの一部が正確ではなかった。 (#99) (@fukusuket)
|
||||
- タスクスケジューラのログ設定が正確に報告されていなかった。 (#100 (@fukusuket))
|
||||
|
||||
## 1.0.0 [2025/05/20] - AUSCERT/SINCON リリース
|
||||
|
||||
**新機能:**
|
||||
|
||||
- `audit-settings`: Windows Event Log audit policy settingsをチェックする
|
||||
- `audit-filesize`: Windows Event Logファイルサイズをチェックする
|
||||
- `update-rules`: WELAのSigmaルール設定ファイルを更新する
|
||||
@@ -0,0 +1,31 @@
|
||||
# Changelog
|
||||
|
||||
!!! info
|
||||
This page mirrors the project [`CHANGELOG.md`](https://github.com/Yamato-Security/WELA/blob/main/CHANGELOG.md). See the [Releases page](https://github.com/Yamato-Security/WELA/releases) for downloads.
|
||||
|
||||
## 2.1.0 [2026/02/13] - Winter Release
|
||||
|
||||
**Bug Fixes:**
|
||||
|
||||
- Configuration might break Netlogon on Domain Controllers. (#243) (@fukusuket) (Thanks to @feiglein74 for reporting this!)
|
||||
|
||||
## 2.0.0 [2025/11/16] - CODE BLUE Release
|
||||
|
||||
**New Features:**
|
||||
|
||||
- Support for MITRE ATT&CK Navigator heatmaps. (#11) (@fukusuket)
|
||||
- Added a `configure` command to configure Windows settings to various baselines. (#12) (@fukusuket)
|
||||
- Support for Defender for Identity required logs. (#114) (@fukusuket)
|
||||
|
||||
**Bug Fixes:**
|
||||
|
||||
- Some of the rule count was not accurate. (#99) (@fukusuket)
|
||||
- TaskScheduler log settings were not accurately reported. (#100) (@fukusuket))
|
||||
|
||||
## 1.0.0 [2025/05/20] - AUSCERT/SINCON Release
|
||||
|
||||
**New Features:**
|
||||
|
||||
- `audit-settings`: Check Windows Event Log audit policy settings.
|
||||
- `audit-filesize`: Check Windows Event Log file size.
|
||||
- `update-rules`: Update WELA's Sigma rules config files.
|
||||
@@ -0,0 +1,5 @@
|
||||
# 関連プロジェクト
|
||||
|
||||
* [EnableWindowsLogSettings](https://github.com/Yamato-Security/EnableWindowsLogSettings) Yamato SecurityのWindowsイベントログ設定ガイド
|
||||
* [EventLog-Baseline-Guide](https://github.com/Yamato-Security/EventLog-Baseline-Guide) Sigmaルールと主要なガイドにおける検知ギャップを可視化するツール
|
||||
* [WELA-RulesGenerator](https://github.com/Yamato-Security/WELA-RulesGenerator) WELAのSigmaルール関連設定ファイルを生成するためのツール
|
||||
@@ -0,0 +1,5 @@
|
||||
# Companion Projects
|
||||
|
||||
* [EnableWindowsLogSettings](https://github.com/Yamato-Security/EnableWindowsLogSettings): Yamato Security's Windows Event Log Configuration Guide.
|
||||
* [EventLog-Baseline-Guide](https://github.com/Yamato-Security/EventLog-Baseline-Guide): A tool to visualize detection gaps in Sigma rules and major guides.
|
||||
* [WELA-RulesGenerator](https://github.com/Yamato-Security/WELA-RulesGenerator): A tool for generating WELA's Sigma rule-related config files.
|
||||
@@ -0,0 +1,30 @@
|
||||
# 貢献とサポート
|
||||
|
||||
## 貢献
|
||||
|
||||
わたしたちは、どんな形でも貢献を歓迎します。
|
||||
プルリクエスト、ルール作成、サンプルログの提供が最も歓迎されますが、バグの報告や機能リクエストなども大歓迎です。
|
||||
|
||||
少なくとも、**私たちのツールやリソースが気に入ったら、GitHubでスターをつけて応援してください！**
|
||||
|
||||
## 不具合の報告
|
||||
|
||||
* 不具合の報告は、[こちら](https://github.com/Yamato-Security/wela/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5Bbug%5D)からお願いします。
|
||||
* このプロジェクトは現在も積極的にメンテナンスされており、バグの報告や機能のリクエストは大歓迎です。
|
||||
|
||||
## ライセンス
|
||||
|
||||
* WELAは、[MITライセンス](https://opensource.org/licenses/MIT)のもとでリリースされています。
|
||||
|
||||
## 貢献者
|
||||
|
||||
* Fukusuke Takahashi (コア開発者)
|
||||
* Zach Mathis (プロジェクトリーダー, ツールデザイン, テスト, など...) (@yamatosecurity)
|
||||
|
||||
## 謝辞
|
||||
|
||||
* [Australian Cyber Security Centre: Windows event logging and forwarding](https://www.cyber.gov.au/resources-business-and-government/maintaining-devices-and-systems/system-hardening-and-administration/system-monitoring/windows-event-logging-and-forwarding)
|
||||
* [Microsoft: Advanced security auditing FAQ](https://learn.microsoft.com/en-us/previous-versions/windows/it-pro/windows-10/security/threat-protection/auditing/advanced-security-auditing-faq)
|
||||
* [SigmaHQ](https://github.com/SigmaHQ/sigma)
|
||||
|
||||
## X
|
||||
@@ -0,0 +1,30 @@
|
||||
# Contributing & Support
|
||||
|
||||
## Contributions
|
||||
|
||||
We would love any form of contribution.
|
||||
Pull requests are the best, but feature requests notifying us of bugs, etc... through issues are also very welcome.
|
||||
|
||||
At the least, **if you like our tools and resources, then please give us a star on GitHub and show your support!**
|
||||
|
||||
## Bug Submission
|
||||
|
||||
* Please submit any bugs you find [here.](https://github.com/Yamato-Security/wela/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5Bbug%5D)
|
||||
* This project is currently actively maintained, and we are happy to fix any bugs reported.
|
||||
|
||||
## License
|
||||
|
||||
* WELA is released under the [MIT License](https://opensource.org/licenses/MIT).
|
||||
|
||||
## Contributors
|
||||
|
||||
* Fukusuke Takahashi (core developer)
|
||||
* Zach Mathis (project leader, tool design, testing, etc...) (@yamatosecurity)
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
* [Australian Cyber Security Centre: Windows event logging and forwarding](https://www.cyber.gov.au/resources-business-and-government/maintaining-devices-and-systems/system-hardening-and-administration/system-monitoring/windows-event-logging-and-forwarding)
|
||||
* [Microsoft: Advanced security auditing FAQ](https://learn.microsoft.com/en-us/previous-versions/windows/it-pro/windows-10/security/threat-protection/auditing/advanced-security-auditing-faq)
|
||||
* [SigmaHQ](https://github.com/SigmaHQ/sigma)
|
||||
|
||||
## Twitter
|
||||
@@ -0,0 +1,9 @@
|
||||
# Windowsイベントログの監査設定に関するその他の参考資料
|
||||
|
||||
* [A Data-Driven Approach to Windows Advanced Audit Policy – What to Enable and Why](https://www.splunk.com/en_us/blog/security/windows-audit-policy-guide.html)
|
||||
* [Audit Policy Recommendations](https://learn.microsoft.com/en-us/windows-server/identity/ad-ds/plan/security-best-practices/audit-policy-recommendations)
|
||||
* [Configure audit policies for Windows event logs](https://learn.microsoft.com/en-us/defender-for-identity/deploy/configure-windows-event-collection)
|
||||
* [EnableWindowsLogSettings](https://github.com/Yamato-Security/EnableWindowsLogSettings)
|
||||
* [Windows event logging and forwarding](https://www.cyber.gov.au/resources-business-and-government/maintaining-devices-and-systems/system-hardening-and-administration/system-monitoring/windows-event-logging-and-forwarding)
|
||||
* [mdecrevoisier/Windows-auditing-baseline](https://github.com/mdecrevoisier/Windows-auditing-baseline)
|
||||
* [palantir/windows-event-forwarding](https://github.com/palantir/windows-event-forwarding/tree/master/group-policy-objects)
|
||||
@@ -0,0 +1,9 @@
|
||||
# Other Windows Event Log Audit Settings Related Resources
|
||||
|
||||
* [A Data-Driven Approach to Windows Advanced Audit Policy – What to Enable and Why](https://www.splunk.com/en_us/blog/security/windows-audit-policy-guide.html)
|
||||
* [Audit Policy Recommendations](https://learn.microsoft.com/en-us/windows-server/identity/ad-ds/plan/security-best-practices/audit-policy-recommendations)
|
||||
* [Configure audit policies for Windows event logs](https://learn.microsoft.com/en-us/defender-for-identity/deploy/configure-windows-event-collection)
|
||||
* [EnableWindowsLogSettings](https://github.com/Yamato-Security/EnableWindowsLogSettings)
|
||||
* [Windows event logging and forwarding](https://www.cyber.gov.au/resources-business-and-government/maintaining-devices-and-systems/system-hardening-and-administration/system-monitoring/windows-event-logging-and-forwarding)
|
||||
* [mdecrevoisier/Windows-auditing-baseline](https://github.com/mdecrevoisier/Windows-auditing-baseline)
|
||||
* [palantir/windows-event-forwarding](https://github.com/palantir/windows-event-forwarding/tree/master/group-policy-objects)
|
||||
Reference in New Issue
Block a user