Docs / LinkQR
Signup

Start Here

Read LinkQR documentation in the same order as the application sidebar.

Estimated reading: 6 minutes

Start Here - LinkQR Documentation

Welcome to the LinkQR documentation. This guide is organized to help administrators install, configure, sell, maintain, and support the platform, while also helping end users understand how to create Link Bio pages, QR campaigns, Short URLs, branded links, analytics workflows, and AI-powered content.

LinkQR is a modern QR code, Short URL, and Link Bio SaaS platform for creators, agencies, marketers, restaurants, stores, events, local businesses, and teams. It combines public landing pages, dynamic QR campaigns, branded short links, analytics, custom domains, tracking pixels, AI tools, marketplace packages, plans, credits, and admin operations in one system.

Who Should Read This Documentation?

Site Owners and Administrators

Read the installation, marketplace, license, admin, finance, settings, and maintenance sections first. These topics help you run LinkQR as a stable business platform.

Admin responsibilities include:

  • Install LinkQR and complete server setup.
  • Choose the correct license for your business model.
  • Configure plans, credits, payments, storage, AI, email, and integrations.
  • Install and update marketplace packages.
  • Monitor users, subscriptions, support tickets, files, AI usage, and marketplace updates.
  • Keep the platform secure, backed up, and updated.

End Users and Customers

Read the Dashboard, Link Bio, QR Codes, Short URLs, Brand, Content Tools, Library, Help Desk, and Apps sections. These topics explain how to use the product after logging in.

User workflows include:

  • Create and publish Link Bio pages.
  • Create static or dynamic QR campaigns.
  • Create branded Short URLs for campaigns, ads, emails, and social posts.
  • Customize QR style, colors, logo, and export settings.
  • Use custom domains, UTM presets, and tracking pixels.
  • Review analytics for page views, clicks, scans, short-link clicks, devices, locations, and campaign performance.
  • Use AI tools to generate Bio drafts, AI QR artwork, content, and images.
  • Open support tickets when help is needed.

Recommended Reading Order

If this is your first time setting up LinkQR, follow the documentation in this order.

  1. Installation: prepare server requirements, upload the package, create the database, and run the browser installer.
  2. Extended License: confirm whether your use case needs Regular or Extended License before selling customer access.
  3. Marketplace: understand product catalog, Packages, install methods, cart, and package management.
  4. Upgrade Version: learn how to safely update LinkQR and marketplace packages.
  5. Admin Workspace: configure plans, credits, users, support, finance, AI, settings, languages, and operations.
  6. User Dashboard: understand the customer workspace and onboarding path.
  7. Link Bio: create public mobile pages with blocks, templates, links, products, files, forms, and analytics.
  8. QR Codes: create dynamic or static QR campaigns, choose QR types, and track scans.
  9. Short URLs: create branded short links, bulk import links, manage API keys, and connect webhooks.
  10. Brand: configure brand kit, custom domains, tracking pixels, and UTM presets.
  11. Content Tools and Library: manage teams, AI Studio, files, and online media search.
  12. Help Desk and Apps: support users and configure affiliate workflows.

First-Time Admin Setup Checklist

After installation, complete these tasks before inviting customers.

  1. Log in as the super administrator created by the installer.
  2. Open Admin Dashboard and confirm the app loads without errors.
  3. Set website title, timezone, contact email, mail provider, and general settings.
  4. Configure payment gateways before selling paid plans.
  5. Create or review plans, feature permissions, QR limits, Short URL limits, Link Bio limits, credits, storage, AI usage, team limits, and support access.
  6. Configure AI providers if AI QR, AI Bio Assistant, or AI Studio will be enabled.
  7. Configure file manager settings and storage limits.
  8. Review Marketplace and install any required packages.
  9. Review Extended License if the platform will be sold as a SaaS.
  10. Test registration, login, checkout, subscription changes, Link Bio publishing, QR scan redirects, Short URL redirects, analytics, file upload, email delivery, and support tickets.
  11. Set up backups and confirm restore process.

