VitoDeploy

https://vitodeploy.com/docs
Admin
VitoDeploy is a free, open-source server management tool that provisions servers, manages databases,...
Tokens:23,557
Snippets:445
Trust Score:6.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### View Installation Success Output

Source: https://vitodeploy.com/docs/getting-started/installation

Example of the confirmation message displayed upon successful completion of the installation process.

```text
🎉 Congratulations!
✅ SSH User: SSH-USER
✅ SSH Password: SSH-PASSWORD
✅ Admin Email: ADMIN-EMAIL
✅ Admin Password: ADMIN-PASSWORD
```

--------------------------------

### Laravel Deployment Script Example

Source: https://vitodeploy.com/docs/sites/application

A complete deployment script example for a Laravel application, including dependency installation and migration steps.

```shell
cd $SITE_PATH

php artisan down

git pull origin $BRANCH

composer install --no-interaction --prefer-dist --optimize-autoloader
php artisan migrate --force

php artisan optimize:clear
php artisan optimize

sudo service supervisor restart

php artisan up

echo "✅ Deployment completed successfully!"
```

--------------------------------

### Listen to service installation events

Source: https://vitodeploy.com/docs/plugins

Use the boot method in your Plugin class to listen for service installation and uninstallation events.

```PHP
use App\Events\ServiceInstalled;
use App\Events\ServiceUninstalled;

class Plugin extends AbstractPlugin
{
    public function boot()
    {
        Event::listen('service.installed', function (Service $service) {
            // Do something when the service is installed
            Log::info("Service installed: {$service->id}");
        });
        Event::listen('service.uninstalled', function (Service $service) {
            // Do something when the service is uninstalled
            Log::info("Service uninstalled: {$service->id}");
        });
    }
}
```

--------------------------------

### Run Build Commands

Source: https://vitodeploy.com/docs/sites/commands

Example of using installed package managers like npm within a command.

```shell
npm ci && npm run build
```

--------------------------------

### Install VitoDeploy on VPS

Source: https://vitodeploy.com/docs/getting-started/installation

Execute this command as the root user on a fresh Ubuntu 24.04 server to initiate the installation.

```shell
bash <(curl -Ls https://raw.githubusercontent.com/vitodeploy/vito/4.x/scripts/install.sh)
```

--------------------------------

### Install Dependencies

Source: https://vitodeploy.com/docs/getting-started/installation

Install PHP dependencies using Composer.

```shell
composer install
```

--------------------------------

### Update to Pre-release on VPS

Source: https://vitodeploy.com/docs/getting-started/update

Use the --beta or --alpha flag with the update script to install pre-release versions.

```shell
bash scripts/update.sh --beta
```

--------------------------------

### Install pigz for parallel compression

Source: https://vitodeploy.com/docs/servers/backups

Install pigz to enable multi-core compression for database backups, reducing backup time for large datasets.

```shell
sudo apt install pigz
```

--------------------------------

### Sync GitHub App Installations

Source: https://vitodeploy.com/docs/admin/terminal

Synchronizes local GitHub App source controls with GitHub installations.

```Shell
php artisan github-app:sync
```

--------------------------------

### Start Local Containers

Source: https://vitodeploy.com/docs/getting-started/installation

Boot up the application services in detached mode using Laravel Sail.

```shell
./vendor/bin/sail up -d
```

--------------------------------

### View APT Kept Back Packages

Source: https://vitodeploy.com/docs/prologue/upgrade

Example log output showing packages held back by APT during an update.

```text
The following packages have been kept back:
  libgd3 mysql-common mysql-server

0 upgraded, 0 newly installed, 0 to remove and 3 not upgraded.
```

--------------------------------

### Generate SSL certificate

Source: https://vitodeploy.com/docs/getting-started/securing

Run Certbot to generate and install an SSL certificate for the specified domain.

```Shell
sudo certbot --force-renewal --nginx --noninteractive --agree-tos --cert-name YOUR_DOMAIN -m YOUR_EMAIL -d YOUR_DOMAIN --verbose
```

--------------------------------

### Verify Nginx service status output

Source: https://vitodeploy.com/docs/getting-started/securing

Example output indicating that the Nginx service is active and running.

```Text
● nginx.service - A high performance web server and a reverse proxy server
     Loaded: loaded (/lib/systemd/system/nginx.service; enabled; vendor preset: enabled)
     Active: active (running) since Wed 2024-04-10 11:11:32 UTC; 3 days ago
       Docs: man:nginx(8)
   Main PID: 172473 (nginx)
...
```

