FAQ
Practical answers to the most common questions about deploying, configuring, and using Marketix.
How do I create the first admin account?
Section titled “How do I create the first admin account?”Run the marketix:create-admin Artisan command after completing the initial setup. The command prompts you for a name, email, and password interactively:
php artisan marketix:create-adminYou can also supply values as options to avoid interactive prompts (useful in CI/CD pipelines):
php artisan marketix:create-admin --name="Alice" --email="alice@example.com" --password="securepassword"See First Run for the full post-installation checklist, and CLI Commands for all available options.
A short link returns a 404 error. What is wrong?
Section titled “A short link returns a 404 error. What is wrong?”Several conditions cause a short link to return a 404 or redirect to a “not found” page:
- The link is inactive. Links can be toggled active or inactive. Inactive links are not resolved.
- The link has expired. If an expiry date was set and has passed, the link stops resolving.
- The link has been archived. Archived links are no longer accessible to visitors.
- The link’s domain is not reachable. If the link uses a custom domain, that domain must be configured correctly and verified. See Domains.
Open the link in the project dashboard to check its status and settings. See Links for details on link states.
My custom domain is not resolving. How do I fix it?
Section titled “My custom domain is not resolving. How do I fix it?”A custom domain must meet two requirements before short links on it will work:
- DNS must point to your Marketix server. Add an
AorCNAMErecord for the domain pointing to your server’s IP or hostname. - Marketix must verify the domain is reachable. After adding the domain in the UI, Marketix checks connectivity every 15 minutes. The domain status will update automatically once DNS has propagated and the app can reach it.
See Domains for instructions on adding and managing custom domains, and Operations for server-level networking and Traefik configuration.
How do password-protected links work?
Section titled “How do password-protected links work?”When creating or editing a link you can set a password. Visitors following the short link are shown a password prompt before being redirected to the destination. The password is stored as a hashed value and never exposed in the URL.
See Links for instructions on creating and editing links.
Geographic click data is not appearing in my statistics. Why?
Section titled “Geographic click data is not appearing in my statistics. Why?”Geographic statistics require the MaxMind GeoLite2-City database to be downloaded and present on the server. If the database is missing, Marketix records clicks but cannot resolve country, region, or city information.
To set up GeoIP:
- Obtain a free license key from maxmind.com.
- Add
MAXMIND_LICENSE_KEY=your_keyto your.envfile. - Run the database download command:
php artisan marketix:geoip:updateOnce the database is present, the scheduler keeps it up to date daily. See Operations for the full GeoIP setup walkthrough.
How do I enable two-factor authentication or passkeys?
Section titled “How do I enable two-factor authentication or passkeys?”Both are managed from your account security settings.
- Two-factor authentication (TOTP): Go to your account settings and follow the setup flow to register an authenticator app.
- Passkeys: Go to your account settings and register a passkey using your device’s biometric or PIN authentication.
See Account for step-by-step instructions.
How do I invite teammates to a project?
Section titled “How do I invite teammates to a project?”Team members are invited from within a project. Open the project, navigate to the team section, and send an invitation by email. Invited users receive an email and are added to the project once they accept.
Roles available are admin and member. See Team for details on roles and permissions.
How do I customize the branding (logo, name, colours)?
Section titled “How do I customize the branding (logo, name, colours)?”Super admins can replace the application name, logo, and favicon from the admin branding settings page. Branding changes apply across the UI, emails, and PDF reports.
See Branding for the full configuration walkthrough.
Can I run Marketix without Docker?
Section titled “Can I run Marketix without Docker?”Yes. The Docker Compose stack (FrankenPHP + Octane + Traefik) is the recommended production setup, but you can run Marketix on any standard PHP/Laravel hosting environment. You will need PHP 8.3+, a supported database (SQLite, MySQL, or PostgreSQL), Redis (recommended for queues and cache in production), and a web server.
Use composer run setup for initial setup and composer run dev during local development. See Requirements for the full list.