1
0
mirror of https://github.com/misterunknown/ifm.git synced 2025-08-12 02:53:58 +02:00

fix markdown warnings

This commit is contained in:
Dmitriy Novash
2022-12-23 18:35:26 +02:00
parent fd38618ca3
commit 423a560392

View File

@@ -1,5 +1,7 @@
# IFM - improved file manager # IFM - improved file manager
## contents ## contents
- [about](#about) - [about](#about)
- [features](#features) - [features](#features)
- [requirements](#requirements) - [requirements](#requirements)
@@ -12,6 +14,7 @@
- [issues](#issues) - [issues](#issues)
## About ## About
The IFM is a web-based filemanager, which comes as a single file solution using The IFM is a web-based filemanager, which comes as a single file solution using
HTML5, CSS3, JavaScript and PHP. You can test a [demo HTML5, CSS3, JavaScript and PHP. You can test a [demo
here](https://ifmdemo.gitea.de/). here](https://ifmdemo.gitea.de/).
@@ -26,6 +29,7 @@ The IFM uses the following resources:
* [Mustache](https://mustache.github.io/) * [Mustache](https://mustache.github.io/)
## features ## features
* create/edit files and directories * create/edit files and directories
* copy/move files and directories * copy/move files and directories
* download files and directories * download files and directories
@@ -36,6 +40,7 @@ The IFM uses the following resources:
* simple authentication (LDAP via `ldap_bind` possible) * simple authentication (LDAP via `ldap_bind` possible)
## Requirements ## Requirements
* Client * Client
* HTML5 and CSS3 compatible browser * HTML5 and CSS3 compatible browser
* activated javascript * activated javascript
@@ -55,6 +60,7 @@ The IFM uses the following resources:
* zlib * zlib
## Installation ## Installation
Just download the latest release of the IFM. You can find it Just download the latest release of the IFM. You can find it
[here](https://github.com/misterunknown/ifm/releases/latest). You can choose [here](https://github.com/misterunknown/ifm/releases/latest). You can choose
between the CDN version (dependencies like bootstrap, jquery etc. are loaded between the CDN version (dependencies like bootstrap, jquery etc. are loaded
@@ -65,6 +71,7 @@ recommended; if the filesize of the IFM is an issue for you, consider using the
CDN versions. CDN versions.
## Security information ## Security information
The IFM is usually locked to it's own directory, so you are not able to go The IFM is usually locked to it's own directory, so you are not able to go
above. You can change that by setting the `root_dir` in the scripts above. You can change that by setting the `root_dir` in the scripts
[configuration](https://github.com/misterunknown/ifm/wiki/Configuration). [configuration](https://github.com/misterunknown/ifm/wiki/Configuration).
@@ -76,6 +83,7 @@ configuration. [See
also](https://github.com/misterunknown/ifm/wiki/Configuration). also](https://github.com/misterunknown/ifm/wiki/Configuration).
## Key bindings ## Key bindings
* <kbd>e</kbd> - edit / extract current file * <kbd>e</kbd> - edit / extract current file
* <kbd>h</kbd><kbd>j</kbd><kbd>k</kbd><kbd>l</kbd> - vim-style navigation (alternative to arrow keys) * <kbd>h</kbd><kbd>j</kbd><kbd>k</kbd><kbd>l</kbd> - vim-style navigation (alternative to arrow keys)
* <kbd>g</kbd> - focus the path input field (i.e. "goto") * <kbd>g</kbd> - focus the path input field (i.e. "goto")
@@ -95,55 +103,73 @@ also](https://github.com/misterunknown/ifm/wiki/Configuration).
* <kbd>Ctrl</kbd>-<kbd>Shift</kbd>-<kbd>f</kbd> - toggle fullscreen ace editor * <kbd>Ctrl</kbd>-<kbd>Shift</kbd>-<kbd>f</kbd> - toggle fullscreen ace editor
## Configuration ## Configuration
See [configuration](https://github.com/misterunknown/ifm/wiki/Configuration). See [configuration](https://github.com/misterunknown/ifm/wiki/Configuration).
### authentication ### authentication
See [authentication](https://github.com/misterunknown/ifm/wiki/Authentication). See [authentication](https://github.com/misterunknown/ifm/wiki/Authentication).
## Docker ## Docker
The docker image is based on the official php docker images (alpine version) The docker image is based on the official php docker images (alpine version)
and exposes port 80. and exposes port 80.
### Quickstart ### Quickstart
Build the image with this command in the top source dir: Build the image with this command in the top source dir:
`docker build -t ifm .` ```bash
docker build -t ifm .
```
Afterwards you can start the docker container as follows: Afterwards you can start the docker container as follows:
`docker run --rm -d --name ifm -p 8080:80 -v /path/to/data:/var/www ifm:latest` ```bash
docker run --rm -d --name ifm -p 8080:80 -v /path/to/data:/var/www ifm:latest
```
### Specify user/group ### Specify user/group
By default IFM runs as user www-data (uid/gid 33). If you need to change that, By default IFM runs as user www-data (uid/gid 33). If you need to change that,
you can set the UID and GID with the following environment variables: you can set the UID and GID with the following environment variables:
`docker run ... -e IFM_DOCKER_UID=1000 -e IFM_DOCKER_GID=100 ifm:latest` ```bash
docker run ... -e IFM_DOCKER_UID=1000 -e IFM_DOCKER_GID=100 ifm:latest
```
### Other configuration ### Other configuration
The script is located at `/usr/local/share/webapps/ifm/index.php`. By default The script is located at `/usr/local/share/webapps/ifm/index.php`. By default
the `root_dir` is set to /var/www, so you can mount any directory at this the `root_dir` is set to /var/www, so you can mount any directory at this
location. If you want to bind the corresponding host directory, you can do the location. If you want to bind the corresponding host directory, you can do the
following: following:
`docker run --rm -i -p "8080:80" -v "/var/www:/var/www" ifm` ```bash
docker run --rm -i -p "8080:80" -v "/var/www:/var/www" ifm
```
The scripts configuration can be changed by adjusting the corresponding The scripts configuration can be changed by adjusting the corresponding
environment variables. For example: environment variables. For example:
```docker run --rm -i -p "8080:80" -v /var/www:/var/www \ ```bash
-e IFM_AUTH=1 -e IFM_AUTH \ docker run --rm -i -p "8080:80" -v /var/www:/var/www \
-e IFM_AUTH_SOURCE="admin:$2y$05$LPdE7u/5da/TCE8ZhqQ1o.acuV50HqB3OrHhNwxbXYeWmmZKdQxrC" \ -e IFM_AUTH=1 -e IFM_AUTH \
ifm -e IFM_AUTH_SOURCE="admin:$2y$05$LPdE7u/5da/TCE8ZhqQ1o.acuV50HqB3OrHhNwxbXYeWmmZKdQxrC" \
ifm
``` ```
You can get a complete list of environment variables You can get a complete list of environment variables
[here](https://github.com/misterunknown/ifm/wiki/Configuration#configuration-options). [here](https://github.com/misterunknown/ifm/wiki/Configuration#configuration-options).
## screenshots ## 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_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_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_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> <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>
## issues ## issues
If you happen to find an error or miss a feature, you can create an issue on If you happen to find an error or miss a feature, you can create an issue on
Github. Github.