Improving Readme

This commit is contained in:
Axel 2023-07-19 13:11:03 +02:00
parent 1912d4d18c
commit db843fe7e0
Signed by: axel
GPG key ID: 73C0A5961B6BC740

View file

@ -82,7 +82,16 @@ docker run -d \
-p 8080:80 \ -p 8080:80 \
-v <local_path>:/app/storage/content \ -v <local_path>:/app/storage/content \
--name filesharing \ --name filesharing \
-e APP_NAME="FileSharing" \
-e APP_URL="<your_url>" \
-e ASSET_URL="<your_asset_url>" \
-e UPLOAD_MAX_FILESIZE="1G" \ -e UPLOAD_MAX_FILESIZE="1G" \
-e APP_TIMEZONE="Europe/Paris" \
-e UPLOAD_PREVENT_DUPLICATES=true \
-e HASH_MAX_FILESIZE="1G" \
-e UPLOAD_MAX_FILES=100 \
-e UPLOAD_MAX_FILESIZE="1M" \
-e LIMIT_DOWNLOAD_RATE="100K" \
axeloz/filesharing:latest axeloz/filesharing:latest
``` ```
- use the `-v` option to bind your local storage to the docker instance (persisting data) - use the `-v` option to bind your local storage to the docker instance (persisting data)
@ -90,6 +99,26 @@ axeloz/filesharing:latest
- you may pass env variables with the `-e` option - you may pass env variables with the `-e` option
- you can use a reverse proxy for SSL termination (example: nginx) - you can use a reverse proxy for SSL termination (example: nginx)
Simple config for Nginx:
```
server {
server_name filesharing.box.webinno.fr;
charset utf-8;
location / {
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_pass http://localhost:8080;
}
listen [::]:443 ssl http2;
listen 443 ssl http2;
ssl_certificate [...]
ssl_certificate_key [...]
}
```
You can also use in docker compose with the following template: You can also use in docker compose with the following template:
```yaml ```yaml