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 Policies
- Databases
  - Admins API tokens
  Notifiers
  - Default rules Retry rules Lock rules Bounce patterns Strategies Keys ISPs Pools
Nodes
- Email SMS Event generator Integration with Sendsay ENS: настройка сендера
- 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 Edition to Percona Server for MongoDBAdding sender IP addressesDeduplication request settingsPostgreSQL database for account dataProxy server settingsKeycloak Integration with AltcraftGetting HTTP service statusesConfiguration MongoDB logs rotation
- Filtering bot actions Directory of gender markers

Platform maintenance

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

Custom channels guide

OverviewCreating and configuring a channelEntity field configurationTemplate languageEntities
- Pipe: Basic Concepts Result Errors Log Pack Unpack HTTP Request Store Set Store Get Selector SQL Eventer Scheduler
- Pipeline: Basic Concepts Message Schedule Listener Moderate Stop

System page customization Send Message ID Инструкция по миграции истории в ClickHouse Instructions for migrating history to ClickHouse Utility for importing push subscriptions to Firebase project Utility for importing push subscriptions to Firebase project

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 account 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

Technology description
Deployment schemes
Basic scheme

Basic scheme

Last updated on Jun 19, 2025

Deployment schemes

Fail-safe scheme

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