Update reference docs for chmod changes
Updated technical and test indexes to reflect shallow folder-list chmod behaviour and the new installer root-mode prompt.
@@ -2,7 +2,8 @@
2
2
3
3
## installsystemdservice.sh
4
4
- bool_is_true(value) - Parses common truthy string values used for installer feature flags.
5
- FILEMANAGER_SERVICE_RUN_AS_ROOT - Optional installer env flag; when true, writes a root-running systemd unit (omits User=) and enables FILEMANAGER_LIST_ACCESS_CHMOD in the unit environment.
5
- confirm_root_service_mode() - Interactive installer prompt (`[y/N]`) that decides whether the service should run as root when no env override is provided.
6
- FILEMANAGER_SERVICE_RUN_AS_ROOT - Optional installer env override for non-interactive installs; when truthy, writes a root-running systemd unit (omits User=) and enables FILEMANAGER_LIST_ACCESS_CHMOD in the unit environment.
6
7
7
8
## server/index.js
8
9
- start() - Initialises DB/keys, starts HTTP/HTTPS servers, and starts the background thumbnail cache loop.
@@ -86,7 +87,7 @@
86
87
- loadConfigAndRoots() - Loads config and effective roots together so route access checks stay consistent.
87
88
- parseOctalMode(rawValue, fallback) - Parses optional octal chmod mode overrides from environment variables and falls back to secure defaults when invalid.
88
89
- envFlagEnabled(name) - Boolean environment flag parser for file-route runtime feature toggles.
89
- applyRecursiveAccessChmod(startDir) - Best-effort recursive chmod pass used for Samba-style compatibility on folder-access requests; skips symlinks and continues past individual errors.
90
- applyListAccessChmod(startDir) - Best-effort shallow chmod pass for folder-access requests; updates the opened folder and its direct children only, skips symlinks, and continues past individual errors.
90
91
- resolveRootForUser(absPath, roots, user, config) - Resolves access for configured roots plus user-owned personal folder.
91
92
- resolveRootForUser(absPath, roots, user, config) - Allows admins to access orphaned user folders (deleted-account folders) under userPath.
92
93
- resolveRootForUser(absPath, roots, user, config) - Treats the local subtitle debug log directory as an admin-only read-only browse root for the debug menu.
@@ -103,7 +104,7 @@
103
104
- POST /api/files/folder-icon - Sets or clears a folder's explicit icon assignment; imagePath must have a cached thumbnail; write access required.
104
105
- GET /api/files/search - Fuzzy-searches all readable roots (and personal folder when configured) for files, returning ranked matches with path metadata.
105
106
- GET /api/files/list - Returns directory items including name/path/isDir plus size, mtime, and uploadedAt; uploadedAt comes from persisted `file_meta.uploaded_at` when present, otherwise it is backfilled from filesystem creation/change metadata and saved.
106
- GET /api/files/list - When FILEMANAGER_LIST_ACCESS_CHMOD=1, runs a best-effort recursive chmod on the opened folder before listing (defaults: dirs 0777, files 0666; overrides via FILEMANAGER_LIST_ACCESS_CHMOD_DIR_MODE and FILEMANAGER_LIST_ACCESS_CHMOD_FILE_MODE).
107
- GET /api/files/list - When FILEMANAGER_LIST_ACCESS_CHMOD=1, runs a best-effort shallow chmod on the opened folder before listing (opened folder + direct children only; defaults: dirs 0777, files 0666; overrides via FILEMANAGER_LIST_ACCESS_CHMOD_DIR_MODE and FILEMANAGER_LIST_ACCESS_CHMOD_FILE_MODE).
107
108
- GET /api/files/search-images - Fuzzy-searches readable roots for image files with ready thumbnails, returning capped results plus scan-truncation metadata for scalable global favicon selection.
108
109
- GET /api/files/global-favicon-image - Publicly serves the configured global favicon thumbnail file so browsers can load `<link rel="icon">` without auth headers.
109
110
- GET /api/files/global-favicon - Returns the configured global favicon source file path ({favicon:{filePath}} or {favicon:null}).
@@ -2,7 +2,8 @@2
2
3
## installsystemdservice.sh
3
## installsystemdservice.sh
4
- bool_is_true(value) - Parses common truthy string values used for installer feature flags.
4
- bool_is_true(value) - Parses common truthy string values used for installer feature flags.
5
- FILEMANAGER_SERVICE_RUN_AS_ROOT - Optional installer env flag; when true, writes a root-running systemd unit (omits User=) and enables FILEMANAGER_LIST_ACCESS_CHMOD in the unit environment.
5
- confirm_root_service_mode() - Interactive installer prompt (`[y/N]`) that decides whether the service should run as root when no env override is provided.
6
- FILEMANAGER_SERVICE_RUN_AS_ROOT - Optional installer env override for non-interactive installs; when truthy, writes a root-running systemd unit (omits User=) and enables FILEMANAGER_LIST_ACCESS_CHMOD in the unit environment.
6
7
7
## server/index.js
8
## server/index.js
8
- start() - Initialises DB/keys, starts HTTP/HTTPS servers, and starts the background thumbnail cache loop.
9
- start() - Initialises DB/keys, starts HTTP/HTTPS servers, and starts the background thumbnail cache loop.
@@ -86,7 +87,7 @@86
- loadConfigAndRoots() - Loads config and effective roots together so route access checks stay consistent.
87
- loadConfigAndRoots() - Loads config and effective roots together so route access checks stay consistent.
87
- parseOctalMode(rawValue, fallback) - Parses optional octal chmod mode overrides from environment variables and falls back to secure defaults when invalid.
88
- parseOctalMode(rawValue, fallback) - Parses optional octal chmod mode overrides from environment variables and falls back to secure defaults when invalid.
88
- envFlagEnabled(name) - Boolean environment flag parser for file-route runtime feature toggles.
89
- envFlagEnabled(name) - Boolean environment flag parser for file-route runtime feature toggles.
89
- applyRecursiveAccessChmod(startDir) - Best-effort recursive chmod pass used for Samba-style compatibility on folder-access requests; skips symlinks and continues past individual errors.
90
- applyListAccessChmod(startDir) - Best-effort shallow chmod pass for folder-access requests; updates the opened folder and its direct children only, skips symlinks, and continues past individual errors.
90
- resolveRootForUser(absPath, roots, user, config) - Resolves access for configured roots plus user-owned personal folder.
91
- resolveRootForUser(absPath, roots, user, config) - Resolves access for configured roots plus user-owned personal folder.
91
- resolveRootForUser(absPath, roots, user, config) - Allows admins to access orphaned user folders (deleted-account folders) under userPath.
92
- resolveRootForUser(absPath, roots, user, config) - Allows admins to access orphaned user folders (deleted-account folders) under userPath.
92
- resolveRootForUser(absPath, roots, user, config) - Treats the local subtitle debug log directory as an admin-only read-only browse root for the debug menu.
93
- resolveRootForUser(absPath, roots, user, config) - Treats the local subtitle debug log directory as an admin-only read-only browse root for the debug menu.
@@ -103,7 +104,7 @@103
- POST /api/files/folder-icon - Sets or clears a folder's explicit icon assignment; imagePath must have a cached thumbnail; write access required.
104
- POST /api/files/folder-icon - Sets or clears a folder's explicit icon assignment; imagePath must have a cached thumbnail; write access required.
104
- GET /api/files/search - Fuzzy-searches all readable roots (and personal folder when configured) for files, returning ranked matches with path metadata.
105
- GET /api/files/search - Fuzzy-searches all readable roots (and personal folder when configured) for files, returning ranked matches with path metadata.
105
- GET /api/files/list - Returns directory items including name/path/isDir plus size, mtime, and uploadedAt; uploadedAt comes from persisted `file_meta.uploaded_at` when present, otherwise it is backfilled from filesystem creation/change metadata and saved.
106
- GET /api/files/list - Returns directory items including name/path/isDir plus size, mtime, and uploadedAt; uploadedAt comes from persisted `file_meta.uploaded_at` when present, otherwise it is backfilled from filesystem creation/change metadata and saved.
106
- GET /api/files/list - When FILEMANAGER_LIST_ACCESS_CHMOD=1, runs a best-effort recursive chmod on the opened folder before listing (defaults: dirs 0777, files 0666; overrides via FILEMANAGER_LIST_ACCESS_CHMOD_DIR_MODE and FILEMANAGER_LIST_ACCESS_CHMOD_FILE_MODE).
107
- GET /api/files/list - When FILEMANAGER_LIST_ACCESS_CHMOD=1, runs a best-effort shallow chmod on the opened folder before listing (opened folder + direct children only; defaults: dirs 0777, files 0666; overrides via FILEMANAGER_LIST_ACCESS_CHMOD_DIR_MODE and FILEMANAGER_LIST_ACCESS_CHMOD_FILE_MODE).
107
- GET /api/files/search-images - Fuzzy-searches readable roots for image files with ready thumbnails, returning capped results plus scan-truncation metadata for scalable global favicon selection.
108
- GET /api/files/search-images - Fuzzy-searches readable roots for image files with ready thumbnails, returning capped results plus scan-truncation metadata for scalable global favicon selection.
108
- GET /api/files/global-favicon-image - Publicly serves the configured global favicon thumbnail file so browsers can load `<link rel="icon">` without auth headers.
109
- GET /api/files/global-favicon-image - Publicly serves the configured global favicon thumbnail file so browsers can load `<link rel="icon">` without auth headers.
109
- GET /api/files/global-favicon - Returns the configured global favicon source file path ({favicon:{filePath}} or {favicon:null}).
110
- GET /api/files/global-favicon - Returns the configured global favicon source file path ({favicon:{filePath}} or {favicon:null}).
@@ -47,7 +47,7 @@
47
47
- `GET /api/files/thumbnail`
48
48
- `GET /api/files/root-access`
49
49
- `orphaned user folder access`
50
- `list access recursive chmod`
50
- `list access chmod`
51
51
- `subtitle debug cache access`
52
52
- `folder icon endpoints`
53
53
- `file search endpoint`
@@ -47,7 +47,7 @@47
- `GET /api/files/thumbnail`47
- `GET /api/files/thumbnail`48
- `GET /api/files/root-access`48
- `GET /api/files/root-access`49
- `orphaned user folder access`49
- `orphaned user folder access`50
- `list access recursive chmod`50
- `list access chmod`51
- `subtitle debug cache access`51
- `subtitle debug cache access`52
- `folder icon endpoints`52
- `folder icon endpoints`53
- `file search endpoint`53
- `file search endpoint`