From 709f29b972ebb6f408e39acf23f6342d5b2c8a40 Mon Sep 17 00:00:00 2001
From: Marco Dickert <dickert.marco@gmail.com>
Date: Thu, 13 Jul 2017 10:37:07 +0200
Subject: [PATCH] Created Configuration (markdown)

---
 Configuration.md | 73 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 73 insertions(+)
 create mode 100644 Configuration.md

diff --git a/Configuration.md b/Configuration.md
new file mode 100644
index 0000000..87c61f2
--- /dev/null
+++ b/Configuration.md
@@ -0,0 +1,73 @@
+The script contains an array of configuration options which can be easily changed.
+
+### `auth`, `auth_source`
+see 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`.
\ No newline at end of file