--------------------------------

### Manually Upgrade Held-Back Packages

Source: https://vitodeploy.com/docs/prologue/upgrade

Command to manually install packages that APT is holding back.

```shell
sudo apt-get install mysql-server mysql-common libgd3
```

--------------------------------

### Laravel Scheduler Cron Command

Source: https://vitodeploy.com/docs/servers/cronjobs

Example command for executing the Laravel scheduler, using absolute paths and redirecting output to null.

```bash
php /home/vito/your-domain/artisan schedule:run >> /dev/null 2>&1
```

--------------------------------

### Implement plugin lifecycle hooks

Source: https://vitodeploy.com/docs/plugins

Define install, uninstall, enable, and disable methods in your Plugin class to execute logic during plugin lifecycle events.

```PHP
<?php

class Plugin extends AbstractPlugin
{
    protected string $name = 'Name';

    protected string $description = 'Description';

    public function boot(): void
    {
        //
    }

    public function enable(): void
    {
        //
    }

    public function disable(): void
    {
        //
    }

    public function install(): void
    {
        //
    }

    public function uninstall(): void
    {
        //
    }
}
```

--------------------------------

### View MySQL GPG Error

Source: https://vitodeploy.com/docs/prologue/upgrade

Example of the GPG error message encountered when the MySQL APT signing key has expired.

```text
W: GPG error: http://repo.mysql.com/apt/ubuntu noble InRelease: The following signatures were invalid: EXPKEYSIG B7B3B788A8D3785C MySQL Release Engineering <mysql-build@oss.oracle.com>
E: The repository 'http://repo.mysql.com/apt/ubuntu noble InRelease' is not signed.
```

--------------------------------

### Define a Laravel Queue Worker Command

Source: https://vitodeploy.com/docs/servers/workers

Example command for running a Laravel queue worker with a sleep interval.

```shell
php /home/vito/YOUR-DOMAIN/artisan queue:work --sleep=3
```

--------------------------------

### Fix APT Repository Label Change Error

Source: https://vitodeploy.com/docs/servers/php

Run this command as the vito user to resolve repository label change errors that block PHP installations or server updates.

```shell
sudo apt-get update -o Acquire::AllowReleaseInfoChange::Label=true
```

--------------------------------

### Run Database Migrations

Source: https://vitodeploy.com/docs/getting-started/installation

Execute database migrations to set up the schema.

```shell
./vendor/bin/sail artisan migrate
```

--------------------------------

### Configure Local Environment

Source: https://vitodeploy.com/docs/getting-started/installation

Initialize the environment configuration file from the provided template.

```shell
cp .env.sail .env
```

--------------------------------

### Implement Plugin.php for VitoDeploy

Source: https://vitodeploy.com/docs/plugins

Every plugin requires a Plugin.php file extending AbstractPlugin to register site features and actions within the boot method.

```PHP
<?php

namespace App\Vito\Plugins\RichardAnderson\LaravelOctanePlugin;

use App\Plugins\AbstractPlugin;
use App\Plugins\RegisterSiteFeature;
use App\Plugins\RegisterSiteFeatureAction;
use App\Vito\Plugins\RichardAnderson\LaravelOctanePlugin\Actions\Disable;
use App\Vito\Plugins\RichardAnderson\LaravelOctanePlugin\Actions\Enable;

class Plugin extends AbstractPlugin
{
    protected string $name = 'Laravel Octane Plugin';

    protected string $description = 'Laravel Octane plugin for VitoDeploy';

    public function boot(): void
    {
        RegisterSiteFeature::make('laravel', 'laravel-octane')
            ->label('Laravel Octane')
            ->description('Enable Laravel Octane for this site')
            ->register();
        RegisterSiteFeatureAction::make('laravel', 'laravel-octane', 'enable')
            ->label('Enable')
            ->handler(Enable::class)
            ->register();
        RegisterSiteFeatureAction::make('laravel', 'laravel-octane', 'disable')
            ->label('Disable')
            ->handler(Disable::class)
            ->register();
    }
}
```

--------------------------------

### Run Update Script

Source: https://vitodeploy.com/docs/prologue/upgrade

Executes the manual update script. Use the --beta flag if upgrading to a beta release.

```bash
bash scripts/update.sh
```

```bash
bash scripts/update.sh --beta
```

--------------------------------

### Switch to 4.x Branch

Source: https://vitodeploy.com/docs/prologue/upgrade

