forked from espocrm/documentation
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
280 lines (274 loc) · 15.6 KB
/
mkdocs.yml
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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
site_name: EspoCRM Documentation
repo_url: https://github.com/espocrm/documentation/
extra_javascript: [js/extra.js]
extra_css:
- css/extra.css
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
- mdx_truly_sane_lists
- codehilite:
guess_lang: false
use_pygments: true
- toc:
permalink: true
toc_depth: 4
theme:
name: material
highlightjs: true
palette:
primary: blue grey
accent: blue grey
nav:
- 'Home': 'index.md'
- 'Administration':
- 'Server configuration':
- 'Configuration': 'administration/server-configuration.md'
- 'Apache': 'administration/apache-server-configuration.md'
- 'Nginx': 'administration/nginx-server-configuration.md'
- 'IIS': 'administration/iis-server-configuration.md'
- 'System':
- 'Installation': 'administration/installation.md'
- 'Installation by script': 'administration/installation-by-script.md'
- 'Installation with Docker': 'administration/docker/installation.md'
- 'Installation with Traefik': 'administration/docker/traefik.md'
- 'Upgrading': 'administration/upgrading.md'
- 'Extensions': 'administration/extensions.md'
- 'Jobs': 'administration/jobs.md'
- 'Troubleshooting': 'administration/troubleshooting.md'
- 'Console commands': 'administration/commands.md'
- 'WebSocket': 'administration/websocket.md'
- 'Performance tweaking': 'administration/performance-tweaking.md'
- 'Backup and restore': 'administration/backup-and-restore.md'
- 'Moving to another server': 'administration/moving-to-another-server.md'
- 'Config parameters': 'administration/config-params.md'
- 'Log': 'administration/log.md'
- 'Customization':
- 'Entity Manager': 'administration/entity-manager.md'
- 'Fields': 'administration/fields.md'
- 'Layouts': 'administration/layout-manager.md'
- 'Dynamic Logic': 'administration/dynamic-logic.md'
- 'Users': 'administration/users-management.md'
- 'Roles management': 'administration/roles-management.md'
- 'Email administration': 'administration/emails.md'
- 'Formula script': 'administration/formula.md'
- 'Formula functions':
- 'general': 'administration/formula/general.md'
- 'string': 'administration/formula/string.md'
- 'datetime': 'administration/formula/datetime.md'
- 'number': 'administration/formula/number.md'
- 'entity': 'administration/formula/entity.md'
- 'record': 'administration/formula/record.md'
- 'env': 'administration/formula/env.md'
- 'password': 'administration/formula/password.md'
- 'array': 'administration/formula/array.md'
- 'object': 'administration/formula/object.md'
- 'language': 'administration/formula/language.md'
- 'json': 'administration/formula/json.md'
- 'ext': 'administration/formula/ext.md'
- 'util': 'administration/formula/util.md'
- 'Import': 'administration/import.md'
- 'Portal': 'administration/portal.md'
- 'Currency': 'administration/currency.md'
- 'Dashboards': 'administration/dashboards.md'
- 'Authentication':
- '2-factor authentication': 'administration/2fa.md'
- 'OpenID Connect': 'administration/oidc.md'
- 'LDAP':
- 'Authorization': 'administration/ldap-authorization.md'
- 'Active Directory': 'administration/ldap-authorization-for-ad.md'
- 'OpenLDAP': 'administration/ldap-authorization-for-openldap.md'
- 'Misc':
- 'Terms & naming': 'administration/terms-and-naming.md'
- 'Web-to-Lead': 'administration/web-to-lead.md'
- 'Webhooks': 'administration/webhooks.md'
- 'Passwords': 'administration/passwords.md'
- 'Maps': 'administration/maps.md'
- 'B2C mode': 'administration/b2c.md'
- 'Multiple assigned users': 'administration/multiple-assigned-users.md'
- 'File storage': 'administration/file-storage.md'
- 'SMS sending': 'administration/sms-sending.md'
- 'User Guide':
- 'Emails':
- 'General guidelines': 'user-guide/emails.md'
- 'IMAP & SMTP configuration': 'user-guide/imap-smtp-configuration.md'
- 'Mass Email': 'user-guide/mass-email.md'
- 'Stream': 'user-guide/stream.md'
- 'Sales management': 'user-guide/sales-management.md'
- 'Case management': 'user-guide/case-management.md'
- 'Activities & Calendar': 'user-guide/activities-and-calendar.md'
- 'Mail Merge': 'user-guide/mail-merge.md'
- 'Knowledge Base': 'user-guide/knowledge-base.md'
- 'Documents': 'user-guide/documents.md'
- 'Export': 'user-guide/export.md'
- 'Text search': 'user-guide/text-search.md'
- 'Working Time Calendar': 'user-guide/working-time-calendar.md'
- 'Misc':
- 'Shortcut keys': 'user-guide/shortcuts.md'
- 'Printing to PDF': 'user-guide/printing-to-pdf.md'
- 'Markdown syntax': 'user-guide/markdown.md'
- 'Browser support': 'user-guide/browser-support.md'
- 'Data privacy': 'user-guide/data-privacy.md'
- 'Complex expressions': 'user-guide/complex-expressions.md'
- 'Optimistic concurrency control': 'user-guide/optimistic-concurrency-control.md'
- 'Extensions':
- 'Advanced Pack':
- 'Reports': 'user-guide/reports.md'
- 'Workflows': 'administration/workflows.md'
- 'BPM':
- 'Overview': 'administration/bpm.md'
- 'Events': 'administration/bpm-events.md'
- 'Gateways': 'administration/bpm-gateways.md'
- 'Activities': 'administration/bpm-activities.md'
- 'Misc':
- 'Examples': 'administration/bpm-examples.md'
- 'Signals': 'administration/bpm-signals.md'
- 'Compensation': 'administration/bpm-compensation.md'
- 'Formula functions': 'administration/bpm-formula.md'
- 'Drip email campaign': 'administration/bpm-drip-email-campaign.md'
- 'Tracking URLs': 'administration/bpm-tracking-urls.md'
- 'Tips': 'administration/bpm-tips.md'
- 'Configuration': 'administration/bpm-configuration.md'
- 'Sales Pack':
- 'Products': 'user-guide/products.md'
- 'Quotes': 'user-guide/quotes.md'
- 'Sales Orders': 'user-guide/sales-orders.md'
- 'Invoices': 'user-guide/invoices.md'
- 'Google Integration':
- 'Setting-up': 'extensions/google-integration/setting-up.md'
- 'Calendar': 'extensions/google-integration/calendar.md'
- 'Contacts': 'extensions/google-integration/contacts.md'
- 'Gmail': 'extensions/google-integration/gmail.md'
- 'Outlook Integration':
- 'Setting-up': 'extensions/outlook-integration/setting-up.md'
- 'Calendar': 'extensions/outlook-integration/calendar.md'
- 'Contacts': 'extensions/outlook-integration/contacts.md'
- 'Email': 'extensions/outlook-integration/email.md'
- 'VoIP Integration':
- 'Asterisk server': 'extensions/voip-integration/asterisk-integration-setup.md'
- 'Binotel service' : 'extensions/voip-integration/binotel-integration-setup.md'
- 'Starface server': 'extensions/voip-integration/starface-integration-setup.md'
- 'Twilio service' : 'extensions/voip-integration/twilio-integration-setup.md'
- 'IexPBX server' : 'extensions/voip-integration/iexpbx-integration-setup.md'
- 'Docker container': 'extensions/voip-integration/docker-container.md'
- 'Customization': 'extensions/voip-integration/customization.md'
- 'Troubleshooting' : 'extensions/voip-integration/troubleshooting.md'
- 'Developer':
- 'Index': 'development/index.md'
- 'Getting started': 'development/how-to-start.md'
- 'Making extension package': 'development/extension-packages.md'
- 'Modules': 'development/modules.md'
- 'Tests': 'development/tests.md'
- 'Translation': 'development/translation.md'
- 'Coding rules': 'development/coding-rules.md'
- 'Backend':
- 'API': 'development/api.md'
- 'Dependency injection': 'development/di.md'
- 'Metadata': 'development/metadata.md'
- 'Metadata reference':
- 'scopes': 'development/metadata/scopes.md'
- 'entityDefs': 'development/metadata/entity-defs.md'
- 'aclDefs': 'development/metadata/acl-defs.md'
- 'selectDefs': 'development/metadata/select-defs.md'
- 'recordDefs': 'development/metadata/record-defs.md'
- 'clientDefs': 'development/metadata/client-defs.md'
- 'entityAcl': 'development/metadata/entity-acl.md'
- 'pdfDefs': 'development/metadata/pdf-defs.md'
- 'notificationDefs': 'development/metadata/notification-defs.md'
- 'streamDefs': 'development/metadata/stream-defs.md'
- 'fields': 'development/metadata/fields.md'
- 'dashlets': 'development/metadata/dashlets.md'
- 'authenticationMethods': 'development/metadata/authentication-methods.md'
- 'integrations': 'development/metadata/integrations.md'
- 'app':
- 'acl': 'development/metadata/app-acl.md'
- 'acl-portal': 'development/metadata/app-acl-portal.md'
- 'actions': 'development/metadata/app-actions.md'
- 'address-formats': 'development/metadata/app-address-formats.md'
- 'admin-panel': 'development/metadata/app-admin-panel.md'
- 'api': 'development/metadata/app-api.md'
- 'app-params': 'development/metadata/app-app-params.md'
- 'authentication': 'development/metadata/app-authentication.md'
- 'authentication2FAMethods': 'development/metadata/app-authentication-2fa-methods.md'
- 'cleanup': 'development/metadata/app-cleanup.md'
- 'client': 'development/metadata/app-client.md'
- 'clientRoutes': 'development/metadata/app-client-routes.md'
- 'complexExpression': 'development/metadata/app-complex-expression.md'
- 'config': 'development/metadata/app-config.md'
- 'consoleCommands': 'development/metadata/app-console-commands.md'
- 'containerServices': 'development/metadata/app-container-services.md'
- 'currency': 'development/metadata/app-currency.md'
- 'databasePlatforms': 'development/metadata/app-database-platforms.md'
- 'dateTime': 'development/metadata/app-date-time.md'
- 'defaultDashboardLayouts': 'development/metadata/app-default-dashboard-layouts.md'
- 'defaultDashboardOptions': 'development/metadata/app-default-dashboard-options.md'
- 'entityTemplateList': 'development/metadata/app-entity-template-list.md'
- 'export': 'development/metadata/app-export.md'
- 'fieldProcessing': 'development/metadata/app-field-processing.md'
- 'file': 'development/metadata/app-file.md'
- 'fileStorage': 'development/metadata/app-file-storage.md'
- 'formula': 'development/metadata/app-formula.md'
- 'hook': 'development/metadata/app-hook.md'
- 'image': 'development/metadata/app-image.md'
- 'jsLibs': 'development/metadata/app-js-libs.md'
- 'language': 'development/metadata/app-language.md'
- 'linkManager': 'development/metadata/app-link-manager.md'
- 'massActions': 'development/metadata/app-mass-actions.md'
- 'metadata': 'development/metadata/app-metadata.md'
- 'orm': 'development/metadata/app-orm.md'
- 'pdfEngines': 'development/metadata/app-pdf-engines.md'
- 'popupNotifications': 'development/metadata/app-popup-notifications.md'
- 'portalContainerServices': 'development/metadata/app-portal-container-services.md'
- 'rebuild': 'development/metadata/app-rebuild.md'
- 'recordId': 'development/metadata/app-record-id.md'
- 'regExpPatterns': 'development/metadata/app-reg-exp-patterns.md'
- 'relationships': 'development/metadata/app-relationships.md'
- 'scheduledJobs': 'development/metadata/app-scheduled-jobs.md'
- 'select': 'development/metadata/app-select.md'
- 'smsProviders': 'development/metadata/app-sms-prividers.md'
- 'templateHelpers': 'development/metadata/app-template-helpers.md'
- 'templates': 'development/metadata/app-templates.md'
- 'webSocket': 'development/metadata/app-web-socket.md'
- 'ORM': 'development/orm.md'
- 'Select Builder': 'development/select-builder.md'
- 'API actions': 'development/api-action.md'
- 'Services': 'development/services.md'
- 'Hooks': 'development/hooks.md'
- 'ACL': 'development/acl.md'
- 'Misc':
- 'Template (PDF) custom helpers': 'development/template-custom-helper.md'
- 'Custom functions for formula': 'development/new-function-in-formula.md'
- 'Custom scheduled jobs': 'development/scheduled-job.md'
- 'Duplicate checking': 'development/duplicate-check.md'
- 'Database indexes': 'development/db-indexes.md'
- 'App params': 'development/app-params.md'
- 'Jobs': 'development/jobs.md'
- 'Email sending': 'development/email-sending.md'
- 'Calculated fields': 'development/calculated-fields.md'
- 'Custom config parameters': 'development/custom-config-parameters.md'
- 'Frontend':
- 'View': 'development/view.md'
- 'Custom views': 'development/custom-views.md'
- 'Templates': 'development/frontend/templates.md'
- 'Fields':
- 'Custom field type': 'development/custom-field-type.md'
- 'Customizing existing fields': 'development/customize-standard-fields.md'
- 'Controller & routing': 'development/frontend/controller.md'
- 'Model': 'development/model.md'
- 'Collection': 'development/collection.md'
- 'HTML & CSS': 'development/frontend/html-css.md'
- 'Ajax requests': 'development/frontend/ajax.md'
- 'Misc':
- 'Custom buttons & dropdown actions': 'development/custom-buttons.md'
- 'Modal dialogs': 'development/modal.md'
- 'Confirmation dialogs': 'development/confirm-dialog.md'
- 'Custom panels on record view': 'development/frontend/record-panels.md'
- 'Including custom CSS file': 'development/custom-css.md'
- 'Custom dashlets': 'development/how-to-create-a-dashlet.md'
- 'Dynamic forms with dynamic handler': 'development/dynamic-handler.md'
- 'Link-multiple field with primary record': 'development/link-multiple-with-primary.md'
- 'View setup handlers': 'development/frontend/view-setup-handlers.md'
- 'Save error handlers': 'development/frontend/save-error-handlers.md'
- 'Campaigns':
- 'Custom unsubscribe page': 'development/campaign-unsubscribe-template.md'