1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262 | ## Configuration file for general settings
# =========
# branding:
# =========
# # Custom name for the Lungo instance
# # Type: string
# # Default: 'Lungo'
# # Required: no
# name: Lungo
# # Custom subtitle for the landing page
# # Type: array
# # Default: [ 'a hug in a mug', 'a poetry of aroma', 'a quiet solitude', 'a whisper of inspiration' ]
# # Required: no
# subtitle:
# - a hug in a mug
# # Custom cover image for the landing page
# # Type: path
# # Default: none
# # Required: no
# cover: /assets/cover.png
# # Custom logo for the website
# # Type: path
# # Default: none
# # Required: no
# logo: /assets/favicon.png
# ============
# directories:
# ============
# # Cache directory
# # Type: path
# # Default: (platform specific)
# # Required: no
# cache_dir: ~/.cache/lungo
# # Data directory
# # Type: path
# # Default: (platform specific)
# # Required: no
# data_dir: ~/.local/share/lungo
# # Directory to store user data (e.g. user joe will have its data stored in joe/ inside this directory)
# # Type: path
# # Default: none
# # Required: yes
# users_dir: /home
# # Directories to mount that are shared between the container and the host
# shared_dirs:
# -
# # Name of the directory after mounted (must be unique)
# Type: string
# Default: none
# Required: yes
# name: shared_readonly
# # Path to the directory on the host
# # Type: path
# # Default: none
# # Required: yes
# source: /mnt/data/shared_readonly
# # Whether to mount the directory as read-only or not
# # Type: boolean
# # Default: false
# # Required: no
# read_only: true
# ========
# network:
# ========
# # Base URL to the website
# # Type: URL
# # Default: none
# # Required: yes
# base_url: https://lungo.com/
# # Subnet to use for the internal network, in CIDR notation (must have a minimum of 256 addresses)
# # Type: string
# # Default: 192.168.2.0/24
# # Required: no
# subnet: 192.168.2.0/24
# # IP addresses of external reverse proxies that are trusted when determining the real IP address of the client
# # Type: array
# # Default: [ ]
# # Required: no
# trusted_proxies: [ ]
# # HTTP settings
# http:
# # Enable or disable HTTP
# # Type: boolean
# # Default: true
# # Required: no
# enabled: true
# # Port to use for HTTP
# # Type: integer
# # Default: 80
# # Required: no
# port: 80
# # HTTPS settings
# https:
# # Port to use for HTTPS
# # Type: integer
# # Default: 443
# # Required: no
# port: 443
# # Set custom TLS certificate and key
# tls:
# # Path to the TLS certificate
# # Type: path
# # Default: none
# # Required: no
# cert: /etc/ssl/certs/self-signed.crt
# # Path to the TLS private key
# # Type: path
# # Default: none
# # Required: no
# key: /etc/ssl/private/self-signed.key
# ========
# plugins:
# ========
# ======
# rules:
# ======
# # Privileges of each role (privileges are inherited from roles above)
# privileges:
# # For unregistered users
# unregistered:
# # Allowed apps, or 'all' to allow all apps (do not allow services that require authentication)
# # Type: 'all' | array
# # Default: [ ]
# # Required: no
# allowed_apps: [ ]
# # For guest users
# guest:
# # Allowed apps, or 'all' to allow all apps
# # Type: 'all' | array
# # Default: [ ]
# # Required: no
# allowed_apps: [ ]
# # For regular users
# user:
# # Allowed apps, or 'all' to allow all apps
# # Type: 'all' | array
# # Default: [ ]
# # Required: no
# allowed_apps: [ ]
# # For administrators
# admin:
# # Allowed apps, or 'all' to allow all apps
# # Type: 'all' | array
# # Default: 'all'
# # Required: no
# allowed_apps: all
# =========
# security:
# =========
# # Maximum size of the request body allowed in megabytes (or 0 for unlimited)
# # Type: integer
# # Default: 0
# # Required: no
# max_body_size: 0
# # Rate limiting settings
# rate_limiting:
# # Enable or disable rate limiting
# # Type: boolean
# # Default: false
# # Required: no
# enabled: false
# # Maximum number of requests in the given time window
# # Type: integer
# # Default: 5
# # Required: no
# max_requests: 5
# # Time window (in seconds, or a string describing a time span in ISO 8601 format)
# # Type: integer | string
# # Default: 'PT1H'
# # Required: no
# time_window: 'PT1H'
# # Session settings
# session:
# # Session lifetime (in seconds, or a string describing a time span in ISO 8601 format)
# # Type: integer | string
# # Default: 'P2D'
# # Required: no
# lifetime: 'P2D'
# =====
# smtp:
# =====
# # SMTP server host
# # Type: string
# # Default: none
# # Required: yes
# host: smtp.gmail.com
# # SMTP server port
# # Type: integer
# # Default: none
# # Required: yes
# port: 587
# # SMTP server username
# # Type: string
# # Default: none
# # Required: yes
# username: joe
# # SMTP server password
# # Type: string
# # Default: none
# # Required: yes
# password: joe123
# # Sender name
# # Type: string
# # Default: 'Lungo'
# # Required: no
# name: Lungo
# # Sender email
# # Type: string
# # Default: none
# # Required: yes
# sender: joe@gmail.com
|