Checks out the 4.x branch for the upgrade.

```bash
git checkout 4.x
```

--------------------------------

### Navigate to Project Directory

Source: https://vitodeploy.com/docs/prologue/upgrade

Changes the current working directory to the Vito project root.

```bash
cd /home/vito/vito
```

--------------------------------

### Access Interactive API Reference

Source: https://vitodeploy.com/docs/api

The interactive Swagger UI documentation is hosted on your specific VitoDeploy instance.

```text
https://your-vito-instance/api/docs
```

--------------------------------

### Create New User

Source: https://vitodeploy.com/docs/admin/terminal

Creates a new user with a default admin role.

```Shell
php artisan user:create [name] [email] [password] [--role=admin]
```

--------------------------------

### Run VitoDeploy with Docker

Source: https://vitodeploy.com/docs/getting-started/installation

Execute the VitoDeploy container using the docker run command with necessary environment variables and volume mappings.

```shell
docker run -v vito_storage:/var/www/html/storage \
    -v vito_plugins:/var/www/html/app/Vito/Plugins \
    -e APP_KEY=your_32_character_app_key  \
    -e NAME=admin_name \
    -e EMAIL=admin_email \
    -e PASSWORD=admin_password \
    -e APP_URL=http://your-vito-url \
    -e WS_BROADCAST_SECRET=your_websocket_secret \
    -p 80:80 vitodeploy/vito:latest
```

--------------------------------

### Run Pre-commit Checks

Source: https://vitodeploy.com/docs/prologue/contribution-guide

Command to run formatting, tests, and static analysis before committing changes.

```shell
composer pre-commit
```

--------------------------------

### Run Static Analysis

Source: https://vitodeploy.com/docs/prologue/contribution-guide

Commands to execute static analysis tools for PHP and JavaScript/TypeScript codebases.

```shell
# For PHP code
./vendor/bin/phpstan analyse
# For JavaScript/TypeScript code
npm run lint
```

--------------------------------

### Run Automatic Upgrade Script

Source: https://vitodeploy.com/docs/prologue/upgrade

Executes the automatic upgrade script as the vito user. Use the --beta flag while version 4.x is in beta.

```bash
bash <(curl -Ls https://raw.githubusercontent.com/vitodeploy/vito/4.x/scripts/upgrade-3x-to-4x.sh)
```

```bash
bash <(curl -Ls https://raw.githubusercontent.com/vitodeploy/vito/4.x/scripts/upgrade-3x-to-4x.sh) --beta
```

--------------------------------

### Configure Supervisor WebSocket Worker

Source: https://vitodeploy.com/docs/prologue/upgrade

Creates log directories and registers the WebSocket worker with Supervisor.

```bash
sudo mkdir -p /home/vito/.logs/workers
sudo touch /home/vito/.logs/workers/websocket.log
sudo chown -R vito:vito /home/vito/.logs

echo "
[program:websocket]
process_name=%(program_name)s
command=php /home/vito/vito/artisan ws:serve
autostart=1
autorestart=1
user=vito
redirect_stderr=true
stdout_logfile=/home/vito/.logs/workers/websocket.log
" | sudo tee /etc/supervisor/conf.d/websocket.conf

sudo supervisorctl reread
sudo supervisorctl update
sudo supervisorctl start websocket
```

--------------------------------

### Test and Restart Nginx

Source: https://vitodeploy.com/docs/prologue/upgrade

Validates the Nginx configuration syntax and restarts the service.

```bash
sudo nginx -t
sudo service nginx restart
```

--------------------------------

### Modern Deployment Directory Structure

Source: https://vitodeploy.com/docs/sites/modern-deployment

Visual representation of the directory layout after enabling Modern Deployment, showing the current symlink and releases directory.

```text
- current -> releases/initial
- releases
  - initial
  - 20230914120000
  - 20230913120000
- source
```

--------------------------------

### Register a new site type

Source: https://vitodeploy.com/docs/plugins

Use the RegisterSiteType class within the boot method of your Plugin.php to define a new site type and its associated configuration form.

```PHP
\App\Plugins\RegisterSiteType::make('symfony')
    ->label('Symfony')
    ->handler(SymfonyHandler::class)
    ->form(\App\DTOs\DynamicForm::make([
        \App\DTOs\DynamicField::make('php_version')
            ->component()
            ->label('PHP Version'),
        \App\DTOs\DynamicField::make('web_directory')
            ->text()
            ->label('Web Directory')
            ->placeholder('For / leave empty')
            ->description('The relative path of your website from /home/vito/your-domain/'),
    ]))
    ->register();
```

