~zenomat/shors

e9d2abcdc39eea32900f6b4d00cfb912d190269e — Adrian Eichelbaum 1 year, 6 months ago 5a6e3c4
fix README formating
1 files changed, 25 insertions(+), 21 deletions(-)

M README.md
M README.md => README.md +25 -21
@@ 16,27 16,27 @@ so larger files will be retained for a shorter period of time.
`retention = min_age + (-max_age + min_age) * pow((file_size / max_size - 1), 3)`

```
	days
    MAX_RETENTION	|  \
        			|   \
        			|    \
        			|     \
        			|      \
        			|       \
        			|        ..
        			|          \
        			| ----------..-------------------------------------------
        			|             ..
        			|               \
        			|                ..
        			|                  ...
        			|                     ..
        			|                       ...
        			|                          ....
        			|                              ......
     MIN_RETENTION	|                                    ....................
          			 0                                                   MAX_SIZE
                                                              			 MiB
days
MAX_RETENTION	|  \
    			|   \
    			|    \
    			|     \
    			|      \
    			|       \
    			|        ..
    			|          \
    			| ----------..-------------------------------------------
    			|             ..
    			|               \
    			|                ..
    			|                  ...
    			|                     ..
    			|                       ...
    			|                          ....
    			|                              ......
 MIN_RETENTION	|                                    ....................
				0                                                   MAX_SIZE
                                                          			 MiB
```

- to run the cleanup job, send `SIGUSR1` to shors


@@ 50,6 50,8 @@ To run, simply execute
```bash
./shors
```
A static, precompiled binary can be found in the [1.0 tag](https://git.sr.ht/~zenomat/shors/refs/1.0).

Everything else is handled by the config file, see [Configuration](#Configuration).

Please keep in mind, that the server won't start, if the configured download directory,


@@ 74,7 76,9 @@ There is no built in TLS support. To still use TLS, put a reverse proxy in front
# WARNING
While files, as configurable by the admin, will not be stored forever, there is NO SUCH THING as
antivirus checking built in. You will have to do that on you own!

Also, if you use this service, without any access control, anybody with the URL can upload anything to your server,
so there is the possibility, that illegal content will be hosted on your server,
or that it will be abused for other nefarious purposes, if you do not take appropriate measures.

You have been warned!