mirror/php-ifm
1
0
Fork 0
mirror of https://github.com/misterunknown/ifm.git synced 2025-08-11 02:24:00 +02:00
Code Issues Releases Wiki Activity

Updated readme.md after new release

Browse Source
This commit is contained in:
Marco Dickert
2017-02-17 11:14:42 +01:00
committed by GitHub
parent 89d5c0dc00
commit b6db20b26a
1 changed files with 22 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@@ -1,25 +1,30 @@
# IFM - improved file manager
## about
This is a simple filemanager. It is a single file solution which uses HTML5, CSS3, JavaScript and PHP. It works like a client-server system where HTML5/CSS3/JavaScript is the client part and the PHP API acts as the server, which reduces the traffic significant.
The IFM comes with a embedded Version of [jQuery](http://jquery.com) and [ACE Editor](http://ace.c9.io).
## requirements
Client
* HTML5 and CSS3 compatible browser
* activated JavaScript
Server
* >= PHP 5.5 (only if using auth; if not PHP 5.4 works either)
* optional: cURL extention (for remote upload)
## issues
Currently there are no known issues.
## screenshot
![IFM screenshot 1](https://misterunknown.de/static/ifm-screenshot-1.png "IFM screenshot")
![IFM screenshot 2](https://misterunknown.de/static/ifm-screenshot-2.png "IFM screenshot")
The IFM uses the following resources:
* [ACE Editor](https://ace.c9.io)
* [Bootstrap v3](https://getbootstrap.com)
* [jQuery](https://jquery.com)
* custom icon set generated with [Fontello](http://fontello.com/)
## installation
Just copy this ifm.php to your webspace - thats all :)
Just copy the ifm.php to your webspace - thats all :)
## requirements
| Client | Server |
|:--------------------------------- |:------------------------------------------------------------ |
| HTML5 and CSS3 compatible browser | PHP >= 5.5 (only if using auth; if not PHP 5.4 works either) |
| activated JavaScript | optional: cURL extention (for remote upload) |
## issues
Currently there are no known issues. If you find any flaws please let me know.
## screenshots
<a href="https://misterunknown.de/static/ifm_screenshot_desktop_filelist.png"><img src="https://misterunknown.de/static/ifm_screenshot_desktop_filelist.png" height="300px"></a>
<a href="https://misterunknown.de/static/ifm_screenshot_mobile_filelist.png"><img src="https://misterunknown.de/static/ifm_screenshot_mobile_filelist.png" height="300px"></a>
<a href="https://misterunknown.de/static/ifm_screenshot_desktop_remote_upload.png"><img src="https://misterunknown.de/static/ifm_screenshot_desktop_remote_upload.png" height="300px"></a>
<a href="https://misterunknown.de/static/ifm_screenshot_mobile_editfile.png"><img src="https://misterunknown.de/static/ifm_screenshot_mobile_editfile.png" height="300px"></a>
## configuration
The configuration is located at the top of the script in a separate configuration class. The options in the class are commented and named laconically. If you have questions anyway [write me an email](mailto:marco@misterunknown.de).
@@ -40,13 +45,7 @@ The file should contain ONLY ONE LINE:
```
The password hash has to be a hash generated by PHPs `password_hash()` function. The default credentials are "admin:admin".
## security information
The IFM was developed with the assumption that the highest level of operation is the scripts base location. So it is neither possible to nagivate nor to use any API function in a level above the script root.
It is highly recommended to restrict access to the script e.g. using a basic authentication.
## references
I used some nice free icons in my script which I want to mention here:
* file icons: [Free file icons by Teambox](https://github.com/teambox/Free-file-icons)
* other icons: [Mono icons from tutorial9.net](http://www.tutorial9.net/downloads/108-mono-icons-huge-set-of-minimal-icons/)