--------------------------------

### Check Server Updates

Source: https://vitodeploy.com/docs/admin/terminal

Queries all servers for available OS package updates.

```Shell
php artisan servers:check-updates
```

--------------------------------

### Deploy VitoDeploy with Docker Compose

Source: https://vitodeploy.com/docs/getting-started/installation

Use a docker-compose.yml file to define the VitoDeploy service, environment variables, and persistent volumes.

```yaml
version: '3'
services:
  vito:
    image: vitodeploy/vito:latest
    ports:
      - '8000:80'
    environment:
      APP_KEY: 'your-32-character-app-key'
      NAME: 'vito'
      EMAIL: 'vito@example.com'
      PASSWORD: 'password'
      APP_URL: 'http://localhost:8000' # Change this to your Vito URL
      WS_BROADCAST_SECRET: 'your-websocket-secret' # Optional, recommended for production
    volumes:
      - 'vito-storage:/var/www/html/storage'
      - 'vito-plugins:/var/www/html/app/Vito/Plugins'
volumes:
  vito-storage:
    driver: local
  vito-plugins:
    driver: local
```

--------------------------------

### Update VitoDeploy on VPS

Source: https://vitodeploy.com/docs/getting-started/update

Run the update script from the project directory as the vito user to update the application.

```shell
cd /home/vito/vito
bash scripts/update.sh
```

--------------------------------

### Register a custom server provider

Source: https://vitodeploy.com/docs/plugins

Registers a new server provider with a specific handler and configuration form. The handler must implement ServerProvider or extend AbstractServerProvider.

```PHP
\App\Plugins\RegisterServerProvider::make('hetzner')
    ->label('Hetzner')
    ->handler(Hetzner::class)
    ->form(
        \App\DTOs\DynamicForm::make([
            \App\DTOs\DynamicField::make('token')
                ->text()
                ->label('API Token'),
        ])
    )
    ->defaultUser('root') // The default ssh user of the server that the provider will create
    ->register();
```

--------------------------------

### Register Server Features and Actions

Source: https://vitodeploy.com/docs/plugins

Use RegisterServerFeature to define a feature and RegisterServerFeatureAction to attach specific handlers and forms to it.

```php
// register feature
\App\Plugins\RegisterServerFeature::make('opcache')
    ->label('OPCache')
    ->description('Enable OPCache for PHP')
    ->register();
// register actions for the feature
\App\Plugins\RegisterServerFeatureAction::make('opcache', 'enable')
    ->label('Enable')
    ->form(\App\DTOs\DynamicForm::make([
      ...
    ]))
    ->handler(Enable::class)
    ->register();
\App\Plugins\RegisterServerFeatureAction::make('opcache', 'disable')
    ->label('Disable')
    ->handler(Disable::class)
    ->register();
```

--------------------------------

### Register a custom source control provider

Source: https://vitodeploy.com/docs/plugins

Registers a new source control provider. Handlers must implement SourceControl or extend AbstractSourceControl.

```PHP
\App\Plugins\RegisterSourceControl::make('github')
    ->label('GitHub')
    ->handler(GitHub::class)
    ->form(
        \App\DTOs\DynamicForm::make([
            \App\DTOs\DynamicField::make('token')
                ->text()
                ->label('Personal Access Token'),
        ])
    )
    ->register();
```

--------------------------------

### Environment Variables Reference

Source: https://vitodeploy.com/docs/sites/commands

List of environment variables available during command execution.

```ini
SITE_PATH=[path to the website]
DOMAIN=[domain name]
BRANCH=[branch name]
REPOSITORY=[repository]
COMMIT_ID=[last deployed commit id]
PHP_VERSION=[the php version your site is running]
PHP_PATH=[path to the php your site is running]
```

--------------------------------

### Apply Configuration Changes

Source: https://vitodeploy.com/docs/getting-started/configuration

Run these commands in the project root to clear the cache and restart workers after modifying environment variables.

```shell
php artisan optimize:clear
php artisan optimize
sudo supervisorctl restart worker:*

```

--------------------------------

### Register a custom storage provider

Source: https://vitodeploy.com/docs/plugins

Registers a new storage provider. The handler must implement StorageProvider or extend AbstractStorageProvider.

