Upgrade



How to Upgrade FusionInvoice 2018

This section is for upgrading from FusionInvoice 2018-x to FusionInvoice 2018-x. If you are upgrading from 2017 or 2016, see here. If you are upgrading from v2, see here.

Step 1: Download the latest package

Log into your account at FusionInvoice.com and download the latest package. Save it locally to your computer.

Step 2: Unzip the package

Navigate to the downloaded install package and unzip the contents.

Step 3: Upload the files

Upload the following folders to the FusionInvoice folder on your server and let them merge/overwrite the existing folders:

  • app
  • assets
  • database
  • resources

It is recommended that you use a standard FTP program such as FileZilla to upload the files to your server.

Step 4: Complete the database upgrade

Visit http://YourFusionInvoiceURL/setup in your web browser. If your http://YourFusionInvoiceURL/setup produces an error, try using http://YourFusionInvoiceURL/index.php/setup instead. This step will upgrade your database. Once this step is completed, you should be able to log back into your upgraded FusionInvoice system.


How to Upgrade to FusionInvoice 2018 from FusionInvoice 2017 or 2016

Step 1: Download the latest package

Log into your account at FusionInvoice.com and download the latest package. Save it locally to your computer.

Step 2: Unzip the package

Navigate to the downloaded install package and unzip the contents.

Step 3: Delete these folders and files

Delete these folders and files from the FusionInvoice installation on your server:

  • Folders
    • app
    • assets
    • bootstrap
    • config
    • database
    • resources
    • vendor
  • Files
    • artisan
    • composer.json
    • composer.lock
    • index.php
    • package.json

Step 4: Config files

Open config/app.php from the unzipped installer package and replace the ReplaceThisWithYourOwnLicenseKey value with your license key listed in your FusionInvoice.com account panel and save the modified file. Be sure there are no leading or trailing spaces.

Open config/database.php from the unzipped installer package, edit accordingly for your database settings and save the modified file.

Step 5: Upload the folders and files

Upload the following folders and files from the installer package to the FusionInvoice folder on your server:

  • Folders
    • app
    • bootstrap
    • assets
    • config
    • database
    • resources
    • vendor
  • Files
    • index.php

It is recommended that you use a standard FTP program such as FileZilla to upload the files to your server.

Step 6: Complete the database upgrade

Visit http://YourFusionInvoiceURL/setup in your web browser. If your http://YourFusionInvoiceURL/setup produces an error, try using http://YourFusionInvoiceURL/index.php/setup instead. This step will upgrade your database. Once this step is completed, you should be able to log back into your upgraded FusionInvoice system.

Step 7: If upgrading from FusionInvoice 2016

If you are upgrading from FusionInvoice 2017, then you are all done! Happy Invoicing!

If you are upgrading from FusionInvoice 2016 and are using custom quote and/or invoice templates, there are some changes you'll need to make. If any of these exist in your custom template(s), they should be changed as follows:

For custom invoice templates:

Change this: To this:
$invoice->user->company $invoice->companyProfile->company
$invoice->user->formatted_address $invoice->companyProfile->formatted_address
$invoice->user->phone $invoice->companyProfile->phone
$invoice->user->fax $invoice->companyProfile->fax
$invoice->user->mobile $invoice->companyProfile->mobile
$invoice->user->web $invoice->companyProfile->web
$invoice->user->address $invoice->companyProfile->address
$invoice->user->city $invoice->companyProfile->city
$invoice->user->state $invoice->companyProfile->state
$invoice->user->zip $invoice->companyProfile->zip
$invoice->user->country $invoice->companyProfile->country
Logo::size(width, height) $invoice->companyProfile->logo(width, height)

For custom quote templates:

Change this: To this:
$quote->user->company $quote->companyProfile->company
$quote->user->formatted_address $quote->companyProfile->formatted_address
$quote->user->phone $quote->companyProfile->phone
$quote->user->fax $quote->companyProfile->fax
$quote->user->mobile $quote->companyProfile->mobile
$quote->user->web $quote->companyProfile->web
$quote->user->address $quote->companyProfile->address
$quote->user->city $quote->companyProfile->city
$quote->user->state $quote->companyProfile->state
$quote->user->zip $quote->companyProfile->zip
$quote->user->country $quote->companyProfile->country
Logo::size(width, height) $quote->companyProfile->logo(width, height)

How to Upgrade to FusionInvoice 2018 from FusionInvoice v2

Step 1: Things to back up

Save copies of the following configuration files from your server to your local computer:

  • app/config/database.php
  • app/config/payments.php

If you created or purchased custom templates, save copies of those files to your local computer from the following locations on your server:

  • app/FI/Modules/Templates/Views/templates/invoices
  • app/FI/Modules/Templates/Views/templates/quotes

Create a backup of your MySQL database from phpMyAdmin (or whatever tool you use to manage your databases).

Step 2: Delete all existing FusionInvoice files and folders from your server

Delete the entire folder from your server which contains the FusionInvoice folders and files. Recreate the empty folder once it has been deleted.

Step 3: Download the latest package

Log into your account at FusionInvoice.com and download the latest package. Save it locally to your computer.

