Skip to content

Commit a38a551

Browse files
committed
updated README
1 parent c37ee4b commit a38a551

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,17 @@
33

44
# Hupload
55

6-
Hupload is a minimalist file uploader for your customers.
6+
Hupload is a minimalist file sharing solution for your customers.
77

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.
1010

1111
It is a web portal and an API for direct integration into your products.
1212

1313
The overall concept is that share names are random tokens that can be generated
1414
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.
1617

1718
Note that "Copy" buttons will not work over insecure connection (http without
1819
SSL)
@@ -50,7 +51,7 @@ SSL)
5051
## Features
5152

5253
- 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,
5455
- S3 or filesystem storage,
5556
- Configurable max share size and max file size,
5657
- 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`,
128129
in configuration file have precedence.
129130

130131
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).
132133

133134
### OIDC
134135

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 :
137138

138139
```
139140
auth:
140141
type: oidc
141142
options:
142-
provider_url: https://auth.tynsoe.org/application/o/hupload/
143+
provider_url: https://auth.company.com/application/o/hupload/
143144
client_id: <client_id>
144145
client_secret: <client_secret>
145146
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
220221
| `validity` | `number` | Number of days the share is valid
221222
| `exposure` | `enum["upload","download","both"]` | Whether guest users can upload files, download files or do both
222223
| `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

Comments
 (0)