```PHP
\App\Plugins\RegisterStorageProvider::make('local')
    ->label('Local')
    ->handler(Local::class)
    ->form(
        \App\DTOs\DynamicForm::make([
            \App\DTOs\DynamicField::make('path')
                ->text()
                ->label('Path'),
        ])
    )
    ->register();
```

--------------------------------

### Configure Mail Server Settings

Source: https://vitodeploy.com/docs/getting-started/configuration

Set these variables in your .env file to enable email functionality via SMTP.

```dotenv
MAIL_HOST={YOUR-SMTP-HOST}
MAIL_PORT={YOUR-SMTP-PORT}
MAIL_USERNAME={YOUR-SMTP-USERNAME}
MAIL_PASSWORD={YOUR-SMTP-PASSWORD}
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS={YOUR-SMTP-MAIL-ADDRESS}

```

--------------------------------

### Default Laravel Artisan Commands

Source: https://vitodeploy.com/docs/sites/commands

Standard commands pre-configured for Laravel sites.

```bash
php artisan cache:clear
```

```bash
php artisan down --retry=5 --refresh=6 --quiet
```

```bash
php artisan up
```

--------------------------------

### Register a tooling provider

Source: https://vitodeploy.com/docs/plugins

Register custom tooling providers by merging them into the tooling.providers configuration array.

```PHP
config([
    'tooling.providers' => array_merge(
        config('tooling.providers', []),
        [YourTooling::class],
    ),
]);
```

--------------------------------

### Configure WebSocket proxy path

Source: https://vitodeploy.com/docs/getting-started/securing

Forward the /ws/ path to the WebSocket server to enable live console and real-time updates.

```Nginx
location /ws/ {
    proxy_pass http://127.0.0.1:8085;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_read_timeout 86400;
}
```

--------------------------------

### Update environment variables

Source: https://vitodeploy.com/docs/getting-started/securing

Set the application and asset URLs in the .env file or container environment variables.

```Shell
APP_URL=https://YOUR_DOMAIN
ASSET_URL=https://YOUR_DOMAIN
```

--------------------------------

### Implement SourceControlProvider methods

Source: https://vitodeploy.com/docs/prologue/breaking-changes

New methods required for SourceControlProvider implementations. Extending AbstractSourceControlProvider provides safe defaults for these methods.

```php
public function getSshPort(): int;
public static function editableFields(): array;
public function editRules(array $input): array;
public function editData(array $input): array;
```

--------------------------------

### Enable Force HTTPS

Source: https://vitodeploy.com/docs/getting-started/configuration

Set this variable to true to ensure the application generates HTTPS URLs.

```dotenv
FORCE_HTTPS=true

```

--------------------------------

### Generate SSH Key Pair

Source: https://vitodeploy.com/docs/getting-started/installation

Create the required OpenSSL RSA key pair for server management. Replace /PATH_TO_VITO with your actual project path.

```shell
openssl genpkey -algorithm RSA -out /PATH_TO_VITO/storage/ssh-private.pem
chmod 600 /PATH_TO_VITO/storage/ssh-private.pem
ssh-keygen -y -f /PATH_TO_VITO/storage/ssh-private.pem > /PATH_TO_VITO/storage/ssh-public.key
```

--------------------------------

### Authorize VitoDeploy SSH Access

Source: https://vitodeploy.com/docs/servers/create

Run this command as the root user on a custom server to allow VitoDeploy to connect via SSH.

```shell
mkdir -p /root/.ssh && touch /root/.ssh/authorized_keys && echo 'ssh-rsa XXXXXXXXXXXXXXXXXXXXXX' >> /root/.ssh/authorized_keys
```

--------------------------------

### Configure Nginx proxy buffers

Source: https://vitodeploy.com/docs/getting-started/securing

Add these buffer settings to the Nginx reverse proxy configuration.

```Nginx
proxy_buffer_size   128k;
proxy_buffers   4 256k;
proxy_busy_buffers_size   256k;
```

--------------------------------

### Generate Application Key

Source: https://vitodeploy.com/docs/getting-started/installation

Generate the application encryption key.

```shell
./vendor/bin/sail artisan key:generate
```

--------------------------------

### Edit Nginx configuration

Source: https://vitodeploy.com/docs/getting-started/securing

Open the Nginx site configuration file for editing.

```Shell
sudo nano /etc/nginx/sites-available/vito
```

--------------------------------

### Configure backup timeout

Source: https://vitodeploy.com/docs/servers/backups

Increase the default 20-minute backup timeout by setting the BACKUP_RUN_TIMEOUT variable in the .env file.

