PHPackages                             clarion-app/clarion-setup - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. clarion-app/clarion-setup

ActiveLibrary

clarion-app/clarion-setup
=========================

012PHP

Since Jun 18Pushed 10mo ago1 watchersCompare

[ Source](https://github.com/clarion-app/backend)[ Packagist](https://packagist.org/packages/clarion-app/clarion-setup)[ RSS](/packages/clarion-app-clarion-setup/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

clarion-app/backend
===================

[](#clarion-appbackend)

This is a Laravel package providing APIs and services for Clarion, a decentralized platform for managing your data and applications.

Features
--------

[](#features)

- OAuth2 authentication with Laravel Passport
- Clarion network management: create/join networks
- Composer, NPM, and app package installation/uninstallation

Requirements
------------

[](#requirements)

- PHP >= 8.0
- Laravel >= 12.x
- Composer
- MariaDB or PostgreSQL
- Node.js and NPM (for frontend asset compilation)

Installation
------------

[](#installation)

1. Require the package via Composer:

    ```
    composer require clarion-app/backend
    ```
2. Publish the configuration file:

    ```
    php artisan vendor:publish --provider="ClarionApp\Backend\ClarionBackendServiceProvider" --tag="clarion-config"
    ```
3. Add the following to your `.env` file:

    ```
    FRONTEND_URL=https://your-frontend-url.example.com
    ```
4. Run database migrations:

    ```
    php artisan migrate
    ```
5. Install Laravel Passport:

    ```
    php artisan passport:install
    ```

Configuration
-------------

[](#configuration)

After publishing, the configuration can be found in `config/clarion.php`:

```
return [
    'node_id'      => env('CLARION_NODE_ID'),
    'frontend_url' => env('FRONTEND_URL'),
];
```

- `node_id`: Unique UUID for this Clarion node
- `frontend_url`: URL of the Clarion frontend for device presentation

Usage
-----

[](#usage)

### Artisan Commands

[](#artisan-commands)

- `php artisan clarion:setup-node-id` — Generate and set node ID

### API Endpoints

[](#api-endpoints)

See `src/Routes.php` for the full list. Key endpoints include:

- `GET /Description.xml` — UPnP device descriptor
- `POST /api/clarion/system/network/create` — Create a new Clarion network
- `POST /api/clarion/system/network/join` — Join an existing network
- `POST /api/clarion/system/composer/install` — Install a Composer package
- `POST /api/clarion/network/join` — Join a peer network
- `GET /api/clarion/network/local_nodes` — List local nodes
- `GET /api/clarion/network/requests` — List network join requests
- `GET /api/docs/packages` — Retrieve API package documentation

### Scheduling

[](#scheduling)

A Clarion node discovery job runs every five seconds when the queue worker is active. Start your queue worker with:

```
php artisan queue:work --queue=default
```

Contributing
------------

[](#contributing)

Contributions are welcome! Please submit issues and pull requests via GitHub.

License
-------

[](#license)

This project is licensed under the MIT License.

Author
------

[](#author)

Tim Schwartz ()

###  Health Score

17

—

LowBetter than 6% of packages

Maintenance40

Moderate activity, may be stable

Popularity5

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity14

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/544de7b46960eb87f0f60bc59cb8bd4dccd2679622adf0c8ed82b75df9f65685?d=identicon)[timschwartz](/maintainers/timschwartz)

---

Top Contributors

[![timschwartz](https://avatars.githubusercontent.com/u/13080528?v=4)](https://github.com/timschwartz "timschwartz (112 commits)")

### Embed Badge

![Health badge](/badges/clarion-app-clarion-setup/health.svg)

```
[![Health](https://phpackages.com/badges/clarion-app-clarion-setup/health.svg)](https://phpackages.com/packages/clarion-app-clarion-setup)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)