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

transform config options into a table, provide some more information about configuring the IFM

Marco Dickert
2017-07-27 15:03:16 +02:00
parent 3efde14241
commit da6111acce
1 changed files with 28 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

99
Configuration.md

@@ -1,73 +1,30 @@
The script contains an array of configuration options which can be easily changed.
There are several ways to configure the IFM. At the moment you can either change the default configuration at the top of the script, or pass a custom configuration array to the constructor (when using `libifm.php`). Soon there will also be the possibility to configure the IFM via environment variables, but this is not implemented, yet. When you use the docker image, you already able to use environment variables like desribed [here](https://github.com/misterunknown/ifm#run-image).
### `auth`, `auth_source`
see authentication
## configuration options
### `root_dir`
Sets a custom root directory. By default the IFM is locked to its own directory, so you can't go above. Notice that the PHP user has to have sufficient permissions for the `root_dir`, otherwise IFM will not work. Regardless of whether the `root_dir` is set or not, the IFM will **not follow symlinks**, as long as the destination lies outside the `root_dir`. This is by design and cannot be changed.
### `tmp_dir`
Sets a custom temporary directory. This is used to save temporary zip files when you download an entire directory. Make sure the PHP user has write permissions there.
### `ajaxrequest`
Controls if the user is allowed to perform an ajax request. This was primarily used to debug the IFM in the development process and I didn't remove it since it's quite useful in some cases.
### `chmod`
Controls if the user is allowed to change permissions of files and directories.
### `copymove`
Controls if the user is allowed to copy or move files and directories.
### `createdir`
Controls if the user is allowed to create directories
### `createfile`
Controls if the user is allowed to create files.
### `edit`
Controls if the user is allowed to edit files. I'm not sure if it makes any sense that creating files and editing files are two separate permissions, but I never changed that.
### `delete`
Controls if the user is allowed to delete files and directories
### `download`
Controls if the user is allowed to download files.
### `extract`
Controls if the user is allowed to extract zip files.
### `upload`
Controls if the user is allowed to upload files.
### `remoteupload`
Controls if the user is allowed to upload files remotely via an URL.
### `rename`
Controls if the user is allowed to rename files and directories.
### `zipnload`
Controls if the user is allowed to download directories as zip files.
### `showlastmodified`
Show the last modified column
### `showfilesize`
Show the filesize.
### `showowner`
Show the owner (*nix only).
### `showgroup`
Show the group (*nix only).
### `showpermissions`
Show the permissions.
### `showhtdocs`
Show files starting with `.ht`. Notice: If you disable this, the user is also not allowed to edit or create such files.
### `showhiddenfiles`
Show hidden files. Notice: If you disable this, the user is also not allowed to edit or create such files.
### `showpath`
Shows the absolute path to the `root_dir`.
| option | description |
| :------ | :----------- |
| `auth`, `auth_source` | see [authentication](https://github.com/misterunknown/ifm/wiki/Authentication) |
| `root_dir` | Sets a custom root directory. By default the IFM is locked to its own directory, so you can't go above. Notice that the PHP user has to have sufficient permissions for the `root_dir`, otherwise IFM will not work. Regardless of whether the `root_dir` is set or not, the IFM will **not follow symlinks**, as long as the destination lies outside the `root_dir`. This is by design and cannot be changed. |
| `tmp_dir` | Sets a custom temporary directory. This is used to save temporary zip files when you download an entire directory. Make sure the PHP user has write permissions there. |
| `ajaxrequest` | Controls if the user is allowed to perform an ajax request. This was primarily used to debug the IFM in the development process and I didn't remove it since it's quite useful in some cases. |
| `chmod` | Controls if the user is allowed to change permissions of files and directories. |
| `copymove` | Controls if the user is allowed to copy or move files and directories. |
| `createdir` | Controls if the user is allowed to create directories |
| `createfile` | Controls if the user is allowed to create files. |
| `edit` | Controls if the user is allowed to edit files. I'm not sure if it makes any sense that creating files and editing files are two separate permissions, but I never changed that. |
| `delete` | Controls if the user is allowed to delete files and directories |
| `download` | Controls if the user is allowed to download files. |
| `extract` | Controls if the user is allowed to extract zip files. |
| `upload` | Controls if the user is allowed to upload files. |
| `remoteupload` | Controls if the user is allowed to upload files remotely via an URL. |
| `rename` | Controls if the user is allowed to rename files and directories. |
| `zipnload` | Controls if the user is allowed to download directories as zip files. |
| `showlastmodified` | Show the last modified column |
| `showfilesize` | Show the filesize |
| `showowner` | Show the owner (*nix only) |
| `showgroup` | Show the group (*nix only) |
| `showpermissions` | Show the permissions |
| `showhtdocs` | Show files starting with `.ht`. Notice: If you disable this, the user is also not allowed to edit or create such files. |
| `showhiddenfiles` | Show hidden files. Notice: If you disable this, the user is also not allowed to edit or create such files. |
| `showpath` | Shows the absolute path to the `root_dir` |