⚡ 1-Click Batch & Web Installation • v0.0.1 Ready

How to Install Ammonly Platform

Choose between our lightning-fast automated 1-click script (Windows Batch / Linux Shell) or modern interactive 7-step browser wizard.

System Requirements

Ammonly is engineered for maximum performance, strict typing, and zero bloat. Ensure your host machine satisfies the following baseline prerequisites:

🐘
Mandatory

PHP 8.4+ CLI & FPM

Strict typing PHP 8.4 engine. Recommended memory limit: 512M (or 1G for heavy background cron jobs).

🗄️
Mandatory

MySQL 8.0+ / MariaDB 10.11+

InnoDB engine with UTF-8 Unicode charset (utf8mb4_unicode_ci). Unified single-database architecture (ammonly_dev).

🧩
8 Core Extensions

Mandatory PHP Modules

pdo_mysql, mbstring, intl, openssl, curl, fileinfo, zip, json.

📂
Write Permissions

Directory Access

Write permissions (755/775) for web/CLI user on storage/, runtime/, and database/config/.

💡
Automated Diagnostics: You can automatically test your environment and database connectivity before installing by running install.bat --check (Windows) or ./install.sh --check (Linux).

Choose Your Installation Method

Ammonly supports 1-click batch scripts for rapid terminal setup and a modern interactive browser wizard.

⚡ Recommended (Fastest)

Method 1: Automated Script Installation

The automated installer runs all pre-flight checks, creates the unified database, deploys base DDL schemas, registers all active modules, and seeds initial super-admin accounts in under 5 seconds.

1

Clone or Extract Repository

Open Command Prompt or PowerShell in your desired workspace folder:

cmd / powershell
git clone https://github.com/Ammonly/app-admin.git ammonly
cd ammonly
2

Launch 1-Click Interactive Batch Installer

Double-click install.bat in Explorer or execute from your terminal:

cmd
install.bat

The interactive menu will prompt for database credentials (default: 127.0.0.1:3306, user: root, database: ammonly_dev) and whether to include demo business catalogs.

3

Unattended / Headless Deployment (CI / CD)

For non-interactive setup without prompts, pass command line flags directly:

cmd
install.bat --all --with-demo --db=ammonly_dev
1

Clone and Grant Permissions

Open terminal on your Linux server:

bash
git clone https://github.com/Ammonly/app-admin.git ammonly
cd ammonly
chmod +x install.sh bin/install
2

Execute Installation Script

Run the automated shell script:

bash
./install.sh
3

Automated Production / Docker Command

Execute fully unattended in scripts or server automation pipelines:

bash
./install.sh --all --with-demo --db=ammonly_dev --platform-email=help@ammonly.com

Available CLI Arguments & Flags

Flag Description Default
--all, -a Installs all three ecosystem tiers: Platform Admin, Tenant, and CRM/ERP User. true
--profile=NAME Target a specific profile: admin (Platform) or user (CRM/ERP). admin
--with-demo, -t Seeds realistic business demo entities, CRM pipeline stages, and calendars. false
--check Executes environment diagnostics without altering the database (read-only audit). —
--force, -f Forces fresh database recreation, purging old schema tables if present. false
--db=NAME Custom MySQL database name to create and populate. ammonly_dev
🌐 Visual GUI

Method 2: Interactive Browser Wizard (/install)

If you prefer a visual web interface, Ammonly features a modern 7-step guided installer inspired by Joomla 5+ architecture, featuring live AJAX database connection testing, environment checks, and progress bars.

1

Start Built-In Local Web Server

Point PHP built-in server to the public/ entrypoint directory:

terminal
php -S 127.0.0.1:8000 -t public
2

Open Browser and Follow Steps

Navigate to http://127.0.0.1:8000/install. The 7-step wizard will guide you through:

STEP 1

Language Selection

Select interface language (Polish or English).

STEP 2

License Agreement

Review and accept the open-source MIT License.

STEP 3

Instance Topology

Choose Complete Ecosystem or dedicated profile.

STEP 4

Requirements Audit

Live checks for PHP extensions and write access.

STEP 5

Database & Credentials

Configure MySQL connection with live AJAX test.

STEP 6

Automated Deployment

Real-time progress bar deploying SQL tables.

STEP 7

Security Lock & Launch

Generates security lock file and access tokens.

Web Server & Reverse Proxy Configuration

Ammonly strictly complies with CSP Level 3, PSR-7 / PSR-15 standards, and sub-second asset caching.

/etc/nginx/sites-available/ammonly.conf
server {
    listen 80;
    listen [::]:80;
    server_name dev.ammonly.com;
    root /var/www/ammonly/public;
    index index.php;

    client_max_body_size 64M;

    # Static Assets Fast Caching
    location /assets/ {
        expires 30d;
        add_header Cache-Control "public, no-transform";
        try_files $uri =404;
    }

    # Main Application Front Controller
    location / {
        try_files $uri $uri/ /index.php$is_args$args;
    }

    location ~ \.php$ {
        include fastcgi_params;
        fastcgi_pass unix:/run/php/php8.4-fpm.sock;
        fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
        fastcgi_param DOCUMENT_ROOT $realpath_root;
        fastcgi_buffer_size 128k;
        fastcgi_buffers 4 256k;
    }

    location ~ /\. {
        deny all;
    }
}
/etc/apache2/sites-available/ammonly.conf
<VirtualHost *:80>
    ServerName dev.ammonly.com
    DocumentRoot /var/www/ammonly/public

    <Directory /var/www/ammonly/public>
        Options -Indexes +FollowSymLinks
        AllowOverride All
        Require all granted

        RewriteEngine On
        RewriteCond %{REQUEST_FILENAME} !-f
        RewriteCond %{REQUEST_FILENAME} !-d
        RewriteRule ^(.*)$ index.php [QSA,L]
    </Directory>

    <FilesMatch \.php$>
        SetHandler "proxy:unix:/run/php/php8.4-fpm.sock|fcgi://localhost"
    </FilesMatch>
</VirtualHost>

Accessing Your New Ammonly Platform

Platform Management Console

Central platform administration, system settings, dictionaries, user accounts, and security audit logs.

URL: http://your-domain/platform
Login: admin (or help@ammonly.com)
Password: Admin123!

SaaS CRM / ERP Business Portal

Operational business portal with companies, contacts, deals, webmail client, CalDAV calendar, and contracts.

URL: http://your-domain/client
Login: client (or client@ammonly.com)
Password: Admin123!
🔒
Mandatory Post-Install Security Notice: The installation creates a security lock file at storage/installed.lock which blocks unauthorized re-installation. Immediately log in and change default passwords under User Profile > Security.