Skip to content

docs: document NGINX security headers in README #617

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wangyusheng1985 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: document NGINX security headers in README #617

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,17 @@ server {
}
```

Common HTTP security headers should usually be set at the reverse proxy (NGINX), not in Vouch Proxy itself. There are many such headers, each with subtle nuances, so [NGINX `add_header`](https://nginx.org/en/docs/http/ngx_http_headers_module.html) is the typical place to apply them on the Vouch host, for example:

```nginx
add_header Referrer-Policy "strict-origin-when-cross-origin" always;
add_header Strict-Transport-Security "max-age=31536000; includeSubDomains" always;
add_header X-Content-Type-Options "nosniff" always;
add_header X-Frame-Options "SAMEORIGIN" always;
```

Header choice is environment-specific. See the [OWASP HTTP Headers Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/HTTP_Headers_Cheat_Sheet.html) and [OWASP Secure Headers Project](https://owasp.org/www-project-secure-headers/) for guidance.

### Vouch Proxy "in a path"

As of `v0.33.0` Vouch Proxy can be served within an Nginx location (path) by configuring `vouch.document_root: /vp_in_a_path`
Expand Down