server

package

v0.1.1 Latest Latest Go to latest Published: Apr 1, 2026 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cocoonstack/epoch

Links

Open Source Insights

Documentation ¶

Overview ¶

OIDC authentication for the Epoch web UI and control plane API.

Protected: / (UI), /api/* (control plane) Unprotected: /v2/* (OCI registry — machine clients), /healthz

Flow:

Browser hits protected route → no session cookie → redirect /login
/login → redirect to the configured authorize endpoint
/login/callback → exchange code for token → set session cookie
/logout → clear cookie → redirect to provider logout when configured

Config via environment variables:

SSO_PROVIDER=google|oidc
For generic OIDC:
  SSO_CLIENT_ID, SSO_CLIENT_SECRET, SSO_REDIRECT_URI
  SSO_AUTHORIZE_URL, SSO_TOKEN_URL, SSO_USERINFO_URL, SSO_LOGOUT_URL
For Google:
  GOOGLE_OAUTH_CLIENT_ID, GOOGLE_OAUTH_CLIENT_SECRET, GOOGLE_OAUTH_REDIRECT_URI
  GOOGLE_OAUTH_HOSTED_DOMAIN (optional)
SSO_COOKIE_SECRET (32-byte hex key for HMAC signing; auto-generated if empty)

Package server implements the Epoch HTTP server.

It serves two APIs:

/v2/ — OCI Distribution-shaped push/pull protocol (manifests + blob streaming via object storage)
/api/ — Control plane API backed by MySQL

Static frontend files are embedded and served at /.

Index ¶

type SSOConfig
- func LoadSSOConfig() *SSOConfig
type Server
- func New(reg *registry.Registry, st *store.Store, addr string) *Server
- func (s *Server) ListenAndServe() error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type SSOConfig ¶

type SSOConfig struct {
	Provider     string
	ClientID     string
	ClientSecret string
	RedirectURI  string
	AuthorizeURL string
	TokenURL     string
	UserInfoURL  string
	LogoutURL    string
	Scopes       string
	HostedDomain string
	CookieSecret []byte
}

SSOConfig holds optional UI auth settings loaded from the environment.

func LoadSSOConfig ¶

func LoadSSOConfig() *SSOConfig

LoadSSOConfig reads optional UI auth configuration from the environment.

type Server ¶

type Server struct {
	// contains filtered or unexported fields
}

Server is the Epoch HTTP server.

func New ¶

func New(reg *registry.Registry, st *store.Store, addr string) *Server

New creates a new server.

func (*Server) ListenAndServe ¶

func (s *Server) ListenAndServe() error

ListenAndServe starts the server with initial sync and background sync.

Source Files ¶

View all Source files

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