First-Time User Workflow

For most customers, the fastest way to understand LinkQR is to create one Link Bio page, one QR campaign, and one Short URL.

  1. Open Dashboard and review the onboarding checklist.
  2. Go to Link Bio > Pages and create a new page.
  3. Add page title, slug, avatar, cover, description, brand color, and button style.
  4. Add content blocks such as links, social profiles, products, files, lead forms, FAQ, menu items, or review collector.
  5. Preview the public Link Bio page and publish it.
  6. Go to QR Codes > Campaigns and create a QR code pointing to the Link Bio page.
  7. Customize the QR design, logo, colors, pattern, and export size.
  8. Go to Short URLs and create a branded short link for a campaign destination.
  9. Scan-test the QR code and click-test the Short URL on mobile before sharing or printing.
  10. After traffic starts, open Analytics to review views, clicks, scans, short-link clicks, devices, locations, and top campaigns.

Main Product Areas

Link Bio

Create mobile public pages that collect important links, products, files, menus, videos, contact details, social profiles, lead forms, and review CTAs in one place.

QR Codes

Create static and dynamic QR campaigns for URLs, Bio pages, business profiles, menus, product catalogs, files, events, bookings, payments, Wi-Fi, WhatsApp, vCards, and more.

Short URLs

Create branded short links for campaigns, ads, emails, QR destinations, social posts, and partner traffic. Short URLs support shared brand settings such as custom domains, UTM presets, tracking pixels, and analytics when enabled.

Analytics

Measure scans, views, clicks, short-link clicks, countries, cities, devices, browsers, operating systems, referrers, QR types, custom domains, UTM presets, and campaign performance.

Brand Tools

Use Brand Kit, custom domains, tracking pixels, and UTM presets to make campaigns more professional and easier to measure.

AI Tools

Use AI Bio Assistant, AI QR Codes, AI Studio, AI Content, AI Image, Repurpose, and Content Planner to speed up campaign creation.

Marketplace

Browse product catalog items, buy packages, install from purchase code or ZIP, manage installed packages, rescan modules, and upgrade marketplace packages.

Admin Operations

Manage users, teams, plans, credits, payments, subscriptions, support tickets, blogs, FAQs, notifications, files, AI templates, languages, integrations, themes, and system settings.

Common Launch Paths

Internal Business Use

Use LinkQR for your own company, brand, restaurant, shop, event, or marketing team. Start with Installation, Dashboard, Link Bio, QR Codes, Brand, and Analytics.

Agency Service

Use LinkQR to create campaigns for clients. Focus on Link Bio templates, QR campaign workflows, custom domains, analytics reports, files, and team workflows.

Paid SaaS

Use LinkQR as a customer-facing paid platform. Focus on Extended License, plans, credits, payments, subscriptions, user roles, support, marketplace updates, and admin monitoring.

QR Campaign Platform

Focus on QR Codes, Short URLs, dynamic redirects, QR type reference, Pre-Printed QR, Bulk Generation, Analytics, custom domains, UTM presets, and tracking pixels.

Link Bio Platform

Focus on Link Bio Pages, Templates, Blocks, A/B Tests, AI Bio Assistant, Bio Analytics, custom domains, and brand configuration.

Important Maintenance Habits

  • Back up database and files before every update.
  • Update the main LinkQR package before extension packages.
  • Review Marketplace > Packages for updates.
  • Check Laravel logs after updates or failed jobs.
  • Test QR redirects after changing domains or tracking settings.
  • Test payment flows after changing plans or gateways.
  • Monitor AI usage and credit cost if AI features are enabled.
  • Review support tickets and repeated customer questions to improve docs and FAQs.

Where to Go Next

If you are installing the product, continue to Installation. If you already installed it and are preparing to sell access, read Extended License, Plans Credits and Permissions, Finance, and Admin Workspace. If you are learning the user side, start with Dashboard, then Link Bio, then QR Codes, then Short URLs.