golang/go

x/pkgsite: local setup - tracking issue

Aperta

#40.371 aperta il 23 lug 2020

 (24 commenti) (25 reazioni) (0 assegnatari)Go (19.008 fork)batch import
NeedsInvestigationhelp wantedpkgsitepkgsite/cmd

Metriche repository

Star
 (133.883 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

Today, users can run pkgsite locally without setting up a local database by running:

go run cmd/frontend/main.go -direct_proxy -proxy_url=<your proxy URL>

See flags in cmd/frontend/main.go, and doc/frontend.md for docs.

Doing so allows users to view the package documentation, overview, imports, and licenses tabs. Search and other tabs on the package page are not supported in direct proxy mode.

However, there are cases when a user might want to run pkgsite on their local machine, and be able to view a private repository that is not available via a proxy.

Tasks related to this topic:

Maybe:

  • only render documentation for packages / units when they are accessed

This is an umbrella issue to discuss what features are needed for this to happen, so please comment on your use cases below. For discussions about hosting a private instance of pkgsite, including your own internal proxy, see #39827.

Guida contributor