Step 4: Unzip the package

Navigate to the downloaded install package and unzip the contents.

Step 5: Database configuration

Open config/database.php from the unzipped installer package. Edit the file and point it to your existing FusionInvoice database and save the modified file. Use your backed up database.php file for reference purposes.

Typically you should only have to configure the host, database, username and password values to connect to your database. Compatibility with MySQL and MariaDB is 100% guaranteed. Other database types may or may not work as expected and are not supported.

'mysql' => [
    'host'      => 'localhost',
    'database'  => 'fusioninvoice',
    'username'  => 'root',
    'password'  => 'password',
    'prefix'    => '',

    'driver'    => 'mysql',
    'charset'   => 'utf8',
    'collation' => 'utf8_unicode_ci',
    'strict'    => false,
],

Step 6: License key configuration

Open config/app.php from the unzipped installer package and replace the ReplaceThisWithYourOwnLicenseKey value with your license key listed in your FusionInvoice.com account panel and save the modified file. Be sure there are no leading or trailing spaces in this value when you save the file.

'key' => 'ReplaceThisWithYourOwnLicenseKey',

Step 7: Upload the files to your server

Upload the unzipped files from your computer to the empty folder on your server you recreated earlier. It is recommended that you use a standard FTP program such as FileZilla to upload the files to your server. This initial upload may take a few minutes to complete.

Step 8: Set folder permissions

Apply recursive write permissions to the following folders (including all the folders and files contained within):

  • storage
  • bootstrap/cache

The exact steps to set the appropriate permissions will depend on your web host and server configuration. FusionInvoice cannot advise on the exact steps or permissions to apply to make these folders writable. If you have questions about this step, please contact your web host or system administrator.

Step 9: Complete the upgrade

Visit http://YourFusionInvoiceURL/setup in your web browser. If http://YourFusionInvoiceURL/setup produces an error, try using http://YourFusionInvoiceURL/index.php/setup instead. This step will upgrade your v2 database. Once this step is completed, you should be able to log into your upgraded FusionInvoice system.

Step 10: System Settings

Once logged into FusionInvoice, go to System -> System Settings and update the following settings:

  1. If you had a logo uploaded in v2, re-upload your logo on the General tab.
  2. If you had SMTP email configured in v2 using a password, re-enter your email password on the Email tab.
  3. If you had online payments configured in v2, review the Online Payments tab and adjust accordingly. Use your backed up payments.php file for reference purposes.
  4. Press the Save button to save the updated settings.

Step 11: Custom template updates

This portion of the documentation only applies if you have created or purchased customized templates for FusionInvoice v2 and would like to use those same templates in FusionInvoice 2018. Below are the steps to follow, which should be easily achieved by using find and replace in your text / code editor.

For custom invoice templates:

Change this: To this:
{{{ {{
}}} }}
{{ $logo }} {!! $invoice->companyProfile->logo() !!}
{{ $invoice->user->formatted_address }} {!! $invoice->user->formatted_address !!}
{{ $invoice->client->formatted_address }} {!! $invoice->client->formatted_address !!}
{{ $invoice->formatted_terms }} {!! $invoice->formatted_terms !!}
{{ $invoice->formatted_footer }} {!! $invoice->formatted_footer !!}
{{ $item->name }} {!! $item->name !!}
{{ $item->formatted_description }} {!! $item->formatted_description !!}
$invoice->amount->formatted_item_subtotal $invoice->amount->formatted_subtotal

For custom quote templates:

Change this: To this:
{{{ {{
}}} }}
{{ $logo }} {!! $quote->companyProfile->logo() !!}
{{ $quote->user->formatted_address }} {!! $quote->user->formatted_address !!}
{{ $quote->client->formatted_address }} {!! $quote->client->formatted_address !!}
{{ $quote->formatted_terms }} {!! $quote->formatted_terms !!}
{{ $quote->formatted_footer }} {!! $quote->formatted_footer !!}
{{ $item->name }} {!! $item->name !!}
{{ $item->formatted_description }} {!! $item->formatted_description !!}
$quote->amount->formatted_item_subtotal $quote->amount->formatted_subtotal

Save your changes and upload the file to custom/templates/invoice_templates if it's an invoice template or to custom/templates/quote_templates if it's a quote template.

This should result in a fully upgraded system! From here on, your upgrades will be much simpler :)


How to Upgrade an Add-on

Step 1: Download the add-on package

Log into your account at FusionInvoice.com and download the add-on package to upgrade. Save it locally to your computer.

Step 2: Unzip the add-on package

Navigate to the downloaded Add-on package and unzip the contents.

Step 3: Upload the add-on folder to your server

Upload the unzipped add-on folder from your computer to the custom/addons folder on your server and let it merge/overwrite the existing folder. It is recommended that you use a standard FTP program such as FileZilla to upload the folder to your server.

Step 4: Upgrade the add-on

Log into your FusionInvoice install and go to System -> Add-ons and press the Upgrade button for the add-on if it appears. If the Upgrade button doesn't appear, then no further action is required and the add-on should be upgraded and ready to use.