docs: document list roots
Update documentation to note that the uds now supports templates. Signed-off-by: Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
parent
bb7cd27be5
commit
ddf3325dae
|
@ -52,8 +52,12 @@ ssl_port: 7130
|
||||||
# server will only be started of the certificate and key options outlined
|
# server will only be started of the certificate and key options outlined
|
||||||
# below are provided. The default is 7130.
|
# below are provided. The default is 7130.
|
||||||
klippy_uds_address: /tmp/klippy_uds
|
klippy_uds_address: /tmp/klippy_uds
|
||||||
# The address of Unix Domain Socket used to communicate with Klippy. Default
|
# The address of Unix Domain Socket used to communicate with Klippy. This
|
||||||
# is /tmp/klippy_uds
|
# option accepts Jinja2 Templates, where the configured data path is
|
||||||
|
# passed to the template context, for example:
|
||||||
|
# klippy_uds_address: {data_path}/comms/klippy.sock
|
||||||
|
#
|
||||||
|
# Default is /tmp/klippy_uds.
|
||||||
max_upload_size: 1024
|
max_upload_size: 1024
|
||||||
# The maximum size allowed for a file upload (in MiB). Default is 1024 MiB.
|
# The maximum size allowed for a file upload (in MiB). Default is 1024 MiB.
|
||||||
enable_debug_logging: False
|
enable_debug_logging: False
|
||||||
|
|
|
@ -1559,6 +1559,58 @@ A list of objects, where each object contains file data.
|
||||||
]
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
A list of objects, where each object contains file data:
|
||||||
|
|
||||||
|
```json
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"name": "config",
|
||||||
|
"path": "/home/pi/printer_data/config",
|
||||||
|
"permissions": "rw"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "logs",
|
||||||
|
"path": "/home/pi/printer_data/logs",
|
||||||
|
"permissions": "r"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "gcodes",
|
||||||
|
"path": "/home/pi/printer_data/gcodes",
|
||||||
|
"permissions": "rw"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "config_examples",
|
||||||
|
"path": "/home/pi/klipper/config",
|
||||||
|
"permissions": "r"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "docs",
|
||||||
|
"path": "/home/pi/klipper/docs",
|
||||||
|
"permissions": "r"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
#### List registered roots
|
||||||
|
Reports all "root" directories registered with Moonraker. Information
|
||||||
|
such as location on disk and permissions are included.
|
||||||
|
|
||||||
|
HTTP request:
|
||||||
|
```http
|
||||||
|
GET /server/files/roots
|
||||||
|
```
|
||||||
|
|
||||||
|
JSON-RPC request:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"jsonrpc": "2.0",
|
||||||
|
"method": "server.files.roots",
|
||||||
|
"id": 4644
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
#### Get gcode metadata
|
#### Get gcode metadata
|
||||||
Get metadata for a specified gcode file. If the file is located in
|
Get metadata for a specified gcode file. If the file is located in
|
||||||
a subdirectory, then the file name should include the path relative to
|
a subdirectory, then the file name should include the path relative to
|
||||||
|
@ -3490,6 +3542,7 @@ and `fluidd` are present as clients configured in `moonraker.conf`
|
||||||
"need_channel_update": false,
|
"need_channel_update": false,
|
||||||
"is_valid": true,
|
"is_valid": true,
|
||||||
"configured_type": "git_repo",
|
"configured_type": "git_repo",
|
||||||
|
"corrupt": false,
|
||||||
"info_tags": [],
|
"info_tags": [],
|
||||||
"detected_type": "git_repo",
|
"detected_type": "git_repo",
|
||||||
"remote_alias": "arksine",
|
"remote_alias": "arksine",
|
||||||
|
@ -3534,6 +3587,7 @@ and `fluidd` are present as clients configured in `moonraker.conf`
|
||||||
"need_channel_update": false,
|
"need_channel_update": false,
|
||||||
"is_valid": true,
|
"is_valid": true,
|
||||||
"configured_type": "git_repo",
|
"configured_type": "git_repo",
|
||||||
|
"corrupt": false,
|
||||||
"info_tags": [],
|
"info_tags": [],
|
||||||
"detected_type": "git_repo",
|
"detected_type": "git_repo",
|
||||||
"remote_alias": "origin",
|
"remote_alias": "origin",
|
||||||
|
@ -3614,6 +3668,11 @@ as applications have the following fields:
|
||||||
and an "origin" set to the official remote. For `zip` and `zip_beta`
|
and an "origin" set to the official remote. For `zip` and `zip_beta`
|
||||||
types this will report false if Moonraker is unable to fetch the
|
types this will report false if Moonraker is unable to fetch the
|
||||||
current repo state from GitHub.
|
current repo state from GitHub.
|
||||||
|
- `corrupt`: Indicates that the git repo has been corrupted. When a repo
|
||||||
|
is in this state it a hard recovery (ie: re-cloning the repo) is necessary.
|
||||||
|
Note that the most common cause of repo corruption is removing power from
|
||||||
|
the host machine without safely shutting down. Damaged storage can also
|
||||||
|
lead to repo corruption.
|
||||||
- `is_dirty`: true if the repo has been modified. This will always be false
|
- `is_dirty`: true if the repo has been modified. This will always be false
|
||||||
for `zip` and `zip_beta` types.
|
for `zip` and `zip_beta` types.
|
||||||
- `detached`: true if the repo is currently in a detached state. For `zip`
|
- `detached`: true if the repo is currently in a detached state. For `zip`
|
||||||
|
|
Loading…
Reference in New Issue