Mirrors/sftpgo
1
0
Fork 0
mirror of https://github.com/drakkan/sftpgo.git synced 2025-12-06 14:20:55 +03:00
Code Issues Packages Projects Releases Wiki Activity

httpfs: add support for UNIX domain sockets

Browse Source 
Signed-off-by: Nicola Murino <nicola.murino@gmail.com>
This commit is contained in:
Nicola Murino
2022-06-12 18:29:49 +02:00
parent 0b9a96ec6b
commit 6f4475ff72
7 changed files with 158 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/httpfs.md
View File

@@ -16,3 +16,12 @@ Here is a mapping between HTTP response codes and protocol errors:
- `501`, means not supported error
- `200`, `201`, mean no error
- any other response code means a generic error
HTTPFs can also connect to UNIX domain sockets. To use UNIX domain sockets you need to set an endpoint with the following conventions:
- the URL schema can be `http` or `https` as usual.
- The URL host must be `unix`.
- The socket path is mandatory and is set using the `socket_path` query parameter. The path must be query escaped.
- The optional API prefix can be set using the `api_prefix` query parameter. The prefix must be query escaped.
Here is an example endpoint for UNIX domain socket connections: `http://unix?socket_path=%2Ftmp%2Fsftpgofs.sock&api_prefix=%2Fapi%2Fv1`. In this case we are connecting using the `HTTP` protocol to the socket `/tmp/sftpgofs.sock` and we use the `/api/v1` prefix for API URLs.