LUCOA(1)

2024-08-26

NAME

lucoa - a simple server for WHUMP

SYNOPSIS

lucoa [options] path [path ...]

DESCRIPTION

Lucoa is a simple server that serves WHUMP together with some user-defined music. The paths after the options will be searched for music that will be served by Lucoa.

The options are as follows:

-auth credentials

Specify the path of the credentials file. If this option is not provided, no authentication is required to access the server. The credentials file contains the usernames and the passwords. The first line contains a username, the next line contains the corresponding password. This pattern repeats for every user.

-cert certificate

Specify the path to the certificate to use for HTTPS.

-footer text

Set the text to display in the site's footer.

-header text

Set the text to display in the site's header.

-key key

Specify the path to the private key to use for HTTPS.

-no-reload

Exit with exit status 0 when receiving SIGHUP.

-port port

Set the port on run the server on. This option defaults to 8090.

-title text

Set the text to display in the site's title.

-version

Print the version information and exit.

SIGNALS

When receiving SIGHUP, the application will be reloaded. This scans the specified paths again for new or deleted tracks. The credentials will also be reloaded from the given file.

AUTHORS

Created and maintained by Hannes Braun <hannes@hannesbraun.net>. Up-to-date sources can be found at https://git.sr.ht/~hannes/lucoa. Bugs and patches can be submitted by email to ~hannes/public-inbox@lists.sr.ht.