Skip to content

Commit 5ae7077

Browse files
author
Sébastien HEYD
committed
docs(config): update app configuration documentation
- Add documentation for name parameter (backend application name) - Update OpenAI model from gpt-3.5-turbo to gpt-4o-mini - Add comprehensive PWA configuration documentation with all parameters - Document OpenAI configuration parameters (key, model, organization) - Add detailed explanations for PWA settings including theme colors, display modes, and icon configuration
1 parent 4a2dc09 commit 5ae7077

File tree

1 file changed

+92
-2
lines changed
  • docs/docs/8.x/configuration

1 file changed

+92
-2
lines changed

docs/docs/8.x/configuration/app.md

Lines changed: 92 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ return [
1414
// Backend domain if different as current domain. Ex: "admin.mydomain.tld"
1515
'domain' => '',
1616

17+
// Backend application name, visible as meta title suffix
18+
'name' => env('APP_NAME', 'Boilerplate'),
19+
1720
// Redirect to this route after login
1821
'redirectTo' => 'boilerplate.dashboard',
1922

@@ -29,9 +32,30 @@ return [
2932
// Allows to generate text with ChatGPT in TinyMCE
3033
'openai' => [
3134
'key' => env('OPENAI_API_KEY'),
32-
'model' => 'gpt-3.5-turbo',
35+
'model' => 'gpt-4o-mini',
3336
'organization' => env('OPENAI_API_ORGANIZATION'),
3437
],
38+
39+
// Progressive Web App configuration
40+
'pwa' => [
41+
'enabled' => true,
42+
'name' => env('APP_NAME', 'Boilerplate'),
43+
'short_name' => env('APP_NAME', 'Boilerplate'),
44+
'description' => '',
45+
'theme_color' => '#454d55',
46+
'background_color' => '#454d55',
47+
'display' => 'standalone',
48+
'orientation' => 'portrait-primary',
49+
'apple_touch_icon' => 'assets/vendor/boilerplate/favicon.svg',
50+
'icons' => [
51+
[
52+
'src' => 'assets/vendor/boilerplate/favicon.svg',
53+
'sizes' => 'any',
54+
'type' => 'image/svg+xml',
55+
],
56+
// ... additional icons here, see documentation
57+
],
58+
],
3559
];
3660

3761
```
@@ -100,6 +124,72 @@ Conversely, if the value is set to `false`, the user will be logged out when the
100124

101125
---
102126

127+
## name
128+
129+
The `name` parameter allows you to define the backend application name, which is visible as meta title suffix.
130+
131+
The default value is `env('APP_NAME', 'Boilerplate')`
132+
133+
---
134+
103135
## openai
104136

105-
Allows setting variables for using ChatGPT in TinyMCE
137+
Allows setting variables for using ChatGPT in TinyMCE
138+
139+
### key
140+
141+
The OpenAI API key for authenticating with the ChatGPT service.
142+
143+
### model
144+
145+
The OpenAI model to use. The default value is `'gpt-3.5-turbo'`
146+
147+
### organization
148+
149+
The OpenAI organization ID if you belong to multiple organizations.
150+
151+
---
152+
153+
## pwa
154+
155+
Progressive Web App configuration that allows the backend to be installed as a PWA.
156+
157+
### enabled
158+
159+
Enable or disable PWA functionality. The default value is `true`
160+
161+
### name
162+
163+
The application name shown in the PWA installation dialog. The default value is `env('APP_NAME', 'Boilerplate')`
164+
165+
### short_name
166+
167+
The short name used when there is insufficient space to display the full name. The default value is `env('APP_NAME', 'Boilerplate')`
168+
169+
### description
170+
171+
A description of the application. The default value is an empty string.
172+
173+
### theme_color
174+
175+
The theme color for the PWA. The default value is `'#454d55'`
176+
177+
### background_color
178+
179+
The background color for the PWA splash screen. The default value is `'#454d55'`
180+
181+
### display
182+
183+
The display mode for the PWA. The default value is `'standalone'`
184+
185+
### orientation
186+
187+
The preferred orientation for the PWA. The default value is `'portrait-primary'`
188+
189+
### apple_touch_icon
190+
191+
The icon used for Apple Touch Icon. The default value is `'assets/vendor/boilerplate/favicon.svg'`
192+
193+
### icons
194+
195+
Array of icons for the PWA in different sizes and formats. The default includes an SVG icon that scales to any size.

0 commit comments

Comments
 (0)