app

Documentation

Overview

Package app provides helpers for server applications interacting with Perkeep. See also https://perkeep.org/doc/app-environment for the related variables.

Index

• func Auth() (auth.AuthMode, error)
• func Client() (*client.Client, error)
• func ListenAddress() (string, error)
• func PathPrefix(r *http.Request) string

Functions

func Auth

func Auth() (auth.AuthMode, error)

Auth returns the auth mode for the app to access Perkeep, as defined by environment variables automatically supplied by the Perkeep server host.

func Client

func Client() (*client.Client, error)

Client returns a Perkeep client as defined by environment variables automatically supplied by the Perkeep server host.

func ListenAddress

func ListenAddress() (string, error)

ListenAddress returns the host:[port] network address, derived from the environment, that the application should listen on.

func PathPrefix

func PathPrefix(r *http.Request) string

PathPrefix returns the app's prefix on the app handler if the request was proxied through Perkeep, or "/" if the request went directly to the app.