```dotenv
BACKUP_RUN_TIMEOUT=7200
```

--------------------------------

### Restart and verify Nginx

Source: https://vitodeploy.com/docs/getting-started/securing

Commands to restart the Nginx service and check its current status.

```Shell
sudo service nginx restart
```

```Shell
sudo service nginx status
```

--------------------------------

### Register console commands

Source: https://vitodeploy.com/docs/plugins

Register custom console commands using the RegisterCommand helper.

```PHP
RegisterCommand::make(FetchCommand::class)->register();
```

--------------------------------

### Added SiteType Interface Methods

Source: https://vitodeploy.com/docs/prologue/breaking-changes

New required methods for the SiteType interface to support the template-based vhost rendering model.

```php
public function vhostData(): array;                 // data passed to the vhost template
public function supportedWebservers(): ?array;      // null = all
public function vhostTemplate(string $webserver): ?string;
public function deploymentEnvironment(): array;
public function afterDeploy(Deployment $deployment): void;
public function defaultDeploymentScript(): string;
```

--------------------------------

### Register Custom Services

Source: https://vitodeploy.com/docs/plugins

Define new service types using RegisterServiceType, specifying handlers, configuration paths, and supported versions or extensions.

```php
RegisterServiceType::make(Nginx::id())
    ->type(Nginx::type())
    ->label('Nginx')
    ->handler(Nginx::class)
    ->configPaths([
        [
            'name' => 'nginx.conf',
            'path' => '/etc/nginx/nginx.conf',
            'sudo' => true,
        ],
    ])
    ->register();
\App\Plugins\RegisterServiceType::make('php')
    ->type('php')
    ->label('PHP')
    ->handler(PHP::class)
    ->versions([
        '8.4',
        '8.3',
        '8.2',
        '8.1',
        '8.0',
        '7.4',
        '7.3',
        '7.2',
        '7.1',
        '7.0',
        '5.6',
    ])
    ->data([
        'extensions' => [
            'imagick',
            'exif',
            'gmagick',
            'gmp',
            'intl',
            'sqlite3',
            'opcache',
        ],
    ])
    ->register();
```

--------------------------------

### Required WebServer Abstract Methods

Source: https://vitodeploy.com/docs/prologue/breaking-changes

New abstract methods that must be implemented in WebServer services.

```php
abstract public function generateVhost(Site $site, ?string $template = null): string;
abstract public function deploySplash(): void;
```

--------------------------------

### Check Pending Domains

Source: https://vitodeploy.com/docs/admin/terminal

Verifies DNS resolution for pending domains and activates those that resolve.

```Shell
php artisan domains:check-pending
```

--------------------------------

### Register site features and actions

Source: https://vitodeploy.com/docs/plugins

Register site features and their associated actions to extend site functionality.

```PHP
// register feature
\App\Plugins\RegisterSiteFeature::make('laravel', 'laravel-octane')
    ->label('Laravel Octane')
    ->description('Enable Laravel Octane for this site')
    ->register();
// register actions for the feature
\App\Plugins\RegisterSiteFeatureAction::make('laravel', 'laravel-octane', 'enable')
    ->label('Enable')
    ->form(\App\DTOs\DynamicForm::make([
        \App\DTOs\DynamicField::make('alert')
            ->alert()
            ->label('Alert')
            ->description('Make sure you have already set the `OCTANE_SERVER` in your `.env` file'),
        \App\DTOs\DynamicField::make('port')
            ->text()
            ->label('Octane Port')
            ->default(8000)
            ->description('The port on which Laravel Octane will run.'),
    ]))
    ->handler(Enable::class)
    ->register();
\App\Plugins\RegisterSiteFeatureAction::make('laravel', 'laravel-octane', 'disable')
    ->label('Disable')
    ->handler(Disable::class)
    ->register();
```

--------------------------------

### Register a custom DNS provider

Source: https://vitodeploy.com/docs/plugins

Registers a new DNS provider. The handler must implement DNSProvider or extend AbstractDNSProvider.

```PHP
\App\Plugins\RegisterDNSProvider::make('cloudflare')
    ->label('Cloudflare')
    ->handler(Cloudflare::class)
    ->form(
        \App\DTOs\DynamicForm::make([
            \App\DTOs\DynamicField::make('token')
                ->text()
                ->label('API Token'),
        ])
    )
    ->register();
```

--------------------------------

### Fetch Latest Changes

