x/pkgsite: self hosting - tracking issue

[marwan-at-work]

This is an umbrella issue that tracks all the possible blockers for having users self host the pkgsite codebase.

Issues:

• Make LICENSE detection optional in pkgsite codebase: x/pkgsite: make LICENSE detection optional in pkgsite codebase (not in pkg.go.dev) #39602
• Write self-hosting specific documentation: i.e. deployment steps, things to be aware of, etc.
  • Local quickstart docs. Running a local pkgsite with the bare minimum should be easy for any experienced Go developer.
  • Clarification of what features/requirements are needed or can be switched off for a local setup, e.g. GOPROXY or a search "engine".
• x/pkgsite: Remove hardcoded references to pkg.go.dev #48603
• Using a custom HTTPS proxy for the private git repositories.
• Using a proxy that acts as a gateway to the internet.
• x/pkgsite: Excluding private packages from external site lookups #55106

Please feel free to edit this issue to add/remove issues above.

[mvdan]

Two additions from what I've seen:

• Local quickstart docs. Running a local pkgsite with the bare minimum should be easy for any experienced Go developer.
• Clarification of what features/requirements are needed or can be switched off for a local setup, e.g. GOPROXY or a search "engine".

[julieqiu]

I opened #40371 to discuss issues related to running pkgsite locally. Let's use this issue to discuss self-hosting via a private GOPROXY.

[MicahParks]

I have a project that addresses the following use cases:

• Turning off license respecting, allowing the docs to be generated for projects with non-permissive licenses.
• Using a custom HTTPS proxy for the private git repositories.
• Using a proxy that acts as a gateway to the internet.

There is some documentation for these use cases in the project itself.

GitLab project
GitHub mirror

[myitcv]

Posting on behalf of @theckman via Slack

pkgsite is being proposed as part of the solution for the discoverability of new major module versions. This presents a challenge for groups that are using private repositories via a SaaS SCM without the means to run a shared module proxy or pkgsite.

[ryancurrah]

Looking forward to simplifying the deployability of the pkg site.