mirror of
https://github.com/InvoiceShelf/InvoiceShelf.git
synced 2026-07-18 06:45:20 +00:00
c1cadb7ee0
The v2 self-updater only overlays new files (copyFiles) and never removes files a release deleted; the one removal path (deleted_files) is not even sent by the web UI. A major upgrade (v2 → v3) removes thousands of files, so overlay-only leaves a broken hybrid, and stale bootstrap/cache config + package-discovery survive and break the new boot. Backport v3's manifest allow-list approach into this final v2 release: - Updater::cleanStaleFiles(?string $basePath): delete every file under the install not listed in the release's manifest.json, except the configured update_protected_paths. No manifest present → safe no-op (v2→v2 updates). - Updater::clearCompiledCaches(): wipe bootstrap/cache/*.php and compiled views so the freshly copied release re-reads config and re-runs package discovery. Called at the end of copyFiles() — the last point that runs as the currently-installed code before the new release boots, and necessary because bootstrap/cache is itself a protected path. - DeleteFilesController + UpdateCommand: when manifest.json is present, run cleanStaleFiles(); otherwise fall back to the legacy deleted_files list. No route or frontend change — both already call the delete step between copy and migrate. - config/invoiceshelf.php: add update_protected_paths (.env, storage, vendor, node_modules, Modules, public/storage, .git, bootstrap/cache, manifest.json). The v3 release zip already ships manifest.json (built by its make dist), so a v2 instance running this updater cleans itself up correctly on upgrade. Tested: tests/Unit/UpdaterTest.php covers stale removal, protected-path and manifest preservation, empty-dir pruning, no-manifest no-op, and invalid manifest. Full suite green.
Introduction
InvoiceShelf is an open-source web & mobile app that helps you track expenses, payments & create professional invoices & estimates.
The Web Application is made using Laravel & VueJS while the Mobile Apps are built using React Native.
To get started with InvoiceShelf using Docker Compose, check out the Installation docs.
Table of Contents
Documentation
System Requirements
- Starting from v2.2.0 (Laravel 13 upgrade), InvoiceShelf requires PHP 8.4+.
- Before updating from the app settings, verify your server PHP version and required extensions.
- The in-app updater checks requirements and blocks the update if they are not met.
Download
Mobile Apps
- Andorid - Coming Soon
- IOS - Coming Soon
- Source
Discord
Join the InvoiceShelf discord server to discuss: Invite Link
Roadmap
~~Here's a rough roadmap of things to come (not in any specific order):
- Automatic Update
- Email Configuration
- Installation Wizard
- Address Customisation & Default notes
- Edit Email before Sending Invoice
- Available as a docker image
- Performance Improvements
- Customer View page
- Add and Use Custom Fields on Invoices & Estimates.
- Multiple Companies
- Recurring Invoices
- Customer Portal
- Accept Payments (Stripe Integration)
- Improved template system (invoices and estimate)
- Modules and templates marketplace
Credits
InvoiceShelf is made possible thanks to the contributions and support from many people and projects:
- Crater (project inspiration and code base)
- All contributors who have provided code, translations, reported issues, or supported the project in any way.
Translate
Help us translate on https://crowdin.com/project/invoiceshelf
License
InvoiceShelf is released under the GNU AFFERO GENERAL PUBLIC LICENSE Version 3. See LICENSE for details.