Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

x/pkgsite: self hosting - tracking issue #39827

Open
1 of 2 tasks
marwan-at-work opened this issue Jun 24, 2020 · 9 comments
Open
1 of 2 tasks

x/pkgsite: self hosting - tracking issue #39827

marwan-at-work opened this issue Jun 24, 2020 · 9 comments
Labels
FeatureRequest NeedsInvestigation pkgsite

Comments

@marwan-at-work
Copy link
Contributor

@marwan-at-work marwan-at-work commented Jun 24, 2020

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: #39602
  • Write self-hosting specific documentation: i.e. deployment steps, things to be aware of, etc.

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

@gopherbot gopherbot added this to the Unreleased milestone Jun 24, 2020
@julieqiu julieqiu changed the title x/pkgsite: Self Hosting Tracking Issue x/pkgsite: self hosting - tracking issue Jun 24, 2020
@julieqiu julieqiu added NeedsInvestigation FeatureRequest labels Jun 24, 2020
@mvdan
Copy link
Member

@mvdan mvdan commented Jul 23, 2020

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
Copy link
Contributor

@julieqiu julieqiu commented Jul 23, 2020

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
Copy link

@MicahParks MicahParks commented Aug 1, 2020

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

@julieqiu julieqiu removed this from the Unreleased milestone Aug 27, 2020
@julieqiu julieqiu added this to the pkgsite/unreleased milestone Aug 27, 2020
@myitcv
Copy link
Member

@myitcv myitcv commented Sep 16, 2020

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
Copy link

@ryancurrah ryancurrah commented Sep 18, 2020

Looking forward to simplifying the deployability of the pkg site.

@julieqiu julieqiu removed the website label Sep 19, 2020
@l0nax
Copy link

@l0nax l0nax commented Nov 13, 2020

Any updates on this?

@kevinburke
Copy link
Contributor

@kevinburke kevinburke commented Dec 16, 2021

Just to be clear, with godoc, you could dynamically load anything on the filesystem as long as it was present in $GOPATH/src/path/to/blah, and now you need to specify every package you want to load when you start the new binary?

@sfllaw
Copy link
Contributor

@sfllaw sfllaw commented Dec 17, 2021

Just to be clear, with godoc, you could dynamically load anything on the filesystem as long as it was present in $GOPATH/src/path/to/blah, and now you need to specify every package you want to load when you start the new binary?

pkgsite only serves things in its database, which it populates whenever you make a query for a package that it doesn't know about yet.

In addition, when I set it up for the first time, I go run ./devtools/cmd/seeddb in order to load the default set of packages, which includes the Go standard library, as specified in seed.txt.

Actually, I also put it our private repositories in seed.txt as well, but you don't have to do that.

@plo-
Copy link

@plo- plo- commented Apr 14, 2022

I read the doc I found as well as some issues like #50229 but I'm still not sure how to properly run pkgsite for internal use.

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

@julieqiu Is using a private GOPROXY the correct way to run pkgsite locally? So far, I run an instance of it using command like pkgsite <path1> <path2> <pathX> but it's kind of broken, functionalities like the "search", the "importedby" or even the "versions" (to select what version of a package is displayed) don't work at all.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FeatureRequest NeedsInvestigation pkgsite
Projects
None yet
Development

No branches or pull requests