Source: https://vitodeploy.com/docs/prologue/upgrade

Retrieves the latest updates from the remote repository.

```bash
git fetch
```

--------------------------------

### WebServer updateVHost Signature Change

Source: https://vitodeploy.com/docs/prologue/breaking-changes

The updateVHost method signature has been simplified, removing block-manipulation arrays and changing the default restart behavior.

```php
// 3.x
public function updateVHost(Site $site, ?string $vhost = null, array $replace = [], array $regenerate = [], array $append = [], bool $restart = true): void;
// v4.x
public function updateVHost(Site $site, ?string $vhost = null, bool $restart = false): void;
```

--------------------------------

### Check Server Connections

Source: https://vitodeploy.com/docs/admin/terminal

Manually triggers a check of the SSH connection status for all servers.

```Shell
php artisan servers:check
```

--------------------------------

### Configure domain in Nginx

Source: https://vitodeploy.com/docs/getting-started/securing

Update the server_name directive in the Nginx configuration file to include your domain.

```Nginx
server {
    ...
    server_name _ YOUR_DOMAIN_GOES_HERE;
    ...
}
```

--------------------------------

### Update Deployment Script

Source: https://vitodeploy.com/docs/plugins/laravel-reverb

Include this command in your deployment script to ensure the Reverb server restarts with new code deployments.

```shell
php artisan reverb:restart
```

--------------------------------

### Deployment Script Environment Variables

Source: https://vitodeploy.com/docs/sites/application

List of variables exported by Vito for use within deployment scripts.

```ini
SITE_PATH=[path to the website]
DOMAIN=[domain name]
BRANCH=[branch name]
REPOSITORY=[repository]
COMMIT_ID=[commit id when deploying]
PHP_VERSION=[the php version that your site running]
PHP_PATH=[path to the php your site running]
```

--------------------------------

### Pull Latest VitoDeploy Docker Image

Source: https://vitodeploy.com/docs/getting-started/update

Pull the latest stable image from the registry before recreating the container.

```shell
docker pull vitodeploy/vito:latest
```

--------------------------------

### Deployment Script Variable Usage

Source: https://vitodeploy.com/docs/sites/application

Demonstrates accessing exported Vito variables within a bash deployment script.

```shell
echo "Deploying $DOMAIN to $SITE_PATH"
```

--------------------------------

### Define a script with variables

Source: https://vitodeploy.com/docs/scripts

Use the ${VARIABLE_NAME} syntax to inject dynamic values into your bash scripts.

```shell
echo "Hello ${NAME}"
```

--------------------------------

### Configure WebSocket URL

Source: https://vitodeploy.com/docs/getting-started/configuration

Override the WebSocket connection URL if it differs from the primary APP_URL.

```dotenv
WS_URL=http://localhost

```

--------------------------------

### Format Code Styles

Source: https://vitodeploy.com/docs/prologue/contribution-guide

Commands to automatically fix coding styles for PHP and frontend/bash files.

```shell
./vendor/bin/pint
```

```shell
npm run format
```

--------------------------------

### Register plugin views

Source: https://vitodeploy.com/docs/plugins

Register custom views with a unique name using the RegisterViews helper.

```PHP
RegisterViews::make('vitodeploy-reverb')
            ->path(__DIR__.'/views')
            ->register();
```

--------------------------------

### Configure .env for Laravel Reverb

Source: https://vitodeploy.com/docs/plugins/laravel-reverb

Add these variables to your application's .env file to define public and internal Reverb server settings.

```dotenv
REVERB_HOST={domain}
REVERB_PORT=443            # use 443 for https, or 80 for http
REVERB_SCHEME=https        # use https, or http
REVERB_SERVER_HOST=0.0.0.0
REVERB_SERVER_PORT={reverb port}
```

--------------------------------

### Common API Endpoints

Source: https://vitodeploy.com/docs/api

Endpoints are served under the /api path, typically nested within specific project scopes.

```shell
GET  /api/projects
GET  /api/projects/{project}/servers
POST /api/projects/{project}/servers/{server}/sites
```

--------------------------------

### Migrate Site Type via SQL

Source: https://vitodeploy.com/docs/plugins/laravel-reverb

Update the site type in the VitoDeploy database to convert a deprecated laravel-reverb site to a standard laravel site. Ensure you back up the database before execution.

```sql
UPDATE sites SET type = 'laravel' WHERE type = 'laravel-reverb';
```

--------------------------------

### Delete Older Metrics

