Skip to content

Latest commit

 

History

History
40 lines (33 loc) · 1.73 KB

README.md

File metadata and controls

40 lines (33 loc) · 1.73 KB

Private pkgsite

Host the open source pkg.go.dev site, also known as pkgsite, internally on a private network and allow for the displaying of projects with non open source licenses. This site helps display Go (golang) documentation with support for Go modules.

This project has four directories representing use cases. They are somewhat intuitively named and contain a subset of the set of features this project offers.

Please view the directory most closley matching your use case for a README.md with instructions.

Features of directories with stubs inside:

customCertAndInternalProxy

  • Ability to read project repositories with non-permissive licences.
  • Private GitLab with custom HTTPS certificate.
  • Private network with gateway HTTP proxy.

customCert

  • Ability to read project repositories with non-permissive licences.
  • Private GitLab with custom HTTPS certificate.
  • Private network with gateway HTTP proxy.

InternalProxy

  • Ability to read project repositories with non-permissive licences.
  • Private GitLab with custom HTTPS certificate.
  • Private network with gateway HTTP proxy.

justLicense

  • Ability to read project repositories with non-permissive licences.
  • Private GitLab with custom HTTPS certificate.
  • Private network with gateway HTTP proxy.

License

Please note that this repository is under the MIT license, but the pkgsite project has its own version of a permissive license. Additionally, the athens project is under the MIT license, but has dependencies with other licences. athens is used as a replacement for proxy.golang.org.