webinno/filesharing
1
0
Fork 0
mirror of https://github.com/axeloz/filesharing.git synced 2025-05-06 10:03:55 +02:00
Code Issues Projects Releases Wiki Activity

Update readme.md

Browse source
This commit is contained in:
Axel 2017-07-20 16:32:19 +02:00 • committed by GitHub
parent a3b951547b
commit 14cac7a512
1 changed files with 25 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
readme.md
View file

@ -26,6 +26,22 @@ The application also comes with a Laravel Command (background task) who will phy
*Sorry about the design, I know it's ugly*. You're welcome to help and participate. *Sorry about the design, I know it's ugly*. You're welcome to help and participate.
## Features
- upload one or more files via drag and drop or browse
- creation of a bundle
- ability to keep adding files to the bundle until you close your browser tab, the links remain untouched
- bundle expiration
- sharing link with bundle content preview
- ability to download a single file of the bundle or the entire bundle
- direct download link (doesn't show the bundle content)
- deletion link
- garbage collector which removes the expired bundles as a background tasks
- multilingual (EN and FR)
- easy installation, no database required
- upload limitation based on client IP filtering
- secured by tokens, authentication codes and non-accessible files
## Requirements ## Requirements
Basically, nothing more than Laravel itself: Basically, nothing more than Laravel itself:
@ -62,13 +78,15 @@ Use your browser to navigate to your domain name (example: files.yourdomain.com)
In order to configure your application, copy the .env.example file into .env. Then edit the .env file. In order to configure your application, copy the .env.example file into .env. Then edit the .env file.
- `APP_ENV` change this to `production` when in production (`local` otherwise) | Configuration | Description |
- `APP_DEBUG` change this to `false` when in production (`true` otherwise) | ------------- | ----------- |
- `TIMEZONE` change this to your current timezone | `APP_ENV`     | change this to `production` when in production (`local` otherwise) |
- `LOCALE=en` change this to "fr" or "en" | `APP_DEBUG` | change this to `false` when in production (`true` otherwise) |
- `STORAGE_PATH=` (optional) changes this wherever you want to store the files | `TIMEZONE` | change this to your current timezone |
- `UPLOAD_MAX_FILESIZE=5M` (optional) change this to the value you want (M, G, T, ...). Attention : you must configure your PHP settings too (`post_max_size`, `upload_max_filesize` and `memory_limit`) | `LOCALE=en` | change this to "fr" or "en" |
- `UPLOAD_LIMIT_IPS` (optional) a comma separated list of IPs from which you may upload files. Different formats are supported : Full IP address (192.168.10.2), Wildcard format (192.168.10.*), CIDR Format (192.168.10/24 or 1.2.3.4/255.255.255.0) or Start-end IP (192.168.10.0-192.168.10.10) | `STORAGE_PATH=` | (*optional*) changes this wherever you want to store the files |
| `UPLOAD_MAX_FILESIZE=5M` | (*optional*) change this to the value you want (M, G, T, ...). Attention : you must configure your PHP settings too (`post_max_size`, `upload_max_filesize` and `memory_limit`) |
| `UPLOAD_LIMIT_IPS` | (*optional*) a comma separated list of IPs from which you may upload files. Different formats are supported : Full IP address (192.168.10.2), Wildcard format (192.168.10.*), CIDR Format (192.168.10/24 or 1.2.3.4/255.255.255.0) or Start-end IP (192.168.10.0-192.168.10.10) |
## Development ## Development