Files
casey/doc/Configuration.md

99 lines
2.9 KiB
Markdown

# Configuration
## Configuration Keys
### `cacheDefaultTtl`
**int**: The default time-to-live for the cache
### `cacheSize`
**int**: The max number of records that the cache can hold
### `caseConfirmation`
**bool**: If this is `true`, a case will be put into a pending state when it is created, until the creator confirms the case by clicking on a link and only then will team members be notified about a new case. If it is `false`, the case will be automatically confirmed and team members will be notified immediately.
*Note:* Since Casey is API only, your front-end will have to do some work to extract the confirmation codes, and also provide some hints to Casey on how to put the confirmation links together.
### `caseCloseIdle`
**int|string**: The maximum time a case can be idle before it is automatically closed by the system. This should probably be a duration string, such as `30d`
### `caseCanReopen`
**bool**: If `true`, closed cases can be reopened by sending a message to the case via HTTP or mail.
### `caseSendInitial`
**bool**: If this is `true`, a copy of the initial message will be sent to the creator. If `false`, the creator will not receive the initial message, but still receive all replies.
### `caseSendCopy`
**bool**: If this is `true`, the posting participant will receive a copy of their message as they post to a case.
### `caseConfirmUrl`
**string**: String used to generate confirmation URLs. The placeholder `%code%` will be replaced with the confirmation code.
### `teamInviteReminder`
**int|string**:
### `teamInviteCount`
**int**:
### `mailEnable`
**bool**: Set to `false` to disable all the mail functionality, and only use HTTP for all interactions with Casey.
### `mailSilenceTeam`
**bool**: If set to `true`, no mail will be sent to team members. Use this feature if the team interact with Casey via a website.
### `mailSilenceUser`
**bool**: If set to `true`, no mail will be sent to users. Use this feature if users interact with Casey via a website.
### `mailSpoolExpiry`
**string**: How long to keep messages in the inbox/outbox tables. Setting this to `7d` will keep messages for 7 days before permanently deleting them.
### `mailSubjectFormat`
**string**: How subject lines will be formatted; the placeholders `%reference%`, `%prefix%` and `%subject%` will be replaced with the appropraite values.
### `mailSubjectPrefix`
**string**: Value to put in the `%prefix%` placeholder.
### `mailSyncTimer`
**int**: Seconds between synchronizing incoming and outgoing mail
### `mailAddress`
**string**: The e-mail address to send and receive messages from
### `mainDomain`
**string**: The base domain to use for message IDs. If null, domain of mailAddress is used.
### `smtpAdapter`
### `smtpServer`
### `smtpPort`
### `smtpUsername`
### `smtpPassword`
### `smtpEncryption`
***SMTP configuration***
### `imapAdapter`
### `imapServer`
### `imapPort`
### `imapUsername`
### `imapPassword`
### `imapEncryption`
***IMAP configuration***