1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/bozon_ynh.git synced 2024-09-03 18:16:09 +02:00
bozon_ynh/sources/readme.md
2016-03-23 19:30:43 +01:00

60 lines
4 KiB
Markdown

# BoZoN
## Minimalist Drag & drop file sharing app
( http://bozon.warriordudimanche.net/ )
- Install: just unzip on your server; no database/ php 5.2. Then go to index.php?p=admin page and create your login/pass.
- Config: just change config.php file.
- Upload a file: go to index.php?p=admin page, connect and then drop files in the dashed area... that's it !
- Organize files & folders, share them, manage the shared access etc.
The share link is the file link in the admin's view (you can also access it by the button link on the file or the folder.)
## Required
Php 5 min, php5-gd, ZipArchive
## used libraries
I used a few libs I made
- auto_restrict : to easily lock access to a page and handle basic security features
- auto_thumbs : a function to generate all the thumbnails
- auto_dropzone : a lib that handle the drag and drop function only by including it in a script
- Array2feed.php : a function used to convert an array into a RSS feed without commiting suicide XD
- "On-the-fly CSS Compression" (a personal modified version of https://gist.github.com/manastungare/2625128)
and
- sorttables.js (http://www.kryogenix.org/code/browser/sorttable)
- b-lazy (http://dinbror.dk/blazy)
- qr-js (http://hg.mearie.org/qrjs)
- m3uStreamPlayer.js (https://github.com/opi/m3uStreamPlayer)
- audiojs (http://kolber.github.io/audiojs)
- scrolltotop : (https://github.com/jerrywham-pluxml5-2/scrollToTop/)
- marked.js : (https://github.com/chjj/marked)
- vanillajs : (my own lib, very tiny)
## Licence
All Bozon code and all the personal libs used in it are distributed under AGPL: feel free to fork, adapt, distribute, comment etc but please, keep your fork free too ;-)
## FAQ
- _I want to add a user_ : There's a [New user] link in the admin's page top menu, click on it and put a login/pass
- _I want to remove a user_ : Click on the [Users list] link in the admin's page top menu, check the user(s) you want to remove and click on ok.
- _I've changed some config variables and nothing appends !_ : that's not an issue; all variables are in the Session, so you need to restart chromium/firefox/opera etc to see the changes
- _can't see icons / problems uploading / list refresh problem_ : take a look to access rights (folders / files)
- _I want to change my password_ : Use the change password function (top menu)
- _I forgot my password !_ : just use your FTP client and delete «private/auto_restrict*.php» files, then try to login again and create a new login/pass.
- _I want to change the default language !_ : see in config.php file you can set fr/en/es but you can also make your own traduction (see in lang.php)
- _I don't want a stolen link works anymore (but I don't want to delete the file/folder) !_ : in links mode, click on the regen button (recycle icon) and the share link for this item will automatically change.
- _How to lock a share link with a password ?_ : click on the left menu, use the manage links button; then click on the lock icon on the file/folder and give an password. The file/folder will turn blue with a small lock meaning nobody can now use the share link without the password.
- _Yes, ok, but how to remove the password ?_ : just click on regen button, the id will be regenerated and the password will be destroyed (the share link will change)
- _What if I upload, create a folder or move an item with a name conflict ?_ : Don't worry, BoZoN will just rename the file to avoid overwriting.
- _How to create my own skin ?_ : just copy the default folder in templates/ and make the changes you want, then change the config.php ($default_theme='default';)
- _How to upload a complete folder with subfolders in one time ?_ : make a zip, upload it and use the convert icon (a folder) The uploaded zip will be unzipped on the server and all files and directory structure will be restored.
## Special thanks
To Cyrille Borne [ https://github.com/cborne & http://www.cyrille-borne.com ]: without your comments, issues reporting and enhancement ideas this app would never have been so complete ;-)
To Eauland for his great job on my poor css/html code (a pain in the ass it seems ! ^^)