caddy-security-docs

Documentation for Caddy v2 Security Plugin.

Documentation Website: https://docs.authcrunch.com/

Table of Contents

• Local Testing
• Deployment
• Miscellaneous

Local Testing

If necessary, upgrade packages:

npm run upgrade

Check Markdown files:

npx docusaurus-mdx-checker

Run a build:

npm run build

Run the website locally on port 4200:

npx docusaurus start --port 4200 --host 0.0.0.0

Deployment

Run build to create search index:

npm run build

Deploy to gh-pages branch:

GIT_USER=greenpau DEPLOYMENT_BRANCH=gh-pages USE_SSH=true npm run deploy

Miscellaneous

Reformat Caddyfile configs:

for f in `find ./assets -type f -name 'Caddyfile'`; do ../../greenpau/caddy-security/bin/caddy fmt --overwrite $f; done