WebGuard Documentation

# App
CI_ENVIRONMENT = production
app.baseURL = 'https://yourdomain.com/'
app.appTimezone = 'America/Sao_Paulo'

# Database
database.default.hostname = localhost
database.default.database = your_database
database.default.username = your_user
database.default.password = your_password
database.default.DBDriver = MySQLi

# Security
encryption.key = hex2bin:YOUR_HEX_KEY_HERE

# 1. Run migrations
php spark migrate --all

# 2. Run seeds
php spark db:seed DataSeeder

CI_ENVIRONMENT = development
app.baseURL = 'http://localhost/webguard/public/'

database.default.hostname = localhost
database.default.database = webguard
database.default.username = root
database.default.password = 
database.default.DBDriver = MySQLi

app.baseURL = 'https://yourdomain.com/app/public/'

# 1. Clone or copy WebGuard files into your project
cp -r webguard/app/* your-project/app/

# 2. Install dependencies
composer install

# 3. Run migrations
php spark migrate --all

# 4. Run seeds
php spark db:seed DataSeeder

# 5. Start development server
php spark serve

{
  "email": "[email protected]",
  "password": "your_password"
}

{
  "status": "success",
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  "user": {
    "id": 1,
    "name": "Admin",
    "email": "[email protected]",
    "group": "admin"
  }
}

curl -X GET https://yourdomain.com/api/users \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..." \
  -H "Content-Type: application/json"

namespace App\Controllers\Api;

use App\Controllers\BaseController;

class Products extends BaseController
{
    public function index()
    {
        $data = [
            ['id' => 1, 'name' => 'Widget', 'price' => 9.99],
        ];

        return $this->response
            ->setStatusCode(200)
            ->setJSON(['status' => 'success', 'data' => $data]);
    }
}

$routes->group('api', ['filter' => 'jwt'], function($routes) {
    $routes->get('products', 'Api\Products::index');
});

app/Modules/
└── MyAddon/
    ├── app.json          # Manifest & hook definitions
    ├── Controllers/
    │   └── MyAddon.php
    ├── Models/
    │   └── MyAddonModel.php
    ├── Views/
    │   ├── index.php
    │   └── hooks/
    │       └── user_list_action.php
    └── Database/
        └── Migrations/

{
  "name": "My Addon",
  "description": "A sample WebGuard add-on",
  "type": "module",
  "author": "Your Name",
  "homepage": "https://example.com",
  "license": "MIT",
  "version": "1.0.0",
  "requires": {
    "webguard": ">=3.0.0"
  },
  "directory": "MyAddon",
  "menu": [
    {
      "icon": "fas fa-puzzle-piece",
      "title": "App.menu_myaddon",
      "children": [
        {
          "title": "App.menu_myaddon_list",
          "url": "myaddon",
          "external": false
        },
        {
          "title": "App.menu_myaddon_add",
          "url": "myaddon/add",
          "external": false
        }
      ]
    }
  ],
  "hooks": [
    {
      "point": "user_list_actions",
      "actions": [
        {
          "label": "View Tasks",
          "url": "myaddon?user={token}",
          "icon": "fas fa-tasks"
        }
      ]
    },
    {
      "point": "settings_tab_nav",
      "view": "MyAddon/Views/hooks/settings_tab"
    }
  ]
}

[
  {
    "name": "My Addon",
    "directory": "MyAddon",
    "status": true,
    "rules": ["115b5ad39b853084209caf6824224f6b"]
  }
]

Authorization: SSO-Broker MY_BROKER:TOKEN

$checksum = hash_hmac('sha256', 'attach' . $token, $secretKey . $broker);

{
  "token":      "abc123...",
  "first_name": "John",
  "last_name":  "Doe",
  "email":      "[email protected]",
  "picture":    "https://...",
  "language":   "en",
  "country":    "US",
  "status":     1,
  "group":      "115b5ad39b853084209caf6824224f6b"
}

{
  "token":      "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_in": 3600
}

$notif = new \App\Models\NotificationModel();
$notif->send([
    'recipient' => $userToken,
    'template' => 'welcome',
    'channel'  => ['email', 'whatsapp'],
    'data'     => ['name' => $user['first_name']],
]);

{
  "User": ["index", "add", "edit", "store", "delete", "impersonate"],
  "Settings": ["index", "store", "oauth", "module"],
  "Activity": ["index"]
}