Source: https://vitodeploy.com/docs/admin/terminal

Cleans up the database by removing outdated monitoring metrics.

```Shell
php artisan metrics:delete-older-metrics
```

--------------------------------

### Fix File Ownership

Source: https://vitodeploy.com/docs/prologue/upgrade

Ensures the vito user owns the project directory.

```bash
sudo chown -R vito:vito /home/vito/vito
```

--------------------------------

### Authenticate API Requests

Source: https://vitodeploy.com/docs/api

Include the generated API key in the Authorization header as a Bearer token for all requests.

```shell
curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://your-vito-instance/api/projects
```

--------------------------------

### Authenticate with API Key using cURL

Source: https://vitodeploy.com/docs/settings/api-keys

Include the API key as a Bearer token in the Authorization header to authenticate requests to the VitoDeploy API.

```shell
curl -H "Authorization: Bearer YOUR_API_KEY" https://your-vito-instance/api/projects
```

--------------------------------

### Removed SiteType Interface Method

Source: https://vitodeploy.com/docs/prologue/breaking-changes

The vhost method has been removed from the SiteType interface in v4.x.

```php
// GONE from the SiteType interface
public function vhost(string $webserver): string|View;
```

--------------------------------

### Site type interface contract

Source: https://vitodeploy.com/docs/plugins

Required methods for classes implementing the SiteType interface in v4.x.

```PHP
public function vhostData(): array;                 // data passed to the vhost template
public function supportedWebservers(): ?array;      // null = all webservers
public function vhostTemplate(string $webserver): ?string;
public function deploymentEnvironment(): array;     // extra env vars for deploys/commands
public function afterDeploy(Deployment $deployment): void;
public function defaultDeploymentScript(): string;
```

--------------------------------

### Clear Server Logs

Source: https://vitodeploy.com/docs/admin/terminal

Removes all server logs from the database.

```Shell
php artisan logs:clear
```

--------------------------------

### Register a custom notification channel

Source: https://vitodeploy.com/docs/plugins

Registers a new notification channel. The handler must implement NotificationChannel or extend AbstractNotificationChannel.

```PHP
\App\Plugins\RegisterNotificationChannel::make('slack')
    ->label('Slack')
    ->handler(Slack::class)
    ->form(
        \App\DTOs\DynamicForm::make([
            \App\DTOs\DynamicField::make('webhook_url')
                ->text()
                ->label('Webhook URL'),
        ])
    )
    ->register();
```

--------------------------------

### Generate SSH Keys

Source: https://vitodeploy.com/docs/admin/terminal

Regenerates the SSH key pair used for server authentication. Existing servers will lose connectivity unless updated with the new keys.

```Shell
php artisan ssh-key:generate {--force}
```

--------------------------------

### Stash Local Changes

Source: https://vitodeploy.com/docs/prologue/upgrade

Discards potential local modifications to the codebase before upgrading.

```bash
git stash
```

--------------------------------

### Set WebSocket Allowed Origins

Source: https://vitodeploy.com/docs/getting-started/configuration

Define allowed origins for WebSocket connections to prevent cross-site hijacking.

```dotenv
WS_ALLOWED_ORIGINS="${APP_URL}"

```

--------------------------------

### Configure Nginx WebSocket Proxy

Source: https://vitodeploy.com/docs/prologue/upgrade

Adds the required location block to the Nginx site configuration for WebSocket support.

```nginx
    location /ws/ {
        proxy_pass http://127.0.0.1:8085;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_read_timeout 86400;
    }
```

--------------------------------

### Generate WebSocket Secret

Source: https://vitodeploy.com/docs/getting-started/configuration

Use this command to generate a secure random string for the broadcast secret.

```shell
openssl rand -base64 32

```

--------------------------------

### Update MySQL GPG Key

Source: https://vitodeploy.com/docs/prologue/upgrade

Command to refresh the expired MySQL GPG key in the server's keyring.

```shell
sudo gpg --no-default-keyring --keyring /usr/share/keyrings/mysql-apt-config.gpg \
    --keyserver hkps://keyserver.ubuntu.com --recv-keys B7B3B788A8D3785C
```

--------------------------------

### Configure WebSocket Broadcast Secret

Source: https://vitodeploy.com/docs/getting-started/configuration

Define a dedicated secret for WebSocket authentication to avoid reusing the APP_KEY.

```dotenv
WS_BROADCAST_SECRET={A-LONG-RANDOM-STRING}

```
Tokens:
Raw