Setting Up Lightna for a New Project

System Requirements

• Ubuntu or macOS
• PHP 8.1, 8.2, or 8.3
• Required PHP extensions: pdo, yaml, ctype

Compose Packages

composer init --no-interaction --name="internal/lightna-project" --type="project"
composer require lightna/pack
composer require --dev phpunit/phpunit

Configure Lightna Entry

cp -r vendor/lightna/pack/entry/. .
cp edition/main/sample.config.php edition/main/config.php
cp edition/main/sample.env.php edition/main/env.php

Edit config.php and env.php in the edition/main folder, following the comments to verify and complete the configuration. Ensure that no **** placeholders remain in the files after editing.

Add the generated assets folder (pub/lightna) to the app root .gitignore. (Double-check your config.php for the correct path.)

Additional Modules

If needed on the project, add the following packages:

• composer require lightna/session - Lightna session support
• composer require lightna/redis - Redis storage support
• composer require lightna/elasticsearch - Elasticsearch support

Add newly installed packages to the enabled modules in edition/main/config.php

Install & Build

make build
make schema.update

Initialize Indices

./cli index.update.all

Setup Indexer Cron Job

* * * * * { cd [lightna_entry_path] && ./cli index.queue.watch; } 2>&1 >> [logs_path]/lightna-index.log

The index.queue.watch command applies changes immediately and continues monitoring for new changes until the end of the minute. This behavior can be adjusted via configuration. Alternatively, you can use index.queue.process if you need the indexer to process the queue explicitly once per minute.

Ready for implementation

You are ready to compile, index and render (see Development docs).

Setting Up Deployment

For detailed instructions, see Setting Up Deployment.