Skip to content

Explain the .NET / GenHTTP context and document ASP.NET Core hosting - #5

Merged
Kaliumhexacyanoferrat merged 1 commit into
mainfrom
docs/aspnet-core-readme
Oct 5, 2026
Merged

Kaliumhexacyanoferrat merged 1 commit into
mainfrom
docs/aspnet-core-readme

Conversation

@Kaliumhexacyanoferrat

Copy link
Copy Markdown
Owner

Summary

Readers who don't know GenHTTP couldn't tell from the readme that this is a C# / .NET library that plugs into a web server. This PR fixes that and documents how to use the module from ASP.NET Core.

  • README.md: new intro ("a C# library that turns your .NET application into a git server for your own data"), a How it fits in section explaining GenHTTP and the two hosting options, a from-scratch Getting Started (dotnet new console + packages) and a new Using ASP.NET Core section.
  • Module/README.md (NuGet readme): same intro and setup, plus a short ASP.NET Core section.
  • Docs site: new ASP.NET Core page (mapping, request size, multiple repositories, authentication), updated overview and getting started pages, links from Hosting, updated site description.

Kestrel request size

Kestrel rejects request bodies above 30 MB by default, while the module accepts pushes up to 128 MB. A 40 MB push failed with HTTP 413 until MaxRequestBodySize was raised, so all ASP.NET Core examples set it and the docs explain why.

Verification

Tested against GenHTTP.Adapters.AspNetCore 11.0.5 in a scratch app:

  • clone and push via app.Map("/repo", ...), including a 40 MB push with the raised Kestrel limit
  • multiple repositories via Repositories(...) (/git/name and /git/name.git, unknown names → not found)
  • BasicAuthentication concern on the builder (rejected without credentials, works with them)
  • mkdocs build --strict passes

🤖 Generated with Claude Code

Readers unfamiliar with GenHTTP could not tell that this is a C# library
that plugs into a web server. The readmes and the documentation now
introduce the package as a GenHTTP module, show how to set up a project
from scratch and describe how to map the handler into an ASP.NET Core
application via GenHTTP.Adapters.AspNetCore, including the Kestrel
request body limit that otherwise rejects pushes above 30 MB.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Kaliumhexacyanoferrat
Kaliumhexacyanoferrat merged commit 4e94fcc into main Oct 5, 2026
3 checks passed
@Kaliumhexacyanoferrat
Kaliumhexacyanoferrat deleted the docs/aspnet-core-readme branch October 5, 2026 08:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant