processone / processone/ejabberd

Documentation of mod_http_upload external_secret URL format

Open
#3,188 0 comments 1 reaction 1 assignee View on GitHub

@weiss is already working on this.

Since Mar 24, 2020.

Kind:Feature
Dominant language
Erlang
Stars
6.7k
Forks
1.6k
PR merge metrics
No merged PRs in 30d

Description

Is your feature request related to a problem? Please describe.
I want to use mod_http_upload option external_secret with an self-written php script. To be able to enforce a per user quota, I have to somehow get the JID (or a hash of it) out of the PUT URL.

Describe the solution you'd like
I already inspected the URL mod_http_upload with external_secret generates. It seems to have the format <configured_put_url>/<SHA-1(JID)>/<random>/<filename> (jid_in_url and get_url not configured).
As this format is not documentated, I have to treat it as implementation detail which can change on every update without prior warning.

Please document the URL format in https://docs.ejabberd.im/admin/configuration/#mod-http-upload . To leave space for additional information coded into the URL, I suggest to not say the exact position of the filename but state that it is the last component of the path (see #3189).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.