HTTP configuration

The HTTP aspects of this module (HTTP host, path, etc.) are fully configurable using Prosody’s standard HTTP configuration. By default the module will use the path /file_share. To find the URL that the module is currently using, you can run (assuming you have mod_admin_shell enabled):

prosodyctl shell module info http_file_share

Alternatively, check your log file for the informational messages logged by mod_http_file_share when it is first loaded.

Discovery

If your component domain (e.g. upload.example.org) is a direct subdomain of your VirtualHost that your users accounts are on (e.g. example.org), your users’ clients will automatically discover and use your upload service.

If, however, your component domain is not a direct subdomain (e.g. upload.example.net or upload.foo.example.org) then you will need to specificaly add that the component to your VirtualHost’s disco_items so that clients can find it.

Manual configuration to allow clients on a VirtualHost to discover an upload component that is not a direct subdomain:

VirtualHost "chat.domain.example"
disco_items = {
    { "upload.example.org", "file sharing service (this name is optional)" },
}

Larger files

Users wanting to share even larger files? The size limit can be increased with the http_file_share_size_limit setting.

Component "upload.example.org" "http_file_share"
http_file_share_size_limit = 16*1024*1024 -- 16 MiB

Daily quotas

The daily quota is a limit that prevents users from uploading more files if more than a certain amount of bytes have been uploaded during the last 24 hours.

Component "upload.example.org" "http_file_share"
http_file_share_daily_quota = 100*1024*1024 -- 100 MiB per day per user

Thus with the above configuration and one week retention, each user could store up to 700 MiB each.

Once this limit has been reached they must wait until at least one upload to become more than 24 hours old.

Global quota

Since it’s not always easy to estimate how much storage space will be needed, i.e. because the number of users may change which would increase the total theoretical usage by another 700 MiB (in the example from the previous section).

Component "upload.example.org" "http_file_share"
http_file_share_global_quota = 1024*1024*1024 -- 1 GiB total

With such configuration, the total size of all uploaded files will not be allowed to exceed 1 GiB.

Access

Any local user on the same Prosody instance is allowed to use the upload service by default. The http_file_share_access setting can be specified to limit access to certain users or hosts, including hosts on other servers. Be careful!

Component "upload.example.org" "http_file_share"
http_file_share_access = {
    "filesharingenthusiast@example.net", -- this specifc user
    "example.org", -- anyone with a @example.org address
}

Restricting file types

Only want to serve images? Say so with the http_file_share_allowed_file_types setting.

Component "images.example.org" "http_file_share"
http_file_share_allowed_file_types = { "image/*" }

Using a separate HTTP upload service

To use an external upload service, specify the base URL of via http_file_share_base_url and configure a strong shared secret via http_file_share_secret, which must also be specified in the configuration of the external upload service.

Component "upload.example.org" "http_file_share"
http_file_share_secret = "U2VjcmV0VG9rZW4wMzYz"
http_file_share_base_url = "https://share.example.com/upload.php/"