|
3 | 3 |
|
4 | 4 | # Hupload
|
5 | 5 |
|
6 |
| -Hupload is a minimalist file uploader for your customers. |
| 6 | +Hupload is a minimalist file sharing solution for your customers. |
7 | 7 |
|
8 |
| -With technical support in mind, it simplifies the process of receiving log files |
9 |
| -or support bundles from your users. |
| 8 | +With technical support in mind, it simplifies the process of sharing log files |
| 9 | +or support bundles from/to your users. |
10 | 10 |
|
11 | 11 | It is a web portal and an API for direct integration into your products.
|
12 | 12 |
|
13 | 13 | The overall concept is that share names are random tokens that can be generated
|
14 | 14 | by **Hupload** and are publicly accessible so users don't have to log in to
|
15 |
| -upload content. |
| 15 | +upload content. SHare creation page is protected by a password or single |
| 16 | +sign-on. |
16 | 17 |
|
17 | 18 | Note that "Copy" buttons will not work over insecure connection (http without
|
18 | 19 | SSL)
|
|
50 | 51 | ## Features
|
51 | 52 |
|
52 | 53 | - Quickly create random links and share with users,
|
53 |
| -- Easy to use drag and drop interface for uploads, |
| 54 | +- Easy to use drag and drop interface, |
54 | 55 | - S3 or filesystem storage,
|
55 | 56 | - Configurable max share size and max file size,
|
56 | 57 | - Basic share informations listed (number of items, total size),
|
@@ -128,18 +129,18 @@ S3 options can also be set in environment using `AWS_DEFAULT_REGION`,
|
128 | 129 | in configuration file have precedence.
|
129 | 130 |
|
130 | 131 | Note that `region` is mandatory for AWS API to work correctly even if you
|
131 |
| -are using your own S3 server like minio. |
| 132 | +are using your own S3 server like [minio](https://min.io). |
132 | 133 |
|
133 | 134 | ### OIDC
|
134 | 135 |
|
135 |
| -OIDC redirect url is `/oidc` and you can provide application details with the |
136 |
| -following configuration : |
| 136 | +OIDC redirect url is `/oidc` and you can provide configuration details with the |
| 137 | +following : |
137 | 138 |
|
138 | 139 | ```
|
139 | 140 | auth:
|
140 | 141 | type: oidc
|
141 | 142 | options:
|
142 |
| - provider_url: https://auth.tynsoe.org/application/o/hupload/ |
| 143 | + provider_url: https://auth.company.com/application/o/hupload/ |
143 | 144 | client_id: <client_id>
|
144 | 145 | client_secret: <client_secret>
|
145 | 146 | redirect_url: https://hupload.company.com/oidc
|
@@ -220,4 +221,4 @@ When creating or updateing a new share, you can define parameters in the JSON bo
|
220 | 221 | | `validity` | `number` | Number of days the share is valid
|
221 | 222 | | `exposure` | `enum["upload","download","both"]` | Whether guest users can upload files, download files or do both
|
222 | 223 | | `description` | `string` | A short description displayed in shares view
|
223 |
| -| `message` | `url encoded markdown` | Instructions in markdown visible to the guest |
| 224 | +| `message` | `string` | Instructions in markdown visible to the guest |
0 commit comments