server/

README ¶

luci-go: LUCI in Go: server code

Installing servers

go get -u github.com/luci/luci-go/server/cmd/...

Code layout

/server/cmd/... contains the individual server executables, one per subdirectory.
/server/internal/... contains shared internal packages for use by other packages in this repository that are not meant to be used by other packages outside /server/.... See https://golang.org/s/go14internal for more details.
Anything else is APIs (reusable packages) that can be reused; mostly to be reused by /appengine/...

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
analytics Package analytics provides a standard way to store the Google Analytics tracking ID.	Package analytics provides a standard way to store the Google Analytics tracking ID.
auth Package auth implements authentication and authorization framework for HTTP servers.	Package auth implements authentication and authorization framework for HTTP servers.
authdb Package authdb contains definition of Authentication Database (aka AuthDB).	Package authdb contains definition of Authentication Database (aka AuthDB).
authtest Package authtest implements some interfaces used by auth package to simplify unit testing.	Package authtest implements some interfaces used by auth package to simplify unit testing.
delegation Package delegation contains low-level API for working with delegation tokens.	Package delegation contains low-level API for working with delegation tokens.
delegation/messages Package messages is a generated protocol buffer package.	Package messages is a generated protocol buffer package.
identity Package identity defines Identity type and related types and constants.	Package identity defines Identity type and related types and constants.
internal
openid Package openid implements OpenID Connect Login protocol (client side).	Package openid implements OpenID Connect Login protocol (client side).
service Package service implements a wrapper around API exposed by auth_service: https://github.com/luci/luci-py/tree/master/appengine/auth_service The main focus is AuthDB replication protocol used to propagate changes to database of groups.	Package service implements a wrapper around API exposed by auth_service: https://github.com/luci/luci-py/tree/master/appengine/auth_service The main focus is AuthDB replication protocol used to propagate changes to database of groups.
service/protocol Package protocol is a generated protocol buffer package.	Package protocol is a generated protocol buffer package.
signing Package signing provides interfaces to sign arbitrary small blobs with RSA-SHA256 signature (PKCS1v15) and verify such signatures.	Package signing provides interfaces to sign arbitrary small blobs with RSA-SHA256 signature (PKCS1v15) and verify such signatures.
signing/signingtest Package signingtest implements signing.Signer interface using fake keys.	Package signingtest implements signing.Signer interface using fake keys.
xsrf Package xsrf provides Cross Site Request Forgery prevention middleware.	Package xsrf provides Cross Site Request Forgery prevention middleware.
middleware Package middleware defines base type for context-aware HTTP request handler.	Package middleware defines base type for context-aware HTTP request handler.
router Package router provides an HTTP router with support for middleware and subrouters.	Package router provides an HTTP router with support for middleware and subrouters.
secrets Package secrets provides an interface for a simple secret store: you ask it for a secret (a byte blob, identifies by some key), and it returns it to you (current version, as well as a bunch of previous versions).	Package secrets provides an interface for a simple secret store: you ask it for a secret (a byte blob, identifies by some key), and it returns it to you (current version, as well as a bunch of previous versions).
testsecrets Package testsecrets provides a dumb in-memory secret store to use in unit tests.	Package testsecrets provides a dumb in-memory secret store to use in unit tests.
settings Package settings implements storage for infrequently changing global settings.	Package settings implements storage for infrequently changing global settings.
admin Package admin implements HTTP routes for settings UI.	Package admin implements HTTP routes for settings UI.
admin/internal/assets Package assets is generated by github.com/luci/luci-go/tools/cmd/assets.	Package assets is generated by github.com/luci/luci-go/tools/cmd/assets.
static
rpcexplorer/test
templates Package templates implements wrapper around html/template to provide lazy loading of templates and better integration with HTTP middleware framework.	Package templates implements wrapper around html/template to provide lazy loading of templates and better integration with HTTP middleware framework.
tokens Package tokens provides means to generate and validate base64 encoded tokens compatible with luci-py's components.auth implementation.	Package tokens provides means to generate and validate base64 encoded tokens compatible with luci-py's components.auth implementation.
warmup Package warmup allows to register hooks executed during the server warmup.	Package warmup allows to register hooks executed during the server warmup.