Document read_only option for mounts (#2071)

This commit is contained in:
Mike Degatano 2024-03-01 09:53:12 -05:00 committed by GitHub
parent 8f9dc0a2d0
commit 8e100fdb4c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 7 additions and 3 deletions

View File

@ -1901,7 +1901,8 @@ Returns information about mounts configured in Supervisor
"type": "cifs",
"server": "server.local",
"share": "media",
"state": "active"
"state": "active",
"read_only": false
}
]
}
@ -1942,7 +1943,8 @@ Value in `name` must be unique and can only consist of letters, numbers and unde
"server": "server.local",
"share": "media",
"username": "admin",
"password": "password"
"password": "password",
"read_only": false
}
```
@ -1965,7 +1967,8 @@ name, it cannot be changed. Delete and re-add the mount to change the name.
"usage": "media",
"type": "nfs",
"server": "server.local",
"path": "/media/camera"
"path": "/media/camera",
"read_only": true
}
```

View File

@ -278,6 +278,7 @@ The `content` key of a backup object contains the following keys:
| usage | string | Usage of the mount (backup, media, or share) | both |
| server | string | IP address or hostname of the network share server | both |
| port | int | Port to use (if not using the standard one for the mount type) | both |
| read_only | bool | Mount is read-only (not available for backup mounts) | both |
| path | string | (nfs mounts only) Path to mount from the network share | both |
| share | string | (cifs mounts only) Share to mount from the network share | both |
| username | string | (cifs mounts only) Username to use for authentication | request only |