Skip to main content
This guide will take you from zero to your first working Lionz IPTV Downloader installation. You’ll install dependencies, configure the application, and sync your first content from Lionz TV.

​
Before You Begin

Make sure you have:
  • A Lionz TV subscription with Xtream Codes API credentials
  • PHP 8.4 or higher installed
  • pnpm package manager
  • Basic familiarity with terminal/command line
Don’t have PHP 8.4, pnpm, or other prerequisites? See the detailed Installation Guide for setup instructions.

​
Quick Installation

1

Clone the Repository

Clone the Lionz IPTV Downloader repository and navigate to the project directory:
git clone https://github.com/shekohex/lionzhd.git
cd lionzhd
2

Install Dependencies

Install both PHP and Node.js dependencies:
composer install
pnpm install
If you prefer using Bun instead of pnpm, you can use bun install as the package manager is already configured in package.json.
3

Set Up Database

Create the SQLite database file:
touch database/database.sqlite
4

Initialize the Project

Run the post-creation script to generate app key and run migrations:
composer run-script post-create-project-cmd
This command will:
  • Generate your application encryption key
  • Create the database file if it doesn’t exist
  • Run all database migrations
5

Configure Environment

Create your .env file from the example:
cp .env.example .env
Open .env and configure your essential settings:
.env
# Lionz IPTV Service Credentials (Required)
XTREAM_CODES_API_HOST=your-lionz-host
XTREAM_CODES_API_PORT=80
XTREAM_CODES_API_USER=your-username
XTREAM_CODES_API_PASS=your-password

# MeiliSearch Configuration (Required)
MEILISEARCH_HOST=http://localhost:7700
MEILISEARCH_KEY=your-master-key

# Aria2 Configuration (Required for downloads)
ARIA2_RPC_HOST=http://localhost
ARIA2_RPC_PORT=6800
ARIA2_RPC_SECRET=your-secret-token
Replace the placeholder values with your actual credentials. The application won’t work without valid Lionz TV credentials and MeiliSearch configuration.
6

Start Required Services

Before starting the application, ensure MeiliSearch and aria2 are running:MeiliSearch (in a separate terminal):
meilisearch --master-key=your-master-key
aria2 (in another terminal):
aria2c --enable-rpc --rpc-secret=your-secret-token
For a better aria2 experience, consider using Motrix which provides a GUI for aria2 with RPC enabled by default.
7

Initialize Application Configuration

Initialize the application configurations in the database:
php artisan lionz:configure
This command stores your aria2 and Xtream Codes configurations from the .env file into the database for the application to use.
8

Start the Development Server

Start all required development services with a single command:
composer dev
This will concurrently run:
  • Laravel development server (port 8000)
  • Queue worker for background jobs
  • Log watcher for debugging
  • Vite development server for frontend assets
The application will be available at http://localhost:8000
9

Sync Your First Content

Now sync media content from Lionz TV:
php artisan lionz:sync-media
This command will:
  • Fetch all available categories from Lionz TV
  • Sync VOD (Video on Demand) content
  • Sync Series content
  • Index everything in MeiliSearch for fast searching
The first sync may take several minutes depending on the size of your Lionz TV catalog. Subsequent syncs will be faster.
10

Access the Application

Open your browser and navigate to:
http://localhost:8000
You should see the welcome page with your recently added movies and series. You can now:
  • Search through your content library
  • Browse movies and series
  • Download content to your local machine
  • Set up automatic monitoring for new episodes

​
What’s Next?

Configuration Guide

Learn about advanced configuration options and customization

Usage Guide

Discover all features including search, downloads, and series monitoring

API Reference

Explore the Xtream Codes API integration and endpoints

Troubleshooting

Common issues and their solutions

​
Quick Tips

Sync Regularly: Set up a cron job to run php artisan lionz:sync-media periodically to keep your content library up-to-date with new releases.
Monitor Favorites: Use the series monitoring feature to automatically download new episodes of your favorite shows as they’re released.
Performance: The first sync indexes all content in MeiliSearch. After that, searches are lightning-fast even with thousands of items.

​
Need Help?

If you encounter any issues during setup:
  1. Check the Installation Guide for detailed prerequisites
  2. Review the Configuration Guide for environment setup
  3. Visit the Troubleshooting page for common issues
  4. Open an issue on GitHub

Build docs developers (and LLMs) love

Get started for freeTalk to us