PHPackages rnsharma93/lara-ftp-deployer - 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. [DevOps & Deployment](/categories/devops) 4. / 5. rnsharma93/lara-ftp-deployer ActiveLibrary[DevOps & Deployment](/categories/devops) rnsharma93/lara-ftp-deployer ============================ A blazing fast, highly optimized FTP-based deployment package for Laravel applications. v0.2.0(2mo ago)102MITPHP Since Feb 28Pushed 2mo agoCompare [ Source](https://github.com/rnsharma93/lara-ftp-deployer)[ Packagist](https://packagist.org/packages/rnsharma93/lara-ftp-deployer)[ RSS](/packages/rnsharma93-lara-ftp-deployer/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (1)DependenciesVersions (3)Used By (0) Lara FTP Deployer ================= [](#lara-ftp-deployer) There are many excellent CI/CD tools available for VPS, cloud, or managed servers. But what about shared hosting where you don't have SSH access or the ability to run commands on the server? In that case, deploying day-to-day Laravel application changes becomes a very difficult and tedious task. **Lara FTP Deployer** comes to the rescue to solve exactly this issue. You can deploy your changes securely via FTP with a single artisan command. Not only does it upload your files, but this single command can also run your configured set of Artisan commands (from `migrate` to `optimize:clear`) directly on the shared hosting server! Furthermore, you can instantly stream, watch, and securely download your remote application logs directly from your terminal, treating your shared host like it has native SSH access. Deploying via FTP doesn't have to be agonizingly slow. This package solves the traditional FTP bottleneck by zipping your application, uploading it as a single chunk, and extracting it blazingly fast directly on your live server using native PHP ZipArchive functions. It intelligently detects what changed locally and **only deploys the exact modified files** using lightning-fast Git Diff analysis, falling back safely to MD5 hash tracking if Git isn't available. Features -------- [](#features) - **Blazing Fast Extraction**: Zip files are uploaded and extracted via `ZipArchive::extractTo()`, turning 10-minute file-by-file uploads into seconds. - **Incremental Deployments**: Analyzes your Git commit history (or local MD5 hashes) to detect additions, modifications, and deletions. Only the exact changes are uploaded to save massive bandwidth. - **NPM & Vite Integration**: Automatically builds your frontend assets in the local environment and uploads the generated static assetsβ€”completely skipping `node_modules`. - **Composer "Vendor" Smart Tracking**: Ignores thousands of vendor files until `composer.json` or `composer.lock` is specifically modified, at which point it seamlessly bundles the new `vendor` map. - **Automated Directory Setup**: Sets up required Laravel directories (like `storage/framework/sessions`, `bootstrap/cache`) seamlessly on initial deployment without overwriting live user data. - **Untracked File Deletion Detection**: Seamlessly detects and deletes files from the remote server if they were uploaded but later locally removed without a Git trace. - **Remote Artisan Execution**: Instantly run database migrations, cache clearing, and specific commands right from your terminal without SSH (`php artisan ftp:cmd`). - **Remote Log Streaming**: Seamlessly tail and watch remote log files locally in your terminal with fully color-coded output, no SSH required (`php artisan ftp:logs`). - **Multi-Environment Support**: Target endless environments via the `--env` flag (e.g. `production`, `staging`, `demo`). --- Requirements ------------ [](#requirements) - **PHP 8.1+** - **Laravel 10+** - Standard FTP connection (Credentials to your cPanel / Plesk or generic server). - **Remote Endpoint**: The server must be capable of parsing `php` to handle extraction and API calls. --- Installation ------------ [](#installation) Install the package into your Laravel project via Composer: ``` composer require rnsharma93/lara-ftp-deployer ``` Publish the configuration file (which copies it to `config/deployer.php`): ``` php artisan vendor:publish --tag="deployer-config" ``` --- Configuration ------------- [](#configuration) Open `.env` and configure your default target server credentials securely: ``` # URL where your Laravel app is hosted (e.g. https://example.com) DEPLOYER_REMOTE_BASE_URL=https://your-domain.com # Standard FTP configurations pointing to your Laravel Root DEPLOYER_FTP_HOST=ftp.your-domain.com DEPLOYER_FTP_USERNAME=your-username DEPLOYER_FTP_PASSWORD=your-password DEPLOYER_FTP_PORT=21 DEPLOYER_FTP_PATH=/public_html/ # Secure random token representing the Handshake Secret DEPLOYER_TOKEN=my-secure-random-deployment-token-12345 # Tracking configuration DEPLOYER_INCREMENTAL=true DEPLOYER_INCREMENTAL_GIT=true ``` ### Multi-Environment Support [](#multi-environment-support) You can define unlimited stages inside `config/deployer.php` (e.g., `production`, `staging`, `testing`). Just define them in the array and use variables like `DEPLOYER_STAGING_FTP_HOST` in your `.env` appropriately. **Example configuring Staging and Production in `.env`:** ``` # Production Environment DEPLOYER_PRODUCTION_REMOTE_BASE_URL=https://production.com DEPLOYER_PRODUCTION_FTP_HOST=ftp.production.com DEPLOYER_PRODUCTION_FTP_USERNAME=prod-username DEPLOYER_PRODUCTION_FTP_PASSWORD=prod-password DEPLOYER_PRODUCTION_FTP_PATH=/public_html/ DEPLOYER_PRODUCTION_DEPLOY_TOKEN=super-secret-production-token # Staging Environment DEPLOYER_STAGING_REMOTE_BASE_URL=https://staging.example.com DEPLOYER_STAGING_FTP_HOST=ftp.staging.example.com DEPLOYER_STAGING_FTP_USERNAME=stage-username DEPLOYER_STAGING_FTP_PASSWORD=stage-password DEPLOYER_STAGING_FTP_PATH=/staging_html/ DEPLOYER_STAGING_DEPLOY_TOKEN=my-secure-staging-token ``` --- How it Tracks Changes --------------------- [](#how-it-tracks-changes) The deployer intelligently utilizes two tracking methods to avoid uploading thousands of files: ### 1. Git Diff Tracking (Recommended) [](#1-git-diff-tracking-recommended) Enabled securely by default if Git is initialized. The system reads the last historically deployed commit hash saved on the live server (`deploy-meta.json`) and compares it against your local `HEAD` commit. **Uncommitted files are safely ignored!** Only strictly committed modifications will deploy. Enable via `.env`: `DEPLOY_INCREMENTAL_GIT=true` ### 2. Hash Tracking (Fallback) [](#2-hash-tracking-fallback) If `git_enabled` is set to `false` or Git is entirely missing from your system, the script instantly evaluates your `base_path()`, computes instantaneous MD5 hashes, and evaluates the changes perfectly. --- Exclude Files & Folders --------------------------- [](#exclude-files--folders) There are files that should logically **never** be copied into your production zip package. You can configure what paths to automatically block inside `config/deployer.php`. ``` 'exclude' => [ '.git', '.env', '.env.*', 'node_modules', 'tests', 'storage/logs', 'storage/framework/cache', 'storage/framework/sessions', 'storage/framework/views', '.idea', '.vscode', ], ``` *(Note: Even though the `storage` folders are heavily excluded from tracking scanning for performance, the deployment zip will still gracefully ensure these empty frameworks exist on first deployments!)* --- Usage ----- [](#usage) ### πŸš€ 1. The Initial Deployment [](#-1-the-initial-deployment) If you are deploying a fresh project to a blank server, use the `--init` flag. This bypasses tracking checks, pulls your fully localized config, sets up `storage/` directory definitions, builds your NPM assets, uploads a remote web-extractor, and zips the comprehensive root structure completely. ``` php artisan ftp:deploy --init ``` Once extracted, you can jump onto your server to simply define your remote `.env` variables and hook up the Database! ### πŸš€ 2. Standard Incremental Deployments [](#-2-standard-incremental-deployments) For your day-to-day deployments, just run the default command: ``` php artisan ftp:deploy ``` **What it does behind the scenes:** 1. Triggers `npm run build` seamlessly. 2. Quickly computes what was locally modified/deleted. 3. Bundles them in a Zip archive weighing a few kilobytes. 4. FTP uploads the tight package. 5. Remotely commands the Laravel server API endpoint to extract the files, perform automatic File Deletions, and run your automated `artisan` server hooks! ### 🌍 3. Target Alternative Environments [](#-3-target-alternative-environments) Deploy to `staging` environment configured in `config/deployer.php`: ``` php artisan ftp:deploy --env=staging ``` --- Advanced Flags & Controls ----------------------------- [](#advanced-flags--controls) Modify your deployment operations using these terminal flags for granular control: - `--full` : Bypasses incremental change tracking. Force compiles and zips the entire root directory (minus your `exclude` variables). - `--skip-npm` : Need to just change a PHP controller? Skip the NPM build pipeline dynamically to deploy in 2 seconds. - `--skip-ftp` : Generates the ZIP and runs the scanner locally for debugging, but intentionally skips the FTP upload and Remote API actions. - `--zipname=name.zip` : Allows you to customize the deployment payload label. - `--delete="path"` : Manually issue a server-side deletion of a stale remote file. Example: ``` php artisan ftp:deploy --skip-npm --env=production ``` --- Remote Commands --------------- [](#remote-commands) Need to clear the cache remotely, optimize, or migrate the server database immediately? You can talk seamlessly to the remote API directly from your terminal. ``` php artisan ftp:cmd --cmd="migrate" php artisan ftp:cmd --cmd="cache:clear" --env=staging ``` > **Note:** The server-side runner gracefully captures terminal streams, so output is perfectly mapped over HTTP back to your local IDE in real-time. --- Remote Log Streaming -------------------- [](#remote-log-streaming) When bugs happen on a shared host, SSHing in to check `laravel.log` isn't an option. The `ftp:logs` command utilizes lightning-fast pooling to stream remote files directly into your local terminal in beautifully color-coded text. **1. Tail the Default Log**Instantly view the last 100 lines of `storage/logs/laravel.log`: ``` php artisan ftp:logs ``` **2. Watch the Server Log Live**Watch the log file continuously. Every 3 seconds it securely queries the FTP server for *new* bytes (it does not download the whole file repeatedly!) and streams it directly to your CLI: ``` php artisan ftp:logs --watch ``` **3. Tail Custom Paths**Specify exactly how many lines you want from other log files relative to `storage/logs/`: ``` php artisan ftp:logs --path="worker.log" --tail=50 ``` **4. Safely Download Huge Logs**If a file is extremely large, streaming can be hazardous. The `--download` flag instantly checks the filesize metadata on the server. If it is over **5MB**, it warns you first. It then downloads it securely to your local machine (`storage/logs/laravel-server.log`): ``` php artisan ftp:logs --download ``` --- Customizing Automated Commands ------------------------------ [](#customizing-automated-commands) After a zip is successfully extracted on the server, the config sequentially triggers remote hooks immediately. You can define what hits the server after deploying via `config/deployer.php` in the remote environments list: ``` 'artisan_commands' => [ 'down', 'migrate --force', 'optimize:clear', 'config:cache', 'up', ], ``` Enjoy lightning-fast deployments! --- πŸ‘¨β€πŸ’» Developed By ---------------- [](#‍-developed-by) **Ram Sharma** - GitHub: [@rnsharma93](https://github.com/rnsharma93) - Email: If you find this package helpful in your daily deployment workflow, please consider starring the repository on GitHub! --- πŸ“œ License & Open Source --------------------------- [](#-license--open-source) The **Lara FTP Deployer** package is open-source software licensed under the [MIT license](https://opensource.org/licenses/MIT). You are completely free to use, modify, and distribute this package in both personal and commercial projects. Contributions, issues, and feature requests are always welcome! Feel free to check the [issues page](https://github.com/rnsharma93/lara-ftp-deployer/issues) if you want to contribute. ### Health Score 32 β€” LowBetter than 72% of packages Maintenance86 Actively maintained with recent releases Popularity8 Limited adoption so far Community6 Small or concentrated contributor base Maturity25 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. ### Release Activity Cadence Every ~0 days Total 2 Last Release 73d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/5941a4aa5f1867f74f35af1cc991070b627b3741ac9f137fc71e4ee9e73dac45?d=identicon)[rnsharma93](/maintainers/rnsharma93) --- Top Contributors [![rnsharma93](https://avatars.githubusercontent.com/u/12048984?v=4)](https://github.com/rnsharma93 "rnsharma93 (5 commits)") ### Embed Badge ![Health badge](/badges/rnsharma93-lara-ftp-deployer/health.svg) ``` [![Health](https://phpackages.com/badges/rnsharma93-lara-ftp-deployer/health.svg)](https://phpackages.com/packages/rnsharma93-lara-ftp-deployer) ``` ### Alternatives [deployer/deployer Deployment Tool 11.0k25.4M207](/packages/deployer-deployer)[appwrite/server-ce End to end backend server for frontend and mobile apps. 55.3k84.2k](/packages/appwrite-server-ce)[pragmarx/health Laravel Server & App Health Monitor and Notifier 2.0k1.0M2](/packages/pragmarx-health)[felixfbecker/language-server-protocol PHP classes for the Language Server Protocol 22476.7M6](/packages/felixfbecker-language-server-protocol)[heroku/heroku-buildpack-php Toolkit for starting a PHP application locally, with or without foreman, using the same config for PHP and Apache2/Nginx as on Heroku 8161.3M10](/packages/heroku-heroku-buildpack-php)[tiamo/phpas2 PHPAS2 is a php-based implementation of the EDIINT AS2 standard 4674.7k](/packages/tiamo-phpas2) PHPackages Β© 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)