diff --git a/.eslintignore b/.eslintignore
index fa6ca0b..71ba64f 100755
--- a/.eslintignore
+++ b/.eslintignore
@@ -1,2 +1,2 @@
-**/vendors/**
+/src/core/vendors/
**/src/php/**
\ No newline at end of file
diff --git a/.eslintrc.json b/.eslintrc.json
index b895c76..663de60 100755
--- a/.eslintrc.json
+++ b/.eslintrc.json
@@ -25,6 +25,8 @@
"no-dupe-class-members": "error",
"@typescript-eslint/no-explicit-any": "off",
"@typescript-eslint/no-namespace": "off",
+ "@typescript-eslint/no-this-alias": "off",
+ "@typescript-eslint/no-empty-function": "off",
"indent": [
"error",
"tab",
diff --git a/.gitattributes b/.gitattributes
index 1a6aaa8..ae95dbb 100755
--- a/.gitattributes
+++ b/.gitattributes
@@ -1,2 +1,6 @@
+# Git attributes
+
+# Mark vendored and documentation
extras/* linguist-vendored=true
-docs/* linguist-documentation=true
\ No newline at end of file
+docs/* linguist-documentation=true
+build/* linguist-generated=true
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..e7eed02
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,42 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: ''
+assignees: sixem
+
+---
+
+
Attempt to fill out this form as well as possible. If you can't answer a question, you can skip it.
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+If relevant, the steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Features used**
+Please fill out the features that are enabled:
+ - Performance mode: [e.g. yes/no]
+ - Single page: [e.g. yes/no]
+
+**Information**
+If possible, fill out the data:
+ - PHP version: [e.g. 7.4]
+ - Browser used: [e.g. FireFox/Chrome]
+
+**Errors**
+If possible, copy any console errors that may occur with debugging enabled. If the page fails to load, you can check your web server logs for any errors.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..9cae32f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[REQUEST]"
+labels: ''
+assignees: sixem
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
new file mode 100644
index 0000000..c6e6edb
--- /dev/null
+++ b/.github/workflows/main.yml
@@ -0,0 +1,45 @@
+name: Build
+
+on:
+ push:
+ branches: [ master ]
+ pull_request:
+ branches: [ master ]
+ workflow_dispatch:
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v4
+ - name: Setup Node.js
+ uses: actions/setup-node@v4
+ with:
+ node-version: '20'
+
+ - name: Cache modules
+ uses: actions/cache@v4
+ with:
+ path: ~/.npm
+ key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+ restore-keys: |
+ ${{ runner.os }}-node-
+
+ - name: Install dependencies
+ run: npm install
+
+ - name: Run tests
+ run: npm test
+
+ - name: Build
+ run: npm run build
+
+ - name: Build standalone
+ run: npm run make-standalone
+
+ - name: Archive production artifacts
+ uses: actions/upload-artifact@v4
+ with:
+ name: build
+ path: build/
diff --git a/.gitignore b/.gitignore
index b343f46..c0b5197 100755
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,6 @@
node_modules/
build/
docker/public
-.DS_Store
*.7z
*.zip
+*.ignore
diff --git a/.stylelintrc.json b/.stylelintrc.json
index 613f4f9..7fd8705 100755
--- a/.stylelintrc.json
+++ b/.stylelintrc.json
@@ -3,6 +3,8 @@
"rules": {
"selector-class-pattern": null,
"selector-id-pattern": null,
- "no-descending-specificity": null
+ "no-descending-specificity": null,
+ "color-function-notation": "modern",
+ "hue-degree-notation": "angle"
}
}
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
index a071c1d..0dcb2f7 100755
--- a/LICENSE
+++ b/LICENSE
@@ -1,4 +1,4 @@
- Licensed under GPL-3.0 - Copyright (c) 2022 emy (sixem) | five.sh
+ Licensed under GPL-3.0 - Copyright (c) 2023 emy (sixem) | five.sh
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
diff --git a/README.md b/README.md
index 37ce6a3..fabd0bc 100755
--- a/README.md
+++ b/README.md
@@ -1,172 +1,106 @@
-
-
-
+
+
+
+
+
IVFi-PHP
+
The image and video friendly indexer
+
-
- An image and video friendly Indexer
-
+
-
-
-
-
-
----
-
-## What is this project?
-
-This is a file directory browser script written in PHP and TypeScript.
-
-This is designed to be a image and video friendly Indexer, while also being an Indexer that has all of the other features that you can expect from most directory listers out there. It can be heavily customized, and has a design that attempts to be appealing while also being functional and easy to use.
-
-***Note: The Indexer can be used without JavaScript enabled, but it is needed for the extra functionality.***
-
-## Demo
-***You can visit the [demo](https://five.sh/demo/indexer/) to view the indexer in action.***
-
-## Documentation
-:link:
-
-## Feedback :bulb:
-I'm open for any feedback.
-
-You can open an [issue](https://github.com/sixem/eyy-indexer/issues) if you encounter any **specific** problems or bugs of any kind.
-
-Or, you can start a [discussion](https://github.com/sixem/eyy-indexer/discussions) if you just have any general questions or minor issues you want to troubleshoot. You can also suggest any features or potential changes there.
-
-# Features
-### **Authentication**
-The script supports HTTP authentication, allowing you to add a bit of protection to your directories.
-### **Gallery Mode**
-A gallery mode where you can view images and videos of the current directory without needing to visit each URL separately. It has support for downloading files and reverse searching images.
-### **Hover Previews**
-Displays a preview of the image or video when hovering over the name.
-### **Search Filter**
-The search filter can be used to search for filenames or filetypes in the current directory.
-Usage (Desktop): `Shift + F`.
-### **Single file**
-This script can be set up as a single file script (standalone setup). Only one file needed, nothing more.
-### **Customizable**
-This script can be customized in a number of ways.
-### **Additonal Features**
-It can be built with additional features, like support for displaying `README.md` files on each directory!
-### **And much more ..**
-+ All dates will match the timezone of the client.
-+ Persistent client-set sorting settings.
-+ Support for custom themes.
-+ Server-side filtering which can help you hide specific files or folders.
-+ Paths can be clicked, allowing for easy navigation between folders.
-+ The client can set their own settings in the menu.
-+ Direct download links.
-+ Mobile friendly.
-
-# Setup
-
-### Download the latest release [HERE](https://github.com/sixem/eyy-indexer/releases)!
+
-Alternatively, you can also build it from source yourself, for that see: [Building](#building).
+
-You can also find every release and specific builds here: [https://five.sh/releases/eyy-indexer/](https://five.sh/releases/eyy-indexer/)
-
-
-#### These instructions are aimed at servers using a regular Nginx or Apache setup.
-#### For instructions on how to use it with Docker, see [this](https://sixem.github.io/eyy-indexer/#/setup?id=docker).
+
-## 1. Files
+
-You can choose between having a **default** setup and a **standalone** setup.
+# About
-The default setup will import assets (`js`, `css` and fonts) as separate files, like most sites. This is the normal setup.
+IVFi-PHP is a file directory browser script made in PHP and TypeScript.
-The standalone setup will have all of these files bundled directly into the `.php` file instead, serving everything through HTML.
+It is designed to be a comprehensive indexer, with a focus on efficiently handling image and video files. IVFi has a modern and user-friendly interface, offering features such as a gallery view, hoverable previews, and many customization options.
-### Default:
-Place the files from the `build` directory into your root web directory.
-### Standalone (single file):
-Place the file from the `standalone` directory into your root web directory.
+This project can be easily set up on most web servers.
-## 2. Server Configuration
+
-The Indexer does require you to use it as an `index` file, that way it can be automatically applied to directories that do not have a defualt `index` file present. This makes it behave just like any other default and built-in directory indexes. This can all be done easily by following the steps below, **depending** on what web server you are using.
+# Quick setup :zap:
-### Nginx
-To use this script for all directories without a default index you need append `/indexer.php` to the end of your `index` line in your server configuration. This will tell Nginx to use the Indexer if none of the default indexes exist.
+* Download the latest release [here](https://github.com/sixem/ivfi-php/releases).
+* Place the `/build/` files into your web root. For example `/var/www/html/`.
+* Then, use the `indexer.php` as an index file for any of the directories where the script should be used:
-Example usage:
+#### Nginx - Example using the [index](https://nginx.org/en/docs/http/ngx_http_index_module.html#index) directive:
```
server {
index index.html index.php /indexer.php;
}
-
```
-Another example, here it is only being applied to a few directories:
-```
-server {
- location ~ ^/(videos|images)/ {
- index /indexer.php;
- }
-}
-```
-### Apache
-In order to automatically use this script as a default index, you need to edit your Apache configuration. To do this, you must place `/indexer.php` at the end of your `DirectoryIndex` directive.
-
-Example usage:
+#### Apache - Example using the [DirectoryIndex](https://httpd.apache.org/docs/2.4/mod/mod_dir.html#directoryindex) directive:
```
DirectoryIndex index.html index.php /indexer.php
```
-This line can be placed in either your server's `.conf` file or your `.htaccess` file. This will tell Apache to use the Indexer if none of the default indexes exist. This can be set globally or on a per-directory basis depending on your usecase.
-
-# Configuration
-
-#### See [Configuration](https://sixem.github.io/eyy-indexer/) for a detailed overview over how this script can be customized.
+
-## Additional features
+For detailed instructions on how to configure the script, refer to [setup](https://git.five.sh/ivfi/docs/php/#/setup).
-When building the Indexer, additional features can be enabled. These features are not bundled with the pre-built releases, and must be flagged as enabled prior to building the Indexer yourself (see below for how the building process is done).
+The releases and individual builds are available [here](https://git.five.sh/ivfi/releases/php/).
-The reason why these features are not included in the default version, is because they may rely on larger libraries and other scripts, which I don't feel should be pushed into the vanilla version unless the user desires to do so themselves!
+
-See [Extra Features](https://sixem.github.io/eyy-indexer/#/extras) for a list over the features and how these can be implemented.
-
-# Building
-:grey_exclamation: **This has been tested to work with node 18.3**
+# Features
-You can build this script from source using `node` and `npm`.
+### **Authentication**
+> It includes support for HTTP authentication, providing some added security for your directories.
+### **Gallery Mode**
+> A gallery mode that allows you to view images and videos from the current directory in one place, as well as the ability to download files and perform reverse image searches.
+### **Hover Previews**
+> An image or video preview is displayed when hovering over the file name.
+### **Search Filter**
+> The filter function allows you to search for specific filenames or file types within the directory.
Usage (Desktop): `Shift + F`.
+### **Single file**
+> The script can be configured as a standalone solution, where all required assets are combined into a single file, making it easy to use with just one file needed.
+### **Customizable**
+> This script offers multiple customization options.
+### **Additonal Features**
+> It can be built with added functionality, such as the ability to display `README.md` files in each directory!
-**Clone repository and install dependencies:**
-```
-git clone https://github.com/sixem/eyy-indexer
-cd eyy-indexer
-npm install
-```
+
-## Production builds
+### **And much more ...**
++ :clock12: The dates will be adjusted to match the time zone of the client.
++ :arrow_up_down: Client-defined sorting preferences are stored persistently.
++ :art: Support for custom themes.
++ :mag: Server-side filtering which can help you hide specific files or folders.
++ :link: Navigating between folders is made easy with the clickable paths.
++ :gear: The client has the option to personalize their settings through the menu.
++ :inbox_tray: Direct download links for all files.
++ :desktop_computer: Compatible with both mobile and desktop devices.
-Build from source, creating minified files:
-```
-npm run build
-```
+
-Build a standalone file from source:
-```
-npm run make-standalone
-```
+# Feedback
-## Development builds
+If you have come across any specific problems or bugs that you would like to report, you have the option to open an [issue](https://github.com/sixem/ivfi-php/issues). This will allow us to better understand the issue at hand and take the necessary steps to resolve it.
-Build source mapped, non-production files:
-```
-npm run build-dev
-```
+Alternatively, if you have any general questions, minor issues, or ideas for improvements that you would like to discuss, you can start a [discussion](https://github.com/sixem/ivfi-php/discussions). This is a good way for you to share your thoughts and ideas with us, and we would be more than happy to listen and consider them.
-# Contributing
-You can contribute by either submitting a pull request, reporting issues or bugs, or voicing good ideas. It's all very much welcome! :relaxed:
+
## License
-This project is licensed under GPL-3.0. It also includes external libraries that are available under a variety of licenses. See [LICENSE](LICENSE) for the full license text.
+This project is licensed under GPL-3.0. It also includes external libraries that are available under a variety of licenses.
+
+See [LICENSE](LICENSE) for the full license text.
## Disclaimer
-**As you with anything else, use this script at your own risk. There may exist bugs that i do not know of.**
\ No newline at end of file
+As with anything else, use this script at your own risk. There could exist bugs that I do not know of :v:
diff --git a/build.helpers.js b/build.helpers.js
index b6d5528..152b46c 100755
--- a/build.helpers.js
+++ b/build.helpers.js
@@ -1,4 +1,4 @@
-const fs = require('fs');
+import fs from 'fs';
/**
* Strips the opening/closing tags from code.
@@ -39,7 +39,7 @@ const stripOuterTags = (data, tags) =>
return data;
};
-exports.exit = (...message) =>
+const exit = (...message) =>
{
console.log(`\nExiting -`, ...message);
process.exit(1);
@@ -50,7 +50,7 @@ exports.exit = (...message) =>
*
* @param {string} path
*/
-exports.readJson = (path) =>
+const readJson = (path) =>
{
let data = false;
@@ -73,7 +73,7 @@ exports.readJson = (path) =>
/**
* Extractors for fetching/reading extra build files
*/
- exports.extractors = {
+const extractors = {
filePhp: (path, options = {}) =>
{
let data = null;
@@ -130,7 +130,7 @@ exports.readJson = (path) =>
}
};
-exports.trimPartPath = (path) =>
+const trimPartPath = (path) =>
{
if(path[0] === '/' || path[0] === '\\')
{
@@ -141,4 +141,11 @@ exports.trimPartPath = (path) =>
}
return path;
+};
+
+export default {
+ exit,
+ readJson,
+ extractors,
+ trimPartPath
};
\ No newline at end of file
diff --git a/docker/nginx/nginx.conf b/docker/nginx/nginx.conf
index f3ad496..0c4ba22 100755
--- a/docker/nginx/nginx.conf
+++ b/docker/nginx/nginx.conf
@@ -1,4 +1,5 @@
server {
+ # HTTP
listen 80;
# Location of indexer files
@@ -26,11 +27,12 @@ server {
index /indexer.php;
}
+ # Handle PHP files
location ~ ^/.+\.php(/|$) {
try_files $uri =404;
+ # FastCGI params
fastcgi_split_path_info ^(.+\.php)(/.+)$;
-
fastcgi_pass php:9000;
fastcgi_index index.php;
diff --git a/docs/README.md b/docs/README.md
index 482586f..d4e2b0e 100755
--- a/docs/README.md
+++ b/docs/README.md
@@ -3,12 +3,12 @@
- An image and video friendly Indexer
+ The image and video friendly Indexer
-
-
+
+
---
@@ -24,9 +24,9 @@ This is designed to be a image and video friendly Indexer, while also being an I
## Feedback
I'm open for any feedback.
-You can open an [issue](https://github.com/sixem/eyy-indexer/issues) if you encounter any **specific** problems or bugs of any kind.
+You can open an [issue](https://github.com/sixem/ivfi-php/issues) if you encounter any **specific** problems or bugs of any kind.
-Or, you can start a [discussion](https://github.com/sixem/eyy-indexer/discussions) if you just have any general questions or minor issues you want to troubleshoot. You can also suggest any features or potential changes there.
+Or, you can start a [discussion](https://github.com/sixem/ivfi-php/discussions) if you just have any general questions or minor issues you want to troubleshoot. You can also suggest any features or potential changes there.
## Demo
@@ -75,7 +75,7 @@ This project is licensed under GPL-3.0.
It also includes external libraries that are available under a variety of licenses.
-See [LICENSE](https://github.com/sixem/eyy-indexer/blob/master/LICENSE) for the full license text.
+See [LICENSE](https://github.com/sixem/ivfi-php/blob/master/LICENSE) for the full license text.
## Disclaimer
**As you with anything else, use this script at your own risk. There may exist bugs that i do not know of.**
\ No newline at end of file
diff --git a/docs/_coverpage.md b/docs/_coverpage.md
index 5d0751d..063b45d 100755
--- a/docs/_coverpage.md
+++ b/docs/_coverpage.md
@@ -1,10 +1,12 @@
-# eyy-indexer docs
+
-> An image and video friendly Indexer
+# IVFi-PHP docs
-* Customizable and easy to use
+> Documentation
-[GitHub](https://github.com/sixem/eyy-indexer)
-[Get Started](README)
\ No newline at end of file
+* The image and video friendly indexer
+
+[GitHub](https://github.com/sixem/ivfi-php)
+[Get Started](setup.md)
\ No newline at end of file
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
index 195be0a..2ba179c 100755
--- a/docs/_sidebar.md
+++ b/docs/_sidebar.md
@@ -1,12 +1,18 @@
-* [Overview](README.md "eyy-indexer (Documentation)")
-* [Setup](setup.md "eyy-indexer (Setup)")
-* [Configuration](config.md "eyy-indexer (Configuration)")
-* [Advanced](advanced.md "eyy-indexer (Advanced)")
- * [Performance Mode](performance.md "eyy-indexer (Performance Mode)")
- * [Processor](processor.md "eyy-indexer (Processor)")
- * [Extra Features](extras.md "eyy-indexer (Extras)")
-* [Building](building.md "eyy-indexer (Building)")
+* [Overview](README.md "IVFi-PHP (Documentation)")
+* [Setup](setup.md "IVFi-PHP (Setup)")
+* [Configuration](config.md "IVFi-PHP (Configuration)")
+* [Themes](themes.md "IVFi-PHP (Themes)")
+* [Advanced](advanced.md "IVFi-PHP (Advanced)")
+ * [Performance Mode](performance.md "IVFi-PHP (Performance Mode)")
+ * [Processor](processor.md "IVFi-PHP (Processor)")
+ * [Extra Features](extras.md "IVFi-PHP (Extras)")
+ * [Dotfile](dotfile.md "IVFi-PHP (Dotfile)")
+* [Building](building.md "IVFi-PHP (Building)")
----
\ No newline at end of file
+---
+
+
+ IVFi-PHP
+
\ No newline at end of file
diff --git a/docs/advanced.md b/docs/advanced.md
index 71669a2..f86b184 100755
--- a/docs/advanced.md
+++ b/docs/advanced.md
@@ -11,4 +11,7 @@
* Handle processed data with a self-defined function.
[Extra Features](extras.md)
- * Compile the Indexer with extrea features.
\ No newline at end of file
+ * Compile the Indexer with extrea features.
+
+[Dotfile](dotfile.md)
+ * Directory-specific configuration using dotfiles.
\ No newline at end of file
diff --git a/docs/building.md b/docs/building.md
index 29be6bf..56ca060 100755
--- a/docs/building.md
+++ b/docs/building.md
@@ -8,8 +8,8 @@ You can build this script from source using `node` and `npm`.
**Clone repository and install dependencies:**
```bash
-git clone https://github.com/sixem/eyy-indexer
-cd eyy-indexer
+git clone https://github.com/sixem/ivfi-php
+cd ivfi-php
npm install
```
diff --git a/docs/config.md b/docs/config.md
index 7b34d5b..671fa8d 100755
--- a/docs/config.md
+++ b/docs/config.md
@@ -164,6 +164,25 @@ If the value is a function, then the returned string of that function will be us
* `$param['config']` contains the parsed and active configuration.
+## Metadata
+Key: **`metadata`**
+
+This option will add metadata to the header. This can be set globally using this option, or you can also set it on a per-directory basis using [dotfiles](dotfile.md).
+
+Example:
+```php
+ [
+ [
+ 'property' => 'og:title',
+ 'content' => 'This is a title!'
+ ]
+ ],
+ );
+?>
+```
+
## Style
Key: **`style`**
@@ -173,7 +192,7 @@ The `compact` setting can be changed by the client in the settings menu, as can
| Child key | Type | Default | Description |
|-----|------|---------|-------------|
-| `themes => path` | Bool/String | `false` | Set to a path relative to the root directory containing `.css` files (example: `/indexer/css/themes/`). Every `.css` file in the set folder will be treated as a separate theme.
+| `themes => path` | Bool/String | `/indexer/themes/` | Set to a path relative to the root directory containing `.css` files. Every `.css` file in the set folder will be treated as a separate theme.
| `themes => default` | Bool/String | `false` | Default theme for new clients to use. Takes a filename **without** the `.css` extension.
| `css => additional` | Array/String | `false` | Adds any additional CSS to the page. Can either be a pure CSS `string` or an `array` where the key is the selector and where the child keys and values are properties and values respectively.
| `compact` | Bool | `false` | Makes the page use a more compact and centered style.
@@ -183,13 +202,13 @@ Key: **`filter`**
This option can be used if you want to filter the files or directories using `regular expressions`.
-All filenames and directory names **matching** the `regex` will be shown.
+All filenames and directory names **matching** the `regex` will be shown. Please note that directory names will always end in a slash (`/`), this is done to make them easier to differentiate from files.
For example, setting `file` to `/^.{1,10}\.(jpg|png)$/` will only include `.jpg` and `.png` files with a filename between `1 - 10` characters in length when reading the directory files.
#### Another is example is when you want to hide files with invalid characters or specific filenames:
- `'/^(?:(?!\b(README.md|secret.pwd)\b).)*$/'`
+ `'/^(?!README\.md$|secret\.pwd$).*$/'`
This example will hide any `README.md` and `secret.pwd` files from the directory.
`'/^[^\#\?]*$/'`
@@ -199,7 +218,7 @@ If you want to apply multiple filters easily, then you can also pass them as an
```php
'filter' => array(
'file' => array(
- '/^(?:(?!\b(README.md|secret.pwd)\b).)*$/',
+ '/^(?!README\.md$|secret\.pwd$).*$/',
'/^[^\#\?]*$/'
),
'directory' => false
@@ -214,6 +233,20 @@ Setting the value to `false` will disable the filter.
| `file` | Bool/String/Array | `false` | A `regexp` filter for what files should be included.
| `directory` | Bool/String/Array | `false` | A `regexp` filter for what directories should be included.
+## Exclude
+Key: **`exclude`**
+
+This option will exclude certain extensions from showing up in any directory.
+
+An example that'll exclude any `jpg` or `jpeg` files:
+```php
+ ["jpg", "jpeg"]
+ );
+?>
+```
+
## Directory Sizes
Key: **`directory_sizes`**
diff --git a/docs/dotfile.md b/docs/dotfile.md
new file mode 100644
index 0000000..501ec71
--- /dev/null
+++ b/docs/dotfile.md
@@ -0,0 +1,46 @@
+
Dotfile
+
+
+
+If a directory contains an `.ivfi` dotfile, the script will read the options from the file and enable those settings for that directory only.
+
+The script expects the file to be in a JSON format, like this template:
+```json
+{
+ "metadata": [],
+ "metadataBehavior": "overwrite",
+ "ignore": [],
+ "exclude": []
+}
+```
+### metadata
+An array of objects containg the attributes (keys) and values for the metadata elements.
+
+* Example: ```[ { "property": "description", "content": "A description." } ]```
+* type: ``
+
+---
+
+### metadataBehavior
+Sets the override behavior of the metadata options. If using `overwrite` it'll override any existing values should they already exist, but keep any existing, unchanged values. Using `replace` will simply remove all previous metadata in favor of the new data, this also applies to any `charset` or `viewport` metadata set by the script.
+
+*The dotfile metadata will always take priority over the configuration values when using overwrite.*
+
+* default: `overwrite`
+* type: `'string'`
+
+---
+
+### ignore
+An array of strings that will act as a filter for the current file data. Directories will always end in a `/` for easier identification. Any files or directories matching an item in this array will be hidden. It supports basic wildcards.
+
+* Example: ```[ "*.md", "image.png", "directory/"]```
+* type: ``
+
+---
+
+### exclude
+An array of strings that will act in a similar way as the ignore option, however, this will only apply to extensions, so any files matching the extensions that are in this array will be hidden.
+
+* Example: ```[ "md", "ini" ]```
+* type: ``
diff --git a/docs/extras.md b/docs/extras.md
index e1b2196..45f9022 100755
--- a/docs/extras.md
+++ b/docs/extras.md
@@ -6,7 +6,7 @@ The `extras` directory contains extra features for the Indexer.
These features must be compiled independently, as they are not available in any official releases.
-To build the Indexer with these features, find and edit [build.options.json](https://github.com/sixem/eyy-indexer/blob/master/build.options.json) in the base directory of the repository.
+To build the Indexer with these features, find and edit [build.options.json](https://github.com/sixem/ivfi-php/blob/master/build.options.json) in the base directory of the repository.
Simply set the value of any corresponding key under `extraFeatures` to `true` or `false` to enable and disable the feature respectively during compilation.
diff --git a/docs/greeterLogo.svg b/docs/greeterLogo.svg
new file mode 100644
index 0000000..f62e144
--- /dev/null
+++ b/docs/greeterLogo.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/docs/index.html b/docs/index.html
index 604f279..ae74bb0 100755
--- a/docs/index.html
+++ b/docs/index.html
@@ -2,11 +2,19 @@
- eyy-indexer (Documentation)
-
+ IVFi-PHP (Documentation)
+
+
-
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
\ No newline at end of file
diff --git a/docs/setup.md b/docs/setup.md
index fed1a02..a143ef5 100755
--- a/docs/setup.md
+++ b/docs/setup.md
@@ -5,9 +5,9 @@
## Download
-
## Files
@@ -61,8 +61,8 @@ The script can also be run through a simple docker container using `docker compo
#### Clone the repository and install dependencies:
`npm install` can be skipped if you are manually creating `docker/public` without building from source.
```bash
-git clone https://github.com/sixem/eyy-indexer
-cd eyy-indexer
+git clone https://github.com/sixem/ivfi-php
+cd ivfi-php
npm install
```
diff --git a/docs/themes.md b/docs/themes.md
new file mode 100755
index 0000000..7386aef
--- /dev/null
+++ b/docs/themes.md
@@ -0,0 +1,30 @@
+
Themes
+
+
Overview and theme usage.
+
+
+## Overview
+IVFi-PHP supports custom themes. By default, you can place any themes in `/indexer/themes/`, and they'll be automatically applied. If you want to customize the path or the default theme, then you can use the below instructions.
+
+You can find a list of official themes here: [IVFi-themes](https://github.com/sixem/ivfi-themes), or you can create your own!
+
+## Usage
+* 1) Download or create the themes that you wish to use.
+* 2) Place them in a publicly available directory.
+ * Example: `/indexer/themes/`
+* 3) Edit the configuration:
+ * Set the `path` to the relative directory of the themes.
+ * If you want a theme to be the default, then set `default` to the theme's name.
+```php
+ [
+ 'themes' => [
+ 'path' => '/indexer/themes/',
+ 'default' => false
+ ]
+ ]
+];
+?>
+```
+* 4) You should now be able to enable different themes in the settings menu (⚙️ in the top right corner).
\ No newline at end of file
diff --git a/extras/readmeSupport/css/stylesheet.css b/extras/readmeSupport/css/stylesheet.css
deleted file mode 100755
index 0745a16..0000000
--- a/extras/readmeSupport/css/stylesheet.css
+++ /dev/null
@@ -1,40 +0,0 @@
-.readmeContainer
-{
- background-color: #121318;
- margin-bottom: 18px;
- border-top: 1px solid #19191d;
- border-bottom: 1px solid #19191d;
-}
-
-.readmeContainer pre
-{
- white-space: pre-wrap;
-}
-
-.readmeContainer > div.readmeContents
-{
- padding: 5px 8px;
-}
-
-.readmeContainer a
-{
- text-decoration: none;
- color: #d6d3ce;
- font-weight: bold;
-}
-
-.readmeContainer a:hover
-{
- text-decoration: underline;
- color: #5e74ea;
-}
-
-.readmeContainer::before
-{
- content: "README.md";
- background-color: #15161e;
- display: block;
- padding: 3px 8px 5px 6px;
- color: #939498;
- border-bottom: 1px solid #151822;
-}
\ No newline at end of file
diff --git a/extras/readmeSupport/data.json b/extras/readmeSupport/data.json
index e1e3258..efe5663 100755
--- a/extras/readmeSupport/data.json
+++ b/extras/readmeSupport/data.json
@@ -15,14 +15,6 @@
"options": {
"stripTags": false
}
- },
- "STYLESHEET": {
- "path": "css/stylesheet.css",
- "extractor": "fileCss",
- "type": "additonalCss",
- "options": {
- "minimize": true
- }
}
}
}
\ No newline at end of file
diff --git a/extras/readmeSupport/display/displayReadme.php b/extras/readmeSupport/display/displayReadme.php
index 622307f..9b85c23 100755
--- a/extras/readmeSupport/display/displayReadme.php
+++ b/extras/readmeSupport/display/displayReadme.php
@@ -7,8 +7,12 @@
);
echo sprintf(
- '
This error occurs when the requested directory is below the directory of the PHP file.'.
- ($e->getCode() === 1 ? ' You can try setting path_checking to weak if you are working with symbolic links etc.' : '') . '
';
+ echo Helpers::createElement(
+ 'p', [], sprintf(
+ 'This error occurs when the requested directory is below the directory of the PHP file. %s',
+ $eCode === 1
+ ? (
+ ' You can try setting path_checking to weak ' .
+ 'if you are working with symbolic links etc.'
+ )
+ : ''
+ )
+ );
}
- exit('
-
+ 
