Scroll to navigation

AIOCOAP-FILESERVER(1) User Commands AIOCOAP-FILESERVER(1)

NAME

aiocoap-fileserver - A simple file server that serves the contents of a given directory in a read-

DESCRIPTION

usage: aiocoap-fileserver [-h] [--version] [-v] [--register [RD-URI]]

[--write] [--bind BIND] [--credentials CREDENTIALS]
[--tls-server-certificate CRT] [--tls-server-key KEY] [path]

A simple file server that serves the contents of a given directory in a readonly fashion via CoAP. It provides directory listings, and guesses the media type of files it serves. It follows the conventions set out for the [kitchensink fileserver], optionally with write support, with some caveats: * There are some time-of-check / time-of-use race conditions around the handling of ETags, which could probably only be resolved if heavy file system locking were used. Some of these races are a consequence of this server implementing atomic writes through renames. As long as no other processes access the working area, and aiocoap is run single threaded, the races should not be visible to CoAP users. * ETags are constructed based on information in the file's (or directory's) `stat` output -- this avoids reaing the whole file on overwrites etc. This means that forcing the MTime to stay constant across a change would confuse clients. * While GET requests on files are served block by block (reading only what is being requested), PUT operations are spooled in memory rather than on the file system. * Directory creation and deletion is not supported at the moment. [kitchen-sink fileserver]: https://www.ietf.org/archive/id/draft-amsuess-core-coapkitchensink-00.html#name-coap

positional arguments:

Root directory of the server

options:

show this help message and exit
show program's version number and exit
Be more verbose (repeat to debug)
Register with a Resource directory
Allow writes by any user
Host and/or port to bind to (see --help-bind for details)
JSON file pointing to credentials for the server's identity/ies.
TLS certificate (chain) to present to connecting clients (in PEM format)
TLS key to load that supports the server certificate

SEE ALSO

The full documentation for aiocoap-fileserver is maintained as a Texinfo manual. If the info and aiocoap-fileserver programs are properly installed at your site, the command

info aiocoap-fileserver

should give you access to the complete manual.

February 2025 aiocoap-fileserver 0.4.12