GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - owasp-modsecurity/documentation: ModSecurity documentation

BranchesTags
Open more actions menu

Latest commit

 

History

23 Commits
23 Commits

Folders and files

NameName
Last commit message
Last commit date
.github
.github
 
 
config/_default
config/_default
 
 
content
content
 
 
docs/superpowers/specs
docs/superpowers/specs
 
 
layouts
layouts
 
 
tools
tools
 
 
.editorconfig
.editorconfig
 
 
.gitignore
.gitignore
 
 
CLAUDE.md
CLAUDE.md
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
go.mod
go.mod
 
 
go.sum
go.sum
 
 
lychee.toml
lychee.toml
 
 
renovate.json
renovate.json
 
 

Repository files navigation

ModSecurity Documentation

Source for the OWASP ModSecurity documentation site, built with Hugo and the Relearn theme. It replaces the former GitHub wiki.

Building locally

Requires Hugo extended >= 0.145 and Go (the theme is a Hugo module, fetched on first build).

git clone https://github.com/owasp-modsecurity/documentation.git
cd documentation
hugo serve

The theme version is pinned in go.mod; Renovate opens PRs to bump it. To upgrade by hand: hugo mod get -u github.com/McShelby/hugo-theme-relearn && hugo mod tidy.

Then open http://localhost:1313/documentation/.

Layout

  • content/ — all pages, in numbered chapter directories (1-introduction, 2-installation, …).
  • layouts/shortcodes/secmeta.html — metadata table used by every reference-manual entry.
  • config/_default/hugo.toml — site config (theme module import, params); modsec_v2_latest, modsec_v3_latest and modsec_nginx_latest are kept current by Renovate (renovate.json) and referenced from content with {{< param modsec_v3_latest >}}.
  • tools/migrate-wiki.py — the one-off converter from the old wiki, kept for reference. The content was hand-edited after conversion, so it refuses to run without --force.

About

ModSecurity documentation

Resources

Readme
Apache-2.0 license
Activity
Custom properties

Stars

1 star

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.