mirror of
https://github.com/axeloz/filesharing.git
synced 2025-05-06 18:13:55 +02:00
Readme
This commit is contained in:
parent
8c6218161c
commit
39bd8123be
1 changed files with 15 additions and 15 deletions
12
readme.md
12
readme.md
|
@ -7,7 +7,7 @@ Powered by Laravel
|
||||||
|
|
||||||
## Description
|
## Description
|
||||||
|
|
||||||
This PHP application based on Laravel 5.4 allows to share files like Wetransfer. You may install it on your own server. It does not require any database system, it works with JSON files in the storage folder. It is multilingual and comes with english and french translations for now. You're welcome to help.
|
This PHP application based on Laravel 5.4 allows to share files like Wetransfer. You may install it **on your own server**. It **does not require** any database system, it works with JSON files in the storage folder. It is **multilingual** and comes with english and french translations for now. You're welcome to help.
|
||||||
|
|
||||||
It comes with a droplet (based on Dropzone.js). You may drag and drop some files or directories into the droplet, your files will be uploaded to the server as a bundle.
|
It comes with a droplet (based on Dropzone.js). You may drag and drop some files or directories into the droplet, your files will be uploaded to the server as a bundle.
|
||||||
|
|
||||||
|
@ -22,9 +22,9 @@ http://yourdomain/bundle/dda2d646b6746b96ea9b/delete?auth=ace6f22f5.
|
||||||
|
|
||||||
Each of these links come with a auth code. This code is the same for the preview and the download links. It is however different for the deletion link.
|
Each of these links come with a auth code. This code is the same for the preview and the download links. It is however different for the deletion link.
|
||||||
|
|
||||||
The application also comes with a Laravel Command (background task) who will physically removed expired bundle files of the storage disk.
|
The application also comes with a Laravel Command (background task) who will physically removed expired bundle files of the storage disk. This command is included in Laravel scheduled commands.
|
||||||
|
|
||||||
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.
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
|
@ -51,7 +51,7 @@ The application also uses:
|
||||||
- run a `npm install --production`
|
- run a `npm install --production`
|
||||||
- start the Laravel scheduler (it will delete expired bundles of the storage). For example `* * * * * php /path-to-your-project/artisan schedule:run >> /dev/null 2>&1`
|
- start the Laravel scheduler (it will delete expired bundles of the storage). For example `* * * * * php /path-to-your-project/artisan schedule:run >> /dev/null 2>&1`
|
||||||
|
|
||||||
Use your browser to navigate to your domain name (example: files.yourdomain.com) and that's it.
|
Use your browser to navigate to your domain name (example: files.yourdomain.com) and **that's it**.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
|
@ -65,7 +65,7 @@ If your want to modify the sources, you can use the Laravel Mix features:
|
||||||
|
|
||||||
## Roadmap
|
## Roadmap
|
||||||
|
|
||||||
There are many ideas to come. You are welcome to participate.
|
There are many ideas to come. You are welcome to **participate**.
|
||||||
- make the expiry date editable per bundle
|
- make the expiry date editable per bundle
|
||||||
- limit upload permission based on an IP address (or IP range) or by a password (or passwords)
|
- limit upload permission based on an IP address (or IP range) or by a password (or passwords)
|
||||||
- ability to send link to recipients
|
- ability to send link to recipients
|
||||||
|
@ -76,4 +76,4 @@ https://choosealicense.com/licenses/gpl-3.0/
|
||||||
|
|
||||||
## Welcome on board
|
## Welcome on board
|
||||||
|
|
||||||
If you want to participate or if you want to talk with me : sharing@mabox.eu
|
If you want to **participate** or if you want to talk with me : sharing@mabox.eu
|
||||||
|
|
Loading…
Add table
Reference in a new issue