Skip to main content
Altcraft Docs LogoAltcraft Docs Logo
User guide iconUser guide
Developer guide iconDeveloper guide
Admin guide iconAdmin guide
English
  • Русский
  • English
Login
    Getting StartedAdministrator documentationFunctional characteristics
      Technology descriptionarrow
    • Architecture OverviewComponent Description
        Deployment schemesarrow
      • Basic schemeFail-safe schemeTypical Placement in Infrastructure
    System requirements
      Admin Panelarrow
      • Account areaarrow
        • Accountsarrow
        • Account UsersAccount Virtual SendersAccount Database Indexes
        TariffsExternal data configurationLDAPTasksSchedule JobsGlobal Stop ListsWebversion Store Policies
        Settingsarrow
      • Databases
          Accessarrow
        • AdminsAPI tokens
        Notifiers
          MTAarrow
        • Default rulesRetry rulesLock rulesBounce patternsStrategiesKeysISPsPools
      Nodes
        Sendersarrow
      • EmailSMSEvent generatorIntegration with SendsayENS: настройка сендера
        Reportsarrow
      • Audit JournalData Usage
        Toolsarrow
      • ARF decoderURL decoderSMID decoderLicense
      Platform installationarrow
    • Automatic installationManual installationRunning the platform in a Docker container
      Platform configurationarrow
    • 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
        Configuration of system constants and directoriesarrow
      • Filtering bot actionsDirectory of gender markers
      Platform maintenancearrow
    • Personnel requirementsPlatform maintenance processesPlatform updatingPlatform service monitoringBackup and recoveryTransferring the platform to a new serverCreating, deleting, and populating tables for statistics in ClickHouseUsage of the aktool utilityUsers and directories engaged by the platform
      Custom channels guidearrow
    • OverviewCreating and configuring a channelEntity field configurationTemplate languageEntities
        Pipesarrow
      • Pipe: Basic ConceptsResultErrorsLogPackUnpackHTTP RequestStore SetStore GetSelectorSQLEventerScheduler
        Pipelinesarrow
      • Pipeline: Basic ConceptsMessageScheduleListenerModerateStop
      Extraarrow
    • System page customizationSend Message IDИнструкция по миграции истории в ClickHouseInstructions for migrating history to ClickHouseUtility for importing push subscriptions to Firebase projectUtility for importing push subscriptions to Firebase project
    Processing HTTP/HTTPS traffic
      Administrator APIarrow
      • Accounts admin apiarrow
        • Restricted accessarrow
        • Account Activation and DeactivationAccount Freeze and Unfreeze
        Get accounts listAdd a new accountDelete the account
        Account usersarrow
      • Update an Existing AccountAdd a new accountDelete a userGet a list of usersSending a Welcome Email
        Nodesarrow
      • Synchronize node MTA configurationGet nodes listGet node MTA statusActivate node MTADeactivate node MTA
        Senders admin apiarrow
      • Create or update AKMTA senderGet AKMTA sender informationAssign account to senderGet senders listDelete senderRestore sender
          Sender queuearrow
        • Get sender queue informationHold sender queueRelease sender queueClear sender queue
        Virtual sendersarrow
      • Get virtual senders listGet virtual sender informationCreate virtual senderUpdate virtual senderClone virtual senderDelete virtual sender
    Documentation Archive
  • Extra
  • System page customization

System page customization

Custom template of the unsubscribe page​

Tracking page templates are located in the directory ak/static/trk/. If you need to reassign them, you need to put the modified templates in this directory and add custom. to the file name.

$ cd /opt/akd
$ cp ak/static/trk/unsubscribe.html ak/static/trk/custom.unsubscribe.html
$ nano ak/static/trk/custom.unsubscribe.html
...
$ ./akd onerestart procactions

The templates will be applied only when you restart the process procactions.

Description of the pages​

TemplateMeaning
unsubscribe.htmlPage after unsubscribing, if it isn't specified in the message
deprecated.htmlThe page of the expired web message
not_found.htmlPage for invalid links on tracking

Custom notification templates​

Custom notification templates are located in the directory templates/email/<CountryCode>/. As they will be overwritten during the upgrade, you can create files for them that override them. CountryCode determines the template language. If the language is not found, the default value will be EN (English).

You need to add custom. to the file name in order to define such a file:

$ cd /opt/akd
$ cp templates/email/RU/password.html templates/email/RU/custom.password.html
$ nano templates/email/RU/custom.password.html
...
$ ./akd restart --job_server

The templates will be applied only when you restart the process akd.

Template description​

TemplateLevelMeaning
content.jsonall
Applies to all templates, contains headers, subject and reply-to addresses of letters
template_all.htmlallApplies to all templates
welcome.htmlaccount, adminAppears when the user with access is created
password.htmlaccount, adminPassword change by user or administrator
complains.htmlaccountIn case of exceeding the rates for complaints
hardbounces.htmlaccountIn case of exceeding the hardbounce indicators
softbounces.htmlaccountIn case of exceeding the softbounce indicators
report_weekly.htmlaccountWeekly report of the user
report_daily.htmlaccountDaily report of the user
sendlimit.htmlaccountIn case of exceeding the limit (tariff) for sending
leadslimit.htmlaccountIn case ofexceeding the limit (tariff) for the amount of data
suspended.htmlaccountIn case the account is inactive in the admin panel
sender_problem.htmladminDuring the process of setting up notification for sender in the administration panel

Customization of form pages​

All template files are located in the platform installation directory under /templates/form/v1/EN and /templates/form/v1/RU. Files in the .tpl format contain form templates and components used within those templates. The .html format contains standalone tables.

FileDescription
button.tplTemplate for displaying buttons. Controls their appearance and placement in the form.
content.jsonFile containing the form's data and structure — includes field descriptions, transition logic, texts, settings, etc.
user_code.tplA custom template designed to override the default form template. It is used to insert custom code into the <head>, <body>, and <footer> sections of the page. It also allows wrapping the main form content with additional HTML markup.
error.htmlPage displayed when an error occurs while loading the form or if the link is invalid.
final.tplTemplate for the final page shown to the user after successful form submission.
form_fill.tplTemplate for the main form page where the user fills in the fields.
form.tplMain container template for the form. Includes basic HTML layout, structure, and links to other templates.
hidden.htmlDisplayed when the form is hidden from public access. Usually contains a message like "Form unavailable".
redirect.tplTemplate for the redirection page.

Similar to other config files, you can create a copy of any of them, rename it to "custom.<original_name>", and use it instead of the original configuration.

Static tracking files​

In some cases it can be useful to place static files on the tracking — the necessary files can be placed in the directory ak/static/trk/public/. This way, they will be available at the absolute path /static/ of your tracking. For example, this directory contains the cat.html file.

Last updated on Jun 5, 2020
Previous
Extra
Next
Send Message ID
  • Custom template of the unsubscribe page
    • Description of the pages
  • Custom notification templates
    • Template description
  • Customization of form pages
  • Static tracking files
© 2015 - 2026 Altcraft, LLC. All rights reserved.