# Lynkz

## Docs

- [Lynkz: Open-Source Link-in-Bio, No Sign-Up Required](https://docs.lynkz.elipseday.xyz/introduction.md): Lynkz is a link-in-bio platform that lets you create a public profile page secured with a PIN. No sign-up, no email, no account needed.
- [Clone, Configure, and Deploy Lynkz in Under 10 Minutes](https://docs.lynkz.elipseday.xyz/quickstart.md): Follow this step-by-step guide to clone Lynkz, set up Firebase and Resend, run locally, and deploy your own PIN-protected link-in-bio page to Vercel.
- [Configure Firebase Firestore for Your Lynkz Instance](https://docs.lynkz.elipseday.xyz/setup/firebase.md): Set up Firebase Firestore as the Lynkz database. Create a project, enable Firestore, configure security rules, and retrieve your credentials.
- [Configure Resend for Magic Link PIN Recovery in Lynkz](https://docs.lynkz.elipseday.xyz/setup/resend.md): Connect Resend to enable magic link PIN recovery emails in Lynkz. Configure your API key and optionally verify a custom sender domain.
- [Lynkz Environment Variables: Complete Setup Reference](https://docs.lynkz.elipseday.xyz/setup/environment-variables.md): Complete reference for all Lynkz environment variables. Includes required Firebase config, optional Resend email keys, and app customization settings.
- [Deploy Lynkz to Vercel: GitHub Import and CLI Guide](https://docs.lynkz.elipseday.xyz/setup/deploy.md): Deploy your Lynkz instance to Vercel using the GitHub import workflow or the Vercel CLI. Configure environment variables and go live in minutes.
- [How to Use the Lynkz Dashboard to Manage Your Page](https://docs.lynkz.elipseday.xyz/features/dashboard.md): The Lynkz dashboard is your control center for managing links, themes, analytics, and page settings. Learn what each section does.
- [Adding, Reordering, and Scheduling Links on Your Lynkz Page](https://docs.lynkz.elipseday.xyz/features/links.md): Add, reorder, schedule, and manage links on your Lynkz page. Supports drag-and-drop reordering, per-link scheduling, and social icon detection.
- [Customizing Your Lynkz Page Appearance with Themes](https://docs.lynkz.elipseday.xyz/features/themes.md): Personalize your Lynkz page with 8 color themes, 3 button styles, 5 background animations, a custom favicon, and branding options.
- [Tracking Page Views and Link Clicks with Lynkz Analytics](https://docs.lynkz.elipseday.xyz/features/analytics.md): Lynkz analytics tracks page views, link clicks, traffic sources, devices, and browsers. View daily charts for 7, 14, or 30-day windows.
- [How to Export Your Lynkz Page Data as JSON, CSV, or HTML](https://docs.lynkz.elipseday.xyz/features/export.md): Export your Lynkz page as JSON, CSV, or a self-contained HTML file. Use exports for backups, data portability, or embedding your link list.
- [PIN Authentication and Dashboard Security in Lynkz](https://docs.lynkz.elipseday.xyz/security/pin-authentication.md): Learn how Lynkz protects your dashboard with a SHA-256 hashed PIN, IP-based lockout after 3 failed attempts, and optional recovery email setup.
- [Magic Link Recovery for Forgotten Lynkz Dashboard PINs](https://docs.lynkz.elipseday.xyz/security/magic-link-recovery.md): Regain access to your Lynkz dashboard when you forget your PIN using a one-time magic link sent to your saved recovery email address via Resend.
- [Firestore Security Rules: Setup and Reference for Lynkz](https://docs.lynkz.elipseday.xyz/security/firestore-rules.md): Lynkz uses Firestore security rules to protect sensitive data. Public page content is readable; PIN hashes and emails are never exposed to clients.
- [Frequently Asked Questions About the Lynkz Platform](https://docs.lynkz.elipseday.xyz/faq.md): Answers to common questions about Lynkz, including PIN recovery, usernames, privacy, self-hosting, magic links, and custom domains.
- [Troubleshooting Your Lynkz Setup and Configuration](https://docs.lynkz.elipseday.xyz/troubleshooting.md): Diagnose and fix common Lynkz problems including PIN lockouts, magic link failures, missing environment variables, and Firestore permission errors.