Skip to main content

Developer guide

Русский
English

Getting Started

Administrator documentation

Functional characteristics

Technology description

Architecture OverviewComponent Description
- Basic scheme Fail-safe scheme Typical Placement in Infrastructure

System requirements

- - Account Users Account Virtual Senders Account Database Indexes
  TariffsExternal data configurationLDAPTasksSchedule JobsGlobal Stop ListsWebversion Store PoliciesIn-App Storage Settings
- Databases
  - Admins API tokens
  Notifiers
  - Default rules Retry rules Lock rules Bounce patterns Strategies Keys ISPs Pools
Nodes
- Email SMS Event generator Integration with Altcraft Cloud SMTP Integration with Sendsay
- Audit Journal Data Usage
- ARF decoder URL decoder SMID decoder License

Platform installation

Automatic installation Manual installation Running the platform in a Docker container

Platform configuration

Configuration fileDomain settingsLDAP access configurationSending Email via SMTP relayPixel and push domain configurationCluster and Replication SetupSystem notifications configurationProcesses UNIX sockets configurationHTTPS ConfigurationMigrating from MongoDB Community to Percona ServerAdding sender IP addressesData Encryption in Percona Server for MongoDBDeduplication request settingsBackup with Percona Backup for MongoDBPostgreSQL database for Market dataProxy server settingsKeycloak Integration with AltcraftGetting HTTP service statusesConfiguring MongoDB log rotation
- Filtering bot actions Directory of gender markers

Custom Channels

Creating a Channel
- MessageScheduleListenerModerateStop
  - HTTP Request Pack Unpack Eventer Scheduler Selector SQL Store Set Store Get Log Result Error RMQ Publisher
External Objects (Entities)Templating LanguageSending FilesPresets (Field Sets)DebuggingTechnical Limitations

Platform maintenance

Personnel requirements Platform maintenance processes Platform updating Backup and recovery Transferring the platform to a new server Creating, deleting, and populating tables for statistics in ClickHouse Using the aktool utility Users and directories engaged by the platform Platform service monitoring Process and mailing monitoring via Prometheus

System page customization Send Message ID ClickHouse History Migration Guide Instructions for migrating history to ClickHouse Utility for importing push subscriptions to Firebase project Utility for importing push subscriptions to Firebase project ENS: настройка интеграции

Processing HTTP/HTTPS traffic

Administrator API

- - Account Activation and Deactivation Account Freeze and Unfreeze
  Get accounts listAdd a new accountDelete the account
- Update an Existing Account Add a new user Delete a user Get a list of users Sending a Welcome Email
- Synchronize node MTA configuration Get nodes list Get node MTA status Activate node MTA Deactivate node MTA
- Create or update AKMTA senderGet AKMTA sender informationAssign account to senderGet senders listDelete senderRestore sender
  - Get sender queue information Hold sender queue Release sender queue Clear sender queue
- Get virtual senders list Get virtual sender information Create virtual sender Update virtual sender Clone virtual sender Delete virtual sender

Documentation Archive

Platform installation

Platform installation

Automatic installation

Automatic installation

Automatic installation

Manual installation

Manual installation

Manual installation

Preparation, database configuration, platform launch.

Running the platform in a Docker container

Running the platform in a Docker container

Running the platform in a Docker container

info

Before deployment, review the port requirements (including for an NGFW/firewall) and the antivirus exclusions.

Last updated on Sep 23, 2026

Automatic installation

© 2015 - 2026 Altcraft, LLC. All rights reserved.