Skip to content

Commit 54f7a69

Browse files
authored
Merge pull request #555 from opengisch/doc/document-webdav
Add WebDAV storage to architecture doc
2 parents 51d1a76 + c22c7b9 commit 54f7a69

File tree

2 files changed

+24
-4
lines changed

2 files changed

+24
-4
lines changed

documentation/assets/images/qfc_server_architecture_light.svg

Lines changed: 4 additions & 2 deletions
Loading

documentation/reference/qfieldcloud/architecture.en.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ tx_slug: documentation_reference_qfieldcloud_architecture
88
QFieldCloud has a containerized architecture with multiple containers and volumes.
99

1010

11-
!![QFieldCloud architecture: Rounded rectangles represent containers, ellipses represent volumes. The text in the square brackets is the service name found in the `docker-compose.yml` file, the rest of the text is the function of the container. Arrows between containers shows who initiates the communication. Arrows between a container and a volume represents whether the container reads (arrow pointing to container) or writes (arrow pointing to volume) data. Arrows and containers in gray represent deprecated services.](../../assets/images/qfc_server_architecture_light.svg)
11+
!![QFieldCloud architecture: Rounded rectangles represent containers, ellipses represent volumes. The text in the square brackets is the service name found in the `docker-compose.yml` file, the rest of the text is the function of the container. Arrows between containers shows who initiates the communication. Arrows between a container and a volume represents whether the container reads (arrow pointing to container) or writes (arrow pointing to volume) data. Arrows and containers in gray represent deprecated services. Arrows and containers in dashed line represent optional services.](../../assets/images/qfc_server_architecture_light.svg)
1212

13-
See an interactive version of [the drawing above](https://excalidraw.com/#json=D2nvh_kmi5HAFVQne4atD,D9gsC0i14V491ZsCp-FLMw).
13+
See an interactive version of [the drawing above](https://excalidraw.com/#json=7rUYYLuU9kkRrvR3acb8R,6l4zHy4gvz8WYcb9z5O1jQ).
1414

1515
!!! note
1616
For simplicity and clarity all graphs show the so called "happy path" without detailing the error handling through the process.
@@ -131,6 +131,19 @@ If `minio` is running, please make sure the host's firewall allows port `8009`,
131131
Single shot container to create the required buckets on the Object Storage under **[`minio`] File Storage**.
132132

133133

134+
#### [`webdav`] Alternative File Storage
135+
136+
Local WebDAV storage used for development, using WebDAV protocol and specifications.
137+
138+
The data is stored on the **[`webdav_data`]** volume.
139+
140+
Can alternatively be used in place of the `minio` File Storage for storing the files. Can optionally be used for storing only attachments on it.
141+
142+
!!! info
143+
The webdav storage is optional, it is not a requirement for the system to work properly.
144+
145+
If used, the webdav storage service should be replaced by a proper WebDAV server, e.g. NextCloud.
146+
134147
#### [`db`] App PostgreSQL
135148

136149
Local PostgreSQL database server to host the data for the **[`app`] QFieldCloud App**.
@@ -160,6 +173,11 @@ Stores dynamically created user PostGIS databases.
160173
Stores data for the **[`minio`] S3 service**.
161174

162175

176+
#### [`webdav_data`]
177+
178+
Stores data for the **[`webdav`] storage service** if present.
179+
180+
163181
#### [`postgres_data`]
164182

165183
Stores data for **[`db`] App PostgreSQL**.

0 commit comments

Comments
 (0)