#596: Feature flags FEATURES: the ability to enable and disable functional blocks in Swarmica
Отредактирована: сегодняDescription
Feature flags allow enabling or disabling specific system features within the limits of the installed license.
The mechanism for enabling features is as follows:
- The license determines which features can be enabled
- The set of feature flags in
/root/swarmica/.envunder theFEATURESvariable determines which features are enabled on this instance
As a result, the intersection of what the license allows and what is specified in FEATURES is applied:
- If a feature is present both in the license and in
FEATURES, the feature will be enabled - If a feature is present only in the license but not in
FEATURES, it will be disabled. However, if you add it toFEATURESand restart the application, this reduces to the previous point, i.e., the feature will be enabled - If a feature is in
FEATURESbut not in the license, it will be disabled. To make it work, you must contact your account manager or Swarmica support and confirm the feature activation on the license. After that, you can update the key data under Settings > General Settings > Swarmica License and the feature will be enabled.
Feature flags with the __ prefix are not checked against the license.
All feature flags must be listed separated by commas, without spaces:
FEATURES=automations,automations_outgoing_emails,...
Feature Flags
| Feature flag | What it does | Introduced in version |
|---|---|---|
__ai_create_draft | Enables the automatic KCS draft creation feature, requires ai | 4.7.2 |
__ai_assistant | Enables the AI neural search assistant, requires ai | 4.7.0 |
__ai_agent | Enables an AI agent that can respond to tickets. Requires ai, and a configured public AI assistant is mandatory | 5.2.0, not used since 6.0.0 |
__ai_mcp_agents | Enables the ability to create AI agents (see AI provider capabilities) | 6.0.0 |
__ai_ticket_classifier | Enables the AI ticket classifier, requires ai | 4.7.0 |
__ai_ticket_summary | For providers that support summarizing tickets, enables the ticket summarization feature, requires ai | starting from 5.12.0 |
__ai_mdxeditor | Enables the AI assistant in the article editor, requires the ai flag | 4.6.0 |
automations (before v5.8.0 __automations) | Enables automation API and UI (outgoing webhooks, emails, runtime scripts, triggers, cron jobs) | 5.2.0 |
__customer_chat | Allows customers to initiate a chat from the Swarmica UI | 4.6.0 |
__customers_search_cfs | Enables quick search on custom fields for customers | 5.5.0 |
__delete_comment_attachments | Allows deleting attachments from tickets | starting from 5.12.0 |
__employee_segments | Adds the ability to use experimental functionality - employee segments (setting Skills, Status, Group, and Role in segments) | starting from 5.9.2 |
__empty_requester | Removes the automatic substitution of the current user's account in the "Ticket from" field on the ticket creation form (for employees only) | starting from 5.10.0 |
__helpcenter | Disables help center routing in the frontend application; a separate helpcenter container is required to serve the help center | not used since 5.9.0 |
external_tickets (before v5.8.0 __external_tickets) | Enables the UI for working with External Ticket | 5.3.0 |
__llmstxt | Enables indexing of public articles for LLM (generates /llms.txt file) | 5.9.0 |
__mandatory_timelog | Forces time log entry to send a public reply in a ticket, requires the time_tracking flag | |
__password_blacklist | Enables the ability to manage a list of compromised passwords and prohibit their use. Read more | 6.0.0 |
__private_attachments | Disables the ability to send attachments in email notifications and additionally protects access to such files | starting from 5.12.0 |
__smtp_email_channel | Allows creating new SMTP channels. If this flag is absent, new channels can only be created as IMAP channels, while existing SMTP channels remain configurable. For those enabling this feature, a postfix container must also be added to docker-compose.yml | |
__show_jwt_token | Adds the ability for users to copy their JWT token in their profile (only for Agent, Manager, Administrator roles) and use it in automations via API | starting from 5.9.2 |
__helpcenter_home_products | Makes the help center start page a product selection page | 4.6.0 |
__widget_closed_chats | Shows completed chats in the widget | |
__show_ticket_duplicates | Shows the "Possible duplicates" block in the ticket | 5.1.3 |
2fa | Enables the ability to configure two-factor authentication (2FA) | 5.9.0 |
ai | Enables (allows) all AI features; automatically enables the rephraser in the comment editor; all other features are enabled by individual __ai* feature flags | |
__article_comments (before v5.8.0 article_comments) | Allows public comments on articles from customers | |
assets | Enables Asset Management | 4.8.0 |
billmanager | Enables integration with Billmanager6 | |
beeline_pbx | Enables integration with Beeline Cloud PBX | 5.3.0 |
chats | Enables the Chats feature. | |
child_tickets | Enables the ability to create related child tickets, similar to external_tickets, but internal child tickets are counted in statistics and are intended for company employees rather than external recipients | 6.0.0 |
widgets | Enables the Widgets feature; also requires chats | |
__csat_anytime (before v5.8.0 csat_anytime) | Enables the "stars" survey on comments | |
disable_helpcenter | Disables the public help center. | Not used since 5.9.0 |
external_search | Allows creating and using external search sources | 5.6.0 |
mango_office | Connects the Mango Office integration | |
qa | Enables the QA feature | |
reporting | Enables the Advanced Reporting feature (API&UI) | 5.3.0 |
__sensitive_data (before v5.8.0 sensitive_data) | Enables the Confidential Data feature | |
telegram | Enables Telegram support. Also requires special sections in docker-compose.yml and a restart | |
whatsapp_green | Enables WhatsApp support via Green API. Also requires special sections in docker-compose.yml and a restart | |
vk | Enables VK support. Also requires special sections in docker-compose.yml and a restart | |
time_tracking | Enables support for time tracking | |
wfm | Enables WFM features (agent activity histogram) | |
max | Enables integration with the MAX messenger | 5.8.0 |
automations_outgoing_emails | Allows creating outgoing emails in automations (requires the automations flag) | 5.8.0 |
automations_outgoing_webhooks | Allows creating outgoing webhooks in automations (requires the automations flag) | 5.8.0 |
automations_macros | Allows creating macros in automations (requires the automations flag) | 5.8.0 |
automations_scripts | Allows creating scripts in automations (requires the automations flag) | 5.8.0 |
api_keys | Allows using API keys for API integrations | 5.8.0 |
issue_tracker | Allows connecting issue trackers | 5.8.0 |
webhooks | Not used since 5.8.0 | |
ui_widgets | Enables the ability to embed custom widgets into the Swarmica interface | 6.0.0 |
rca | Enables Root Cause Analysis (RCA) document management | 6.0.0 |
IMPORTANT! After editing the .env file, you must restart the services to apply the desired flags:
docker compose down && docker compose up -d