h/golib
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated documentation for JWT, HWS, and HWSAuth packages.

Browse Source 
- Updated JWT README.md with proper format and version number
- Updated HWS README.md and created comprehensive doc.go
- Updated HWSAuth README.md and doc.go with proper environment variable documentation
- All documentation now follows GOLIB rules format

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
Haelnorr
2026-01-13 13:37:37 +11:00
parent 52341aba56
commit bdae21ec0b
5 changed files with 217 additions and 99 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
hwsauth/doc.go
View File

@@ -179,18 +179,18 @@
//
// # Environment Variables
//
// The following environment variables are supported:
// The following environment variables are supported when using ConfigFromEnv:
//
// - HWSAUTH_SSL: Enable SSL mode (default: false)
// - HWSAUTH_TRUSTED_HOST: Trusted host for SSL (required if SSL is true)
// - HWSAUTH_SECRET_KEY: Secret key for signing tokens (required)
// - HWSAUTH_SSL: Enable SSL secure cookies (default: false)
// - HWSAUTH_TRUSTED_HOST: Full server address for SSL (required if SSL is true)
// - HWSAUTH_SECRET_KEY: Secret key for signing JWT tokens (required)
// - HWSAUTH_ACCESS_TOKEN_EXPIRY: Access token expiry in minutes (default: 5)
// - HWSAUTH_REFRESH_TOKEN_EXPIRY: Refresh token expiry in minutes (default: 1440)
// - HWSAUTH_TOKEN_FRESH_TIME: Token fresh time in minutes (default: 5)
// - HWSAUTH_LANDING_PAGE: Landing page for logged in users (default: "/profile")
// - HWSAUTH_JWT_TABLE_NAME: Custom JWT table name (optional)
// - HWSAUTH_DATABASE_TYPE: Database type (e.g., "postgres", "mysql")
// - HWSAUTH_DATABASE_VERSION: Database version (e.g., "15")
// - HWSAUTH_LANDING_PAGE: Redirect destination for authenticated users (default: "/profile")
// - HWSAUTH_DATABASE_TYPE: Database type - postgres, mysql, sqlite, mariadb (default: "postgres")
// - HWSAUTH_DATABASE_VERSION: Database version string (default: "15")
// - HWSAUTH_JWT_TABLE_NAME: Custom JWT blacklist table name (default: "jwtblacklist")
//
// # Security Considerations
//