added on local at 2026-07-01 16:01:23
| 1 | <!DOCTYPE html> | |
| 2 | <html lang="en"> | |
| 3 | <head> | |
| 4 | <meta charset="UTF-8"> | |
| 5 | <title>ABForge — Installation Instructions</title> | |
| 6 | <style> | |
| 7 | :root { | |
| 8 | --bg: #0b0f1a; --surface: #1b2233; --border: #2a3447; | |
| 9 | --text: #e6ecf6; --text-2: #a8b6d1; --text-3: #6f7e9c; | |
| 10 | --brand: #ff7a3d; --brand-2: #ffb347; --accent: #5aa9ff; | |
| 11 | --good: #10b981; --warn: #f59e0b; --bad: #ef4444; | |
| 12 | } | |
| 13 | * { box-sizing: border-box; } | |
| 14 | html, body { background: var(--bg); color: var(--text); margin: 0; } | |
| 15 | body { font-family: 'Inter', system-ui, sans-serif; line-height: 1.6; } | |
| 16 | .wrap { max-width: 920px; margin: 0 auto; padding: 60px 32px 80px; } | |
| 17 | h1 { font-size: 42px; font-weight: 800; margin: 0 0 24px; | |
| 18 | background: linear-gradient(135deg, var(--brand), var(--brand-2)); | |
| 19 | -webkit-background-clip: text; -webkit-text-fill-color: transparent; | |
| 20 | background-clip: text; } | |
| 21 | h2 { font-size: 24px; margin: 40px 0 12px; border-top: 1px solid var(--border); padding-top: 28px; } | |
| 22 | h3 { font-size: 16px; letter-spacing: 1px; text-transform: uppercase; color: var(--text-3); margin: 24px 0 8px; } | |
| 23 | p, li { color: var(--text-2); } | |
| 24 | code, kbd { background: #131826; border: 1px solid var(--border); padding: 2px 7px; border-radius: 4px; font-family: ui-monospace, 'JetBrains Mono', monospace; font-size: 13px; color: var(--accent); } | |
| 25 | pre { background: #131826; border: 1px solid var(--border); border-radius: 8px; padding: 16px 18px; overflow-x: auto; font-family: ui-monospace, monospace; font-size: 13px; line-height: 1.55; color: var(--text); } | |
| 26 | pre code { background: transparent; border: none; padding: 0; color: var(--text); } | |
| 27 | table { border-collapse: collapse; margin: 12px 0; } | |
| 28 | th, td { padding: 8px 14px; border: 1px solid var(--border); text-align: left; font-size: 14px; } | |
| 29 | th { background: var(--surface); color: var(--text-3); text-transform: uppercase; letter-spacing: 1px; font-size: 12px; } | |
| 30 | </style> | |
| 31 | </head> | |
| 32 | <body> | |
| 33 | <div class="wrap"> | |
| 34 | ||
| 35 | <h1>ABForge — Installation Instructions</h1> | |
| 36 | <p class="lede">Server-side install reference for the ABForge platform — | |
| 37 | A/B + MVT + heatmaps + analytics SaaS. Use this when standing up a fresh | |
| 38 | Plesk vhost or a clean clone.</p> | |
| 39 | ||
| 40 | <h2>1. Server requirements</h2> | |
| 41 | <ul> | |
| 42 | <li>Linux (CentOS / RHEL / Rocky 7+) with Plesk Obsidian (or any Apache + suexec setup).</li> | |
| 43 | <li>Perl 5.16+ with <code>DBI</code>, <code>DBD::mysql</code>, <code>Digest::SHA</code>, <code>JSON::XS</code>, <code>Crypt::Argon2</code> (optional — falls back to iter-sha256), <code>LWP::UserAgent</code>.</li> | |
| 44 | <li>MariaDB 5.5+ (the platform code is written to the 5.5 feature subset; newer is fine).</li> | |
| 45 | <li>One Plesk subscription that owns <code>abforge.3dshawn.com</code> (or whatever apex you pick).</li> | |
| 46 | </ul> | |
| 47 | ||
| 48 | <h2>2. Database</h2> | |
| 49 | <p>Create the DB under the PARENT subscription, not the subdomain — Plesk requires this.</p> | |
| 50 | <pre><code># on the server, as root | |
| 51 | plesk bin database --create abforge3dshawn \ | |
| 52 | -domain 3dshawn.com \ | |
| 53 | -type mysql -server localhost \ | |
| 54 | -add_user abforge \ | |
| 55 | -passwd '<your-strong-password>' | |
| 56 | ||
| 57 | # load schema | |
| 58 | mysql -u abforge -p abforge3dshawn < db_schema.sql</code></pre> | |
| 59 | ||
| 60 | <h2>3. Codebase</h2> | |
| 61 | <p>Upload the contents of <code>build/</code> (or <code>html/</code>) into the docroot:</p> | |
| 62 | <pre><code>/var/www/vhosts/3dshawn.com/abforge.3dshawn.com/</code></pre> | |
| 63 | ||
| 64 | <p>Required file ownership (Plesk suexec):</p> | |
| 65 | <table> | |
| 66 | <tr><th>Path</th><th>Owner</th><th>Mode</th></tr> | |
| 67 | <tr><td>Docroot dir</td><td><code>mocnwahs3d:psaserv</code></td><td>755</td></tr> | |
| 68 | <tr><td>*.cgi, *.pl</td><td><code>mocnwahs3d:psacln</code></td><td>755</td></tr> | |
| 69 | <tr><td>MODS/, TEMPLATES/, assets/</td><td><code>mocnwahs3d:psacln</code></td><td>644 files / 755 dirs</td></tr> | |
| 70 | </table> | |
| 71 | ||
| 72 | <h2>4. .htaccess</h2> | |
| 73 | <p>Default <code>.htaccess</code> ships in the build tree. It does three things:</p> | |
| 74 | <ol> | |
| 75 | <li><strong>CGI execution</strong> for <code>*.cgi</code>.</li> | |
| 76 | <li><strong>CORS open</strong> for <code>/c.cgi</code>, <code>/h.cgi</code>, <code>/x.cgi</code>, <code>/g.cgi</code> — the tracker ingest endpoints have to accept beacons from any origin a customer pastes the snippet on.</li> | |
| 77 | <li><strong>Long-cache <code>/t.js</code></strong> — <code>Cache-Control: public, max-age=3600</code> so customer browsers don't redownload it on every page view.</li> | |
| 78 | </ol> | |
| 79 | ||
| 80 | <h2>5. Config (super-admin)</h2> | |
| 81 | <p>After install, sign in as <code>programmershawn@gmail.com</code> (or whichever account holds <code>users.is_super_admin=1</code>) and open <a href="/admin_config.cgi"><code>/admin_config.cgi</code></a>.</p> | |
| 82 | <ul> | |
| 83 | <li><strong>Stripe</strong> — paste <code>stripe_publishable</code>, <code>stripe_secret</code>, and <code>stripe_webhook_secret</code> from your Stripe Dashboard.</li> | |
| 84 | <li><strong>SMTP</strong> — paste host / port / user / pass (or leave host blank to use local <code>sendmail</code>).</li> | |
| 85 | <li><strong>Brand</strong> — brand name, tagline, hero copy, and brand colors.</li> | |
| 86 | </ul> | |
| 87 | ||
| 88 | <h2>6. Cron jobs</h2> | |
| 89 | <p>Add these as the <code>mocnwahs3d</code> user (or whichever user owns the docroot):</p> | |
| 90 | <pre><code>*/10 * * * * cd /var/www/vhosts/3dshawn.com/abforge.3dshawn.com && \ | |
| 91 | /usr/bin/perl _subscription_worker.pl \ | |
| 92 | >> /var/log/abforge_subscription.log 2>&1 | |
| 93 | ||
| 94 | 0 * * * * cd /var/www/vhosts/3dshawn.com/abforge.3dshawn.com && \ | |
| 95 | /usr/bin/perl _billing_worker.pl \ | |
| 96 | >> /var/log/abforge_billing.log 2>&1</code></pre> | |
| 97 | ||
| 98 | <h2>7. Verification</h2> | |
| 99 | <ol> | |
| 100 | <li>Visit <code>https://abforge.3dshawn.com/</code> — landing page renders.</li> | |
| 101 | <li>Visit <code>/signup.cgi</code> and create a test account. Verification email lands.</li> | |
| 102 | <li>Add a site at <code>/sites.cgi</code>. Copy the snippet. Paste into any demo HTML page.</li> | |
| 103 | <li>Reload the demo page. Within 30s, <code>/dashboard.cgi</code> shows a pageview and live visitor.</li> | |
| 104 | <li>Open <code>/admin_config.cgi</code> and confirm Stripe keys + SMTP creds are saved.</li> | |
| 105 | </ol> | |
| 106 | ||
| 107 | <h2>8. Where things live (quick map)</h2> | |
| 108 | <table> | |
| 109 | <tr><th>Concern</th><th>Files</th></tr> | |
| 110 | <tr><td>Tracker</td><td><code>t.js</code>, <code>c.cgi</code>, <code>h.cgi</code>, <code>x.cgi</code>, <code>g.cgi</code></td></tr> | |
| 111 | <tr><td>Marketing</td><td><code>index.cgi</code>, <code>features.cgi</code>, <code>pricing.cgi</code>, <code>docs.cgi</code>, <code>privacy.cgi</code>, <code>terms.cgi</code></td></tr> | |
| 112 | <tr><td>Auth</td><td><code>signup.cgi</code>, <code>login.cgi</code>, <code>logout.cgi</code>, <code>verify_email.cgi</code>, <code>forgot_password.cgi</code>, <code>reset_password.cgi</code>, <code>twofa.cgi</code></td></tr> | |
| 113 | <tr><td>App pages</td><td><code>dashboard.cgi</code>, <code>sites.cgi</code>, <code>analytics.cgi</code>, <code>sources.cgi</code>, <code>devices.cgi</code>, <code>geo.cgi</code>, <code>pages.cgi</code>, <code>realtime.cgi</code>, <code>experiments.cgi</code>, <code>heatmaps.cgi</code>, <code>goals.cgi</code>, <code>funnels.cgi</code>, <code>mvt_slots.cgi</code></td></tr> | |
| 114 | <tr><td>Billing</td><td><code>billing.cgi</code>, <code>billing_action.cgi</code>, <code>billing_payment.cgi</code>, <code>stripe_webhook.cgi</code>, <code>_billing_worker.pl</code>, <code>_subscription_worker.pl</code></td></tr> | |
| 115 | <tr><td>Admin</td><td><code>admin*.cgi</code></td></tr> | |
| 116 | <tr><td>Modules</td><td><code>MODS/ABForge/{Config,Wrapper,Sites,Stats,Experiments,Goals,Tracking,UAParser,Billing,Permissions}.pm</code></td></tr> | |
| 117 | <tr><td>Templates</td><td><code>TEMPLATES/abforge_*.html</code></td></tr> | |
| 118 | </table> | |
| 119 | ||
| 120 | </div> | |
| 121 | </body> | |
| 122 | </html> |