PHPackages                             unarealidad/canarium-kernal-core - 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. [Framework](/categories/framework)
4. /
5. unarealidad/canarium-kernal-core

ActiveLibrary[Framework](/categories/framework)

unarealidad/canarium-kernal-core
================================

The base of canarium that includes the framework and the abstraction layers that is crucial for building canarium-based applications.

01JavaScript

Since Jan 4Pushed 9y agoCompare

[ Source](https://github.com/unarealidad-tech-studio/canarium-kernal-core)[ Packagist](https://packagist.org/packages/unarealidad/canarium-kernal-core)[ RSS](/packages/unarealidad-canarium-kernal-core/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

CanariumCore
============

[](#canariumcore)

The base of canarium that includes the framework and the abstraction layers that is crucial for building canarium-based applications.This is the core of canarium that installs and initializes dependencies for Canarium Modules to work. This is the the base requirement of any canarium appinstance or appmaster.

Installation
============

[](#installation)

Install via composer:

`composer require unarealidad/canarium-kernal-core dev-master`

Add `CanariumCore` to your Appmaster's `config/application.config.php` or your Appinstance's `config/instance.config.php` under the key `modules`

Copy the sample config `config/canariumcontactus.local.php.dist` to your Appinstance's `config/autoload/` directory and remove the `.dist` extension.

Go to your Appinstance directory and run the following to update your database:

`./doctrine-module orm:schema-tool:update --force`

Import data/initial\_rows.sql to your database. This will add 2 new users in the database:

User: Password: 123456 User Level: Super User

User: Password: 123456 User Level: Admin

Remember to change the password for each account.

Configuration
=============

[](#configuration)

Configuration main key: `canariumcore`Sample Config file: `config/canariumcore.local.php.dist`

Config ItemSample ValueRequiredDescriptionsite\_name'Sample Site'trueThe name of your site that will be displayed in the page titleverbose\_titletruefalseWhether we show the controller and action in the page title for debugging purposeis\_authentication\_requiredtruefalseWhether all pages needs to be accessed by logged in users only. Defaults to false. If set to true, then all request to a page by a guest user will redirect them to the login page (except for register and forgot password page).is\_authentication\_whitelistarray('login')falseArray of routes to exclude from the redirection caused by `is_authentication_required`.login\_on\_denied\_accesstruefalseWhether we redirect the user to the login page when a 403 forbidden is issued. Defaults to true. If set to false, the 403 message and trace will be seen which is good for debugging purposes.denied\_access\_redirect\_route'home'The route to redirect to when a 403 is issued. This will be overriden if login\_on\_denied\_access is set to true.logout\_third\_party\_login\_toofalsefalseWhether we logout third party login sessions too like Google after the user logs out.application\_hash'#1HKS)>>#EAZJR'falseThe hash that will be used when creating authentication tokendefault\_app\_id11falseThe default app id to use on api callsdefault\_app\_secret'50b9d04e28e1380bf522a7430b7a9b5c08a8cc16'falseThe default app secret to use on api callsExposed Pages
=============

[](#exposed-pages)

URLTemplateAccessDescription/user/loginuser/login.phtmlGuestDisplays the login page/user/logout*none*UserLogs the user out/user/registeruser/register.phtmlGuestDisplays the registration page/user/changepassworduser/changepassword.phtmlUserDisplays the change password page/user/changeemailuser/changeemail.phtmlUserDisplays the change email pageuser/update-profileuser/update-profile.phtmlUserDisplays the profile update page/adminadmin/index.phtmlAdminDisplays the landing page for the admin panel\* All template locations are relative to the Appinstance root's /public/templates/canarium-core/. Sample templates are provided in the module's view/ directory.

Exposed Services
================

[](#exposed-services)

`canariumcore_user_service` - The user service that handles user related operations like loggin in, registration etc. `canariumcore_app_service` - Api service of canarium

Canarium Exposed Endpoints
==========================

[](#canarium-exposed-endpoints)

All endpoints of canarium are exposed in '/canarium-api'. The returned data is in json in the following format

```
{
    code: 200,
    message: 'Some message',
    data: {}
}
```

Where `data` contains the output of the endpoint.

EndpointMethodParametersDescription/canarium-api/get-current-userGET*none*Returns the current logged in user information./canarium-api/loginPOSTid, secret, emailReturns an access token to the user/canarium-api/delete-accountPOSTaccess\_tokenDeletes the current logged in user. This requires a valid access token

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity1

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 60.9% 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/413897a0aac7a60d32f8cadc18d590daaa596a0644c2d871065366839cb88ff3?d=identicon)[unarealidad](/maintainers/unarealidad)

---

Top Contributors

[![Fatal-Errol](https://avatars.githubusercontent.com/u/6903866?v=4)](https://github.com/Fatal-Errol "Fatal-Errol (14 commits)")[![unarealidadtech](https://avatars.githubusercontent.com/u/24706184?v=4)](https://github.com/unarealidadtech "unarealidadtech (9 commits)")

### Embed Badge

![Health badge](/badges/unarealidad-canarium-kernal-core/health.svg)

```
[![Health](https://phpackages.com/badges/unarealidad-canarium-kernal-core/health.svg)](https://phpackages.com/packages/unarealidad-canarium-kernal-core)
```

###  Alternatives

[laravel/telescope

An elegant debug assistant for the Laravel framework.

5.2k67.8M192](/packages/laravel-telescope)[spiral/roadrunner

RoadRunner: High-performance PHP application server and process manager written in Go and powered with plugins

8.4k12.2M84](/packages/spiral-roadrunner)[nolimits4web/swiper

Most modern mobile touch slider and framework with hardware accelerated transitions

41.8k177.2k1](/packages/nolimits4web-swiper)[laravel/dusk

Laravel Dusk provides simple end-to-end testing and browser automation.

1.9k36.7M259](/packages/laravel-dusk)[laravel/prompts

Add beautiful and user-friendly forms to your command-line applications.

708181.8M596](/packages/laravel-prompts)[cakephp/chronos

A simple API extension for DateTime.

1.4k47.7M121](/packages/cakephp-chronos)

PHPackages © 2026

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