iobroker.staticsfilefolder 0.0.9 → 0.0.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -4
- package/io-package.json +4 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -21,10 +21,38 @@ This adapter acts as a web extension for the `ioBroker.web` adapter. It scans a
|
|
|
21
21
|
* **Smart Highlighting:** Files generated "Today" are distinctly highlighted with a vibrant design to stand out from historical archives.
|
|
22
22
|
* **Navigation:** Native "Forward" and "Back" navigation through folders.
|
|
23
23
|
|
|
24
|
-
###
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
24
|
+
### Configuration & Instance Settings
|
|
25
|
+
|
|
26
|
+
After installing the adapter, configure the following settings in the instance configuration page:
|
|
27
|
+
|
|
28
|
+
1. **Extend WEB adapter (webInstance):**
|
|
29
|
+
* **Description:** Select which running instance of the `ioBroker.web` adapter you want to bind this extension to (e.g. `web.0` or select `all` / `*` to extend all running web servers).
|
|
30
|
+
* **Why it matters:** This adapter serves the user interface through the web adapter server.
|
|
31
|
+
|
|
32
|
+
2. **Route path (route):**
|
|
33
|
+
* **Description:** The path name (slug) to access the document explorer page. For example, if you set this to `Omni`, the file explorer will be accessible at:
|
|
34
|
+
```
|
|
35
|
+
http://<your-iobroker-ip>:8082/Omni/
|
|
36
|
+
```
|
|
37
|
+
* **Default:** `staticsfilefolder` (which makes it accessible at `http://<your-iobroker-ip>:8082/staticsfilefolder/`).
|
|
38
|
+
|
|
39
|
+
3. **Static Files Directory (dirname):**
|
|
40
|
+
* **Description:** The absolute path to the folder on your ioBroker server's disk where your document archives or reports are located (e.g. `D:\OMNI` on Windows or `/var/reports` on Linux).
|
|
41
|
+
* **Why it matters:** All files and subfolders in this directory will be visible in the web explorer. Additionally, the adapter watches this directory for newly added files and updates ioBroker states when changes occur.
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
### Accessing the Web Interface
|
|
46
|
+
|
|
47
|
+
Once configured and the instance is running (green status):
|
|
48
|
+
1. Open your browser and navigate to:
|
|
49
|
+
```
|
|
50
|
+
http://<your-iobroker-ip>:8082/<your-route-path>/
|
|
51
|
+
```
|
|
52
|
+
*(Replace `<your-iobroker-ip>` with your server's IP, `8082` with your Web adapter port, and `<your-route-path>` with the **Route path** setting you defined, e.g. `Omni`).*
|
|
53
|
+
2. You will be greeted by the beautiful Single Page Application displaying your folders and files. You can click on directories to navigate them, or click on PDFs, Excel sheets, and Word documents to view them offline in the premium dark/light interface!
|
|
54
|
+
|
|
55
|
+
---
|
|
28
56
|
|
|
29
57
|
### Requirements
|
|
30
58
|
* Node.js 18.x or higher
|
package/io-package.json
CHANGED
|
@@ -1,8 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"common": {
|
|
3
3
|
"name": "staticsfilefolder",
|
|
4
|
-
"version": "0.0.
|
|
4
|
+
"version": "0.0.10",
|
|
5
5
|
"news": {
|
|
6
|
+
"0.0.10": {
|
|
7
|
+
"en": "Updated README.md with detailed instructions for instance configuration settings."
|
|
8
|
+
},
|
|
6
9
|
"0.0.9": {
|
|
7
10
|
"en": "Updated the adapter logo with a custom designed static files icon."
|
|
8
11
|
},
|