/
settings.system.yaml
190 lines (170 loc) · 7.2 KB
/
settings.system.yaml
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
#
# This is popup help messages for the Admin Panel -> Settings -> System
#
# Fields:
# title - Shown in bold at the top of the popover window
# content - The body of the help popover
# links - List of links shows below the content
# title - Link title
# href - href of link (links starting with / are translated to the
# helpdesk installation path)
#
# The key names such as 'helpdesk_name' should not be translated as they
# must match the HTML #ids put into the page template.
#
---
helpdesk_status:
title: Helpdesk Status
content: >
If the status is changed to <span
class="doc-desc-opt">Offline</span>, the client interface will be
disabled. Only Admins will be able to access the system.
helpdesk_url:
title: Helpdesk URL
content: >
This URL is the base of your osTicket installation. It is used in email
communication to direct end-users back to your helpdesk.
helpdesk_name_title:
title: Helpdesk Name/Title
content: >
This is the title that appears in the browser tab. If your help desk
page is bookmarked, this will be the title/name of the site page.
default_department:
title: Default Department
content: >
Choose a default <span class="doc-desc-title">department</span>
for tickets that are not automatically routed to a department.
<br/><br/>
Ticket can be routed base on help topic, incoming email and ticket
filter settings.
default_page_size:
title: Default Page Size
content: >
Choose the number of items shown per page in the Ticket Queues in the
Staff Panel. Each Agent can also customize this number for their own
account under <span class="doc-desc-title">My Preferences</span>.
default_log_level:
title: Default Log Level
content: >
Determine the minimum level of issues which will be recorded in the
<span class="doc-desc-title">system log</span>. <span
class="doc-desc-opt">Debug</span> represents the least severity, and <span
class="doc-desc-opt">Error</span> represents the greatest severity.
For example, if you want to see all issues in the <span
class="doc-desc-title">System Logs</span>, choose <span
class="doc-desc-opt">Debug</span>.
purge_logs:
title: Purge Logs
content: >
Determine how long you would like to keep <span
class="doc-desc-title">System Logs</span> before they are deleted.
enable_richtext:
title: Enable Rich Text
content: >
If enabled, this will permit the use of rich text formatting between
Clients and Agents.
enable_avatars:
title: Enable Avatars on Thread View
content: >
Enable this to show <span class="doc-desc-title">Avatars</span> on thread correspondence.
<br><br>
The <span class="doc-desc-title">Avatar Source</span> can be set in Agents' and Users' settings pages.
links:
- title: Agents Settings
href: /scp/settings.php?t=agents
- title: Users Settings
href: /scp/settings.php?t=users
collision_avoidance:
title: Agent Collision Avoidance
content: >
Enter the maximum length of time an Agent is allowed to hold a lock
on a ticket or task without any activity.
<br><br>
Enter <span class="doc-desc-opt">0</span> to disable the lockout feature.
allow_iframes:
title: Allow iFrames
content: >
Enter comma separated list of domains for the system to be framed
in. If left empty, the system will default to 'self'. This accepts
domain wildcards, HTTP/HTTPS URL scheme, and port numbers.
<br><br>
<b>Example:</b>
<br>
https://domain.tld, sub.domain.tld:443, http://*.domain.tld
links:
- title: Syntax Information (host-source)
href: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/frame-ancestors#Sources"
acl:
title: ACL (Access Control List)
content: >
Enter a comma separated list of IP addresses to allow access to the system.
If left empty, anyone will be able to access the system with the appropriate
credentials. If "Apply To Backend Only" is checked the system will apply the
ACL to Agent/Admin Panels only. If left unchecked however, it will apply
to the User Portal and Agent/Admin Panels.
# Date and time options
date_time_options:
title: Date & Time Options
content: >
The following settings define the default settings for Date &
Time settings for the help desk. You can choose to use the locale
defaults for the selected locale or use customize the formats to
meet your unique requirements. Refer to the ICU format strings as a
reference for customization. The dates shown below simply
illustrate the result of their corresponding values.
links:
- title: See the ICU Date Formatting Table
href: http://userguide.icu-project.org/formatparse/datetime
languages:
title: System Languages
content: >
Choose a system primary language and optionally secondary languages
to make your interface feel localized for your agents and end-users.
primary_language:
title: System Primary Language
content: >
Content of this language is displayed to agents and end-users if
their respective language preference is not currently available.
This includes the content of the interface, as well as, custom
content such as thank-you pages and email messages.
<br/><br/>
This is the language in which the untranslated versions of your
content should be written.
secondary_language:
title: Secondary Languages
content: >
Select language preference options for your agents and end-users.
The interface will be available in these languages, and custom
content, such as thank-you pages and help topic names, will be
translatable to these languages.
# Attachments
attachments:
title: Attachment Settings and Storage
content: >
Configure how attachments are stored.
default_storage_bk:
title: File Storage Backend
content: >
Choose how attachments are stored.
<br><br>
Additional storage backends can be added by installing storage plugins
max_file_size:
title: Maximum File Size
content: >
Choose a maximum file size for attachments uploaded by agents. This
includes canned attachments, knowledge base articles, and
attachments to ticket and task replies. The upper limit is
controlled by PHP's <code>upload_max_filesize</code> setting.
links:
- title: PHP ini settings
href: "http://php.net/manual/en/ini.core.php#ini.upload-max-filesize"
files_req_auth:
title: Require Login
content: >
Enable this setting to forbid serving attachments to unauthenticated
users. That is, users must sign into the system (both end users and
agents), in order to view attachments.
<br><br>
From a security perspective, be aware that the user's browser may
retain previously-viewed files in its cache. Furthermore, all file
links on your helpdesk automatically expire after about 24 hours.