Documentation
¶
Overview ¶
Package web Cozy Stack API.
Cozy is a personal platform as a service with a focus on data.
Index ¶
- func CreateSubdomainProxy(router *echo.Echo, serveApps echo.HandlerFunc) (*echo.Echo, error)
- func ListenAndServe() error
- func SetupAdminRoutes(router *echo.Echo) error
- func SetupAppsHandler(appsHandler echo.HandlerFunc) echo.HandlerFunc
- func SetupAssets(router *echo.Echo, assetsPath string) error
- func SetupRoutes(router *echo.Echo) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateSubdomainProxy ¶
CreateSubdomainProxy returns a new web server that will handle that apps proxy routing if the host of the request match an application, and route to the given router otherwise.
func ListenAndServe ¶
func ListenAndServe() error
ListenAndServe creates and setups all the necessary http endpoints and start them.
func SetupAdminRoutes ¶
SetupAdminRoutes sets the routing for the administration HTTP endpoints
func SetupAppsHandler ¶
func SetupAppsHandler(appsHandler echo.HandlerFunc) echo.HandlerFunc
SetupAppsHandler adds all the necessary middlewares for the application handler.
func SetupAssets ¶
SetupAssets add assets routing and handling to the given router. It also adds a Renderer to render templates.
func SetupRoutes ¶
SetupRoutes sets the routing for HTTP endpoints
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package apps is the HTTP frontend of the application package.
|
Package apps is the HTTP frontend of the application package. |
|
Package auth provides register and login handlers
|
Package auth provides register and login handlers |
|
Package data provide simple CRUD operation on couchdb doc
|
Package data provide simple CRUD operation on couchdb doc |
|
Package files is the HTTP frontend of the vfs package.
|
Package files is the HTTP frontend of the vfs package. |
|
Package jsonapi is for using the JSON-API format: parsing, serialization, checking the content-type, etc.
|
Package jsonapi is for using the JSON-API format: parsing, serialization, checking the content-type, etc. |
|
Package settings regroups some API methods to facilitate the usage of the io.cozy settings documents.
|
Package settings regroups some API methods to facilitate the usage of the io.cozy settings documents. |
|
Package status is here just to say that the API is up and that it can access the CouchDB databases, for debugging and monitoring purposes.
|
Package status is here just to say that the API is up and that it can access the CouchDB databases, for debugging and monitoring purposes. |
|
Package version gives informations about the version of the cozy-stack
|
Package version gives informations about the version of the cozy-stack |
Click to show internal directories.
Click to hide internal directories.