README
¶
EiluneKit
Chinese: README_CN.md.
EiluneKit is a small Go toolkit for auth, HTTP services, Postgres, Redis, logging, and narrow runtime helpers. Import the packages you need; there is no central framework.
Installation
go get github.com/Ithildur/EiluneKit@latest
Requires Go 1.26.
Design
authowns transport-neutral login, refresh, logout, and session revocation.auth/httpadapts it tochi, cookies, and JSON.http/routeskeeps route metadata next to handlers.Routeis the data model;Blueprintis the recommended builder.http/staticmounts static files and SPA handlers from project-relative paths such asdistorweb/dist.
Usage
Start with the package docs:
http/routes/README.md: route declarations,Blueprint, and lower-levelRoute/Mountauth/http/README.md: auth endpoints and bearer middleware forchipostgres/README.md: GORM and pgx connection helpersredis/README.md: Redis client setup and TLS option
Package Layout
auth: transport-neutral auth service, credential interfaces, and static password helpersauth/http: auth handlers, bearer middleware, login rate limiting, and session revocation endpointsauth/jwt: access and refresh JWT issuance backed byauth/storeauth/session: cookie and CSRF helpersauth/store: session and token state stores for memory and Redishttp/decoder: JSON request decoding helpershttp/middleware: JSON-only guards, access logging, rate limits, and 404/405 helpershttp/response: JSON response helpershttp/routes: declarative route definitions and export helpershttp/static: static file and SPA mounting helperspostgres/dbtypes: thin database type aliasespostgres/gorm: Postgres DSN and*gorm.DBhelperspostgres/pgx: Postgres DSN and*pgxpool.Poolhelpersredis: Redis client helperslogging: slog-based logging helpersappdir: application home directory discoverycontextutil: context and timeout helpersclientip: client IP extraction helpers
Documentation
auth/http/README.mdauth/http/README_CN.mdhttp/routes/README.mdhttp/routes/README_CN.mdpostgres/README.mdpostgres/README_CN.mdredis/README.mdredis/README_CN.mdSECURITY.mdSECURITY_CN.md
Development
Run tests from the repository root:
go test ./...
License
MIT. See LICENSE.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package appdir discovers the application home directory.
|
Package appdir discovers the application home directory. |
|
Package auth provides transport-neutral authentication flows.
|
Package auth provides transport-neutral authentication flows. |
|
jwt
Package jwt provides JWT issuance and validation backed by user/session state.
|
Package jwt provides JWT issuance and validation backed by user/session state. |
|
session
Package session provides cookie helpers for auth flows.
|
Package session provides cookie helpers for auth flows. |
|
store
Package store defines auth session persistence used by auth/jwt.
|
Package store defines auth session persistence used by auth/jwt. |
|
Package clientip provides client IP helpers.
|
Package clientip provides client IP helpers. |
|
Package contextutil provides context helpers.
|
Package contextutil provides context helpers. |
|
http
|
|
|
middleware
Package middleware provides reusable HTTP middleware.
|
Package middleware provides reusable HTTP middleware. |
|
response
Package response provides JSON response helpers.
|
Package response provides JSON response helpers. |
|
routes
Package routes provides declarative route definitions and middleware composition.
|
Package routes provides declarative route definitions and middleware composition. |
|
static
Package static provides static file and SPA helpers.
|
Package static provides static file and SPA helpers. |
|
Package logging provides slog-based logging.
|
Package logging provides slog-based logging. |
|
postgres
|
|
|
dbtypes
Package dbtypes provides database type aliases to keep pq out of business imports.
|
Package dbtypes provides database type aliases to keep pq out of business imports. |
|
gorm
Package gorm provides GORM helpers for Postgres.
|
Package gorm provides GORM helpers for Postgres. |
|
internal/dsn
Package dsn builds Postgres DSNs.
|
Package dsn builds Postgres DSNs. |
|
pgx
Package pgx provides pgx pool helpers for Postgres.
|
Package pgx provides pgx pool helpers for Postgres. |
|
Package redis provides Redis client helpers.
|
Package redis provides Redis client helpers. |
Click to show internal directories.
Click to hide internal directories.