Skip to content

Commit bf83ecb

Browse files
committed
Added info about the Development services
1 parent ac87907 commit bf83ecb

File tree

1 file changed

+68
-2
lines changed

1 file changed

+68
-2
lines changed

documentation/reference/qfieldcloud/architecture.en.md

Lines changed: 68 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ See an interactive version of [the drawing above](https://excalidraw.com/#json=D
1111
For simplicity and clarity all graphs show the so called "happy path" without detailing the error handling through the process.
1212

1313

14-
## Docker containers
14+
## Docker objects
1515

1616
### Containers
1717

@@ -100,11 +100,77 @@ Contains all static assets such as fonts, CSS, JS or image files.
100100

101101
#### `[media_volume]`
102102

103-
Warning! Deprecated, might be removed at any time.
103+
!!! WARNING
104+
Deprecated, might be removed at any time.
104105

105106
The default location for User uploaded files. It should **never** be used.
106107

107108

109+
### Development services
110+
111+
The following containers are available only for local development purposes and **should not** be used in production, as these services are not monitored, backed-up and generally designed for critical usage within the stack.
112+
113+
114+
#### [`minio`] File Storage
115+
116+
Local Object Storage (S3-like) used for development.
117+
The data is stored on 4 **[`minio_data`]** volumes, as replication is enforced by `minio`.
118+
119+
Should be replaced by a proper S3-like Object Storage SaaS provider.
120+
121+
122+
#### [`createbuckets`] Create Minio Buckets
123+
124+
Single shot container to create the required buckets on the Object Storage under **[`minio`] File Storage**.
125+
126+
127+
#### [`db`] App PostgreSQL
128+
129+
Local PostgreSQL database server to host the data for the **[`app`] QFieldCloud App**.
130+
The database schema is entirely managed by Django.
131+
The schema should not be modified by external services.
132+
133+
Should be replaced by a proper PostgreSQL database with PostGIS installed SaaS provider.
134+
135+
136+
#### [`smtpdev`] Mailing Server
137+
138+
Local mailing server to handle emails being sent, such as registration activation, reset password or notifications.
139+
140+
Should be replaced by a proper email SaaS provider that supports SMTP protocol.
141+
142+
143+
#### [`geodb`] GeoDB PostgreSQL
144+
145+
!!! WARNING
146+
Deprecated, might be removed at any time.
147+
148+
Stores dynamically created user PostGIS databases.
149+
150+
151+
#### [`minio_data`]
152+
153+
Stores data for **[`geodb`] GeoDB PostgreSQL**.
154+
155+
156+
#### [`postgres_data`]
157+
158+
Stores data for **[`db`] App PostgreSQL**.
159+
160+
161+
#### [`smtp4dev_data`]
162+
163+
Stores data for **[`smtpdev`] Mailing Server**.
164+
165+
166+
#### [`geodb_data`]
167+
168+
!!! WARNING
169+
Deprecated, might be removed at any time.
170+
171+
Stores data for **[`geodb`] GeoDB PostgreSQL**.
172+
173+
108174
## Job Queue
109175

110176
QFieldCloud runs very heavy operations to make Project synchronization work smoothly for users.

0 commit comments

Comments
 (0)