docs » hs.httpserver

Creates a new HTTP or HTTPS server

• ssl - An optional boolean. If true, the server will start using HTTPS. Defaults to false.
• bonjour - An optional boolean. If true, the server will advertise itself with Bonjour. Defaults to true. Note that in order to change this, you must supply a true or false value for the ssl argument.

• An hs.httpserver object

• By default, the server will start on a random TCP port and advertise itself with Bonjour. You can check the port with hs.httpserver:getPort()
• By default, the server will listen on all network interfaces. You can override this with hs.httpserver:setInterface() before starting the server
• Currently, in HTTPS mode, the server will use a self-signed certificate, which most browsers will warn about. If you want/need to be able to use hs.httpserver with a certificate signed by a trusted Certificate Authority, please file an bug on Hammerspoon requesting support for this.

Gets the network interface the server is configured to listen on

• None

• A string containing the network interface name, or nil if the server will listen on all interfaces

Gets the Bonjour name the server is configured to advertise itself as

• None

• A string containing the Bonjour name of this server

• This is not the hostname of the server, just its name in Bonjour service lists (e.g. Safari's Bonjour bookmarks menu)

Gets the TCP port the server is configured to listen on

• None

• A number containing the TCP port

Get or set the maximum allowed body size for an incoming HTTP request.

• size - An optional integer value specifying the maximum body size allowed for an incoming HTTP request in bytes. Defaults to 10485760 (10 MB).

• If a new size is specified, returns the hs.httpserver object; otherwise the current value.

• Because the Hammerspoon http server processes incoming requests completely in memory, this method puts a limit on the maximum size for a POST or PUT request.

Sends a message to the websocket client

• message - A string containing the message to send

• The hs.httpserver object

Sets the request handling callback for an HTTP server object

• callback - An optional function that will be called to process each incoming HTTP request, or nil to remove an existing callback. See the notes section below for more information about this callback

• The hs.httpserver object

• The callback will be passed four arguments:

• A string containing the type of request (i.e. GET/POST/DELETE/etc)

• A string containing the path element of the request (e.g. /index.html)

• A table containing the request headers

• A string containing the raw contents of the request body, or the empty string if no body is included in the request.

• The callback must return three values:

• A string containing the body of the response

• An integer containing the response code (e.g. 200 for a successful request)

• A table containing additional HTTP headers to set (or an empty table, {}, if no extra headers are required)

• A POST request, often used by HTML forms, will store the contents of the form in the body of the request.

Sets the network interface the server is configured to listen on

• interface - A string containing an interface name

• The hs.httpserver object

• As well as real interface names (e.g. en0) the following values are valid:
• An IP address of one of your interfaces
• localhost
• loopback
• nil (which means all interfaces, and is the default)

Sets the Bonjour name the server should advertise itself as

• name - A string containing the Bonjour name for the server

• The hs.httpserver object

• This is not the hostname of the server, just its name in Bonjour service lists (e.g. Safari's Bonjour bookmarks menu)

Sets a password for an HTTP server object

• password - An optional string that contains the server password, or nil to remove an existing password

• The hs.httpserver object

• It is not currently possible to set multiple passwords for different users, or passwords only on specific paths

Sets the TCP port the server is configured to listen on

• port - An integer containing a TCP port to listen on

• The hs.httpserver object

Starts an HTTP server object

• None

• The hs.httpserver object

Stops an HTTP server object

• None

• The hs.httpserver object

Enables a websocket endpoint on the HTTP server

• path - A string containing the websocket path such as '/ws'
• callback - A function returning a string for each received websocket message

• The hs.httpserver object

• The callback is passed one string parameter containing the received message
• The callback must return a string containing the response message
• Given a path '/mysock' and a port of 8000, the websocket URL is as follows:
• ws://localhost:8000/mysock
• wss://localhost:8000/mysock (if SSL enabled)