README
¶
HTTP API
The HTTP API is the main part for interacting with the application. Default address: http://localhost:1984/.
The HTTP API is described in OpenAPI format. It can be explored in interactive viewer. WebSocket API described here.
The project's static HTML and JS files are located in the www folder. An external developer can use them as a basis for integrating go2rtc into their project or for developing a custom web interface for go2rtc.
The contents of www folder are built into go2rtc when building, but you can use configuration to specify an external folder as the source of static files.
Configuration
Important! go2rtc passes requests from localhost and Unix sockets without HTTP authorization, even if you have it configured. It is your responsibility to set up secure external access to the API. If not properly configured, an attacker can gain access to your cameras and even your server.
- you can disable HTTP API with
listen: ""and use, for example, only RTSP client/server protocol - you can enable HTTP API only on localhost with
listen: "127.0.0.1:1984"setting - you can change the API
base_pathand host go2rtc on your main app webserver suburl - all files from
static_dirhosted on root path:/ - you can use raw TLS cert/key content or path to files
api:
listen: ":1984" # default ":1984", HTTP API port ("" - disabled)
username: "admin" # default "", Basic auth for WebUI
password: "pass" # default "", Basic auth for WebUI
local_auth: true # default false, Enable auth check for localhost requests
base_path: "/rtc" # default "", API prefix for serving on suburl (/api => /rtc/api)
static_dir: "www" # default "", folder for static files (custom web interface)
origin: "*" # default "", allow CORS requests (only * supported)
tls_listen: ":443" # default "", enable HTTPS server
tls_cert: | # default "", PEM-encoded fullchain certificate for HTTPS
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----
tls_key: | # default "", PEM-encoded private key for HTTPS
-----BEGIN PRIVATE KEY-----
...
-----END PRIVATE KEY-----
unix_listen: "/tmp/go2rtc.sock" # default "", unix socket listener for API
PS:
- MJPEG over WebSocket plays better than native MJPEG because Chrome bug
- MP4 over WebSocket was created only for Apple iOS because it doesn't support file streaming
Documentation
¶
Index ¶
- Constants
- Variables
- func Error(w http.ResponseWriter, err error)
- func HandleFunc(pattern string, handler http.HandlerFunc)
- func Init()
- func Response(w http.ResponseWriter, body any, contentType string)
- func ResponseJSON(w http.ResponseWriter, v any)
- func ResponsePrettyJSON(w http.ResponseWriter, v any)
- func ResponseSources(w http.ResponseWriter, sources []*Source)
- type Source
Constants ¶
const ( MimeJSON = "application/json" MimeText = "text/plain" )
const StreamNotFound = "stream not found"
Variables ¶
var Handler http.Handler
var Port int
Functions ¶
func Error ¶
func Error(w http.ResponseWriter, err error)
func HandleFunc ¶
func HandleFunc(pattern string, handler http.HandlerFunc)
HandleFunc handle pattern with relative path: - "api/streams" => "{basepath}/api/streams" - "/streams" => "/streams"
func ResponseJSON ¶
func ResponseJSON(w http.ResponseWriter, v any)
ResponseJSON important always add Content-Type so go won't need to call http.DetectContentType
func ResponsePrettyJSON ¶
func ResponsePrettyJSON(w http.ResponseWriter, v any)
func ResponseSources ¶
func ResponseSources(w http.ResponseWriter, sources []*Source)
Source Files
Directories