gamertan
206d09e4cd
verify / verify (push) Successful in 2m58s
Sanitized snapshot of private source 144ca0a9544042b0477ae732c1356cf0b9d62b3f. Add package selection, adoption workflow, and optional Sandwich Hime integration guidance. AI-Assistance: OpenAI Codex assisted documentation, verification, and publication. Signed-off-by: Cole Speelman <crspeelman@gmail.com>
100 lines
4.1 KiB
Markdown
100 lines
4.1 KiB
Markdown
<!-- SPDX-License-Identifier: MPL-2.0 -->
|
|
|
|
# Gamertan Web Foundations
|
|
|
|
> Status: `v0.1.0-preview.1` public preview. APIs may change before a stable
|
|
> release; Linux is the maintained release platform.
|
|
|
|
Small, composable Go packages for the unglamorous boundaries of a careful web
|
|
application: request identity, structured request logs, browser security,
|
|
passwords and sessions, permissions, SQLite persistence, and private analytics.
|
|
|
|
This is a toolkit, not an application framework. Your application keeps its
|
|
router, HTTP policy, HTML, authorization decisions, cache behavior, and
|
|
deployment. Each package works with `net/http` and can be adopted independently.
|
|
|
|
The first preview targets modest Linux servers, local files, SQLite, and normal
|
|
Go binaries. It requires no Redis, message broker, hosted identity provider,
|
|
telemetry service, or JavaScript framework.
|
|
|
|
## Install
|
|
|
|
Pin the preview in an application module, then import only the packages that
|
|
application needs:
|
|
|
|
```bash
|
|
go get gamertan.com/web@v0.1.0-preview.1
|
|
go mod verify
|
|
```
|
|
|
|
An application may also name the first package it intends to adopt:
|
|
|
|
```bash
|
|
go get gamertan.com/web/requestmeta@v0.1.0-preview.1
|
|
```
|
|
|
|
The version belongs to the `gamertan.com/web` module. Go compiles and links
|
|
only the packages the application imports. See the [getting-started guide](docs/GETTING_STARTED.md)
|
|
and [module-boundary policy](docs/MODULES.md) before choosing a first slice.
|
|
|
|
Canonical source, issues, security policy, and release notes live on
|
|
[Gamertan Gitea](https://gitea.speelman.ca/gamertan/web). GitHub is a read-only
|
|
discovery snapshot rather than a second release origin.
|
|
|
|
Linux is the required and supported release platform. WSL may be used as a
|
|
Linux development environment. Native Windows is not a release gate or support
|
|
promise; downstream users may evaluate the ordinary Go packages elsewhere
|
|
without turning that portability into a maintained compatibility claim.
|
|
|
|
## Packages
|
|
|
|
- [`requestmeta`](requestmeta): trusted-proxy resolution, HTTPS/origin metadata,
|
|
and request IDs.
|
|
- [`requestlog`](requestlog): bounded versioned records, middleware, sinks, and
|
|
private JSONL.
|
|
- [`websec`](websec): headers, origin checks, CSRF, redirects, body limits, and
|
|
rate limits.
|
|
- [`abuse`](abuse): application-classified request abuse with pluggable persistence.
|
|
- [`auth`](auth), [`authhttp`](authhttp), and [`authsqlite`](authsqlite):
|
|
passwords, sessions, permissions, cookies,
|
|
and a no-CGO SQLite adapter.
|
|
- [`analytics`](analytics): safe and sensitive aggregate projections over request
|
|
records.
|
|
|
|
The copyable starter under `starters/basic` demonstrates the packages without
|
|
turning them into a router or template system.
|
|
|
|
## HTML and templates
|
|
|
|
Web Foundations deliberately does not provide a template language. Sandwich
|
|
Hime is the preferred companion for Gamertan applications that want HTML-first,
|
|
typed, ahead-of-time Go templates. The two projects remain independently
|
|
usable: this module does not import the `sando` runtime, and Sandwich Hime does
|
|
not own middleware, authentication, logging, routing, or deployment.
|
|
|
|
See [HTML with Sandwich Hime](docs/SANDWICH_HIME.md), then follow the official
|
|
[first site tutorial](https://sandwichhime.com/docs/tutorial/) and
|
|
[application integration tutorial](https://sandwichhime.com/docs/tutorial/application/).
|
|
|
|
## Security boundary
|
|
|
|
Client addresses are accepted from forwarding headers only when the immediate
|
|
peer and every skipped proxy are explicitly trusted. Sensitive request fields
|
|
are off by default. Cryptographic entropy failures fail closed. Logs and account
|
|
databases remain private application data and never belong in source releases.
|
|
|
|
See [SECURITY.md](SECURITY.md), [docs/THREAT_MODEL.md](docs/THREAT_MODEL.md),
|
|
the [application adoption contract](docs/ADOPTION.md), and
|
|
[docs/SERVICES_ROADMAP.md](docs/SERVICES_ROADMAP.md).
|
|
|
|
## Licensing
|
|
|
|
This is a multi-license repository with exact file-level SPDX identifiers:
|
|
|
|
- embeddable packages and adapters: MPL-2.0;
|
|
- future standalone network services and operational machinery: AGPL-3.0-only;
|
|
- starters, examples, and reusable configuration: 0BSD.
|
|
|
|
See [LICENSES.md](LICENSES.md). No standalone auth or logging server is included
|
|
in this preview.
|