Upgrading LedgerSMB 1.5.x to 1.5.y

Submitted by ehu on Tue, 02/28/2017 - 08:38

Please note that these instructions assume you have installed LedgerSMB from tarball.

There are two steps to upgrading a LedgerSMB 1.5.x installation to 1.5.y (x smaller than y):

  1. Upgrade the software
  2. Upgrade the company database

The last step has to be executed for each company database that's set up.

Note that all the steps below are prefixed with the 'sudo' command, but these can be executed as 'root' directly as well.

 

Upgrading the software

This is by far the easiest part. These are the steps to go through, assuming an installation from tarball:

  • Stop the LedgerSMB application server (e.g. Starman)
    $ sudo service starman-ledgersmb stop
  • Back up the old software by moving it out of the way (assuming you installed in /usr/local/ledgersmb):
    $ sudo mv /usr/local/ledgersmb /usr/local/ledgersmb.backup
  • Untar the tarball into /usr/local/ledgersmb:
    $ sudo tar xf ledgersmb-1.5.x.tar.gz --directory /usr/local
  • Copy the configuration file from the old installation:
    $ sudo cp /usr/local/ledgersmb.backup/ledgersmb.conf /usr/local/ledgersmb/
  • Start the LedgerSMB application server again (Starman example given, as before):
    $ sudo service starman-ledgersmb start

Upgrading the company database

After the software has been upgraded, the company database(s) have to be upgraded. When a user logs in on a database which is of a version different from the software that's used to access the database, a "Database version mismatch" error will be generated.

To upgrade the company database from the Web UI, navigate to the setup.pl page (e.g. when you're hosting your LedgerSMB on https://localhost/ and normally log in through https://localhost/login.pl, now you need to navigate to https://localhost/setup.pl). Log into setup.pl with the database admin credentials (the "lsmb_dbadmin" user, if you followed the installation instructions).

After login, setup.pl will show a sccreen with the following at the top:

 

Logged in as lsmb_dbadmin
LedgerSMB 1.5 db found
Rebuild/Upgrade?

By clicking the "Yes" button, the company database upgrade process will be executed.

Repeat this process for all company databases.

Upgrading Dojo (installs from Git only)

When tracking the GitHub Git repository, not much more is required for an upgrade than to pull all changes from the server and restart Starman. However, on some releases, Dojo Toolkit will be upgraded. (One such release is the 1.5.13 release.) In order to update the installed Dojo version, run these commands:

$ git submodule foreach git remote update -p
$ git submodule update

With the source Dojo now up to date, the Dojo built JavaScript assets need to be regenerated:

$ make dojo

After these have been completed, make sure all browser sessions are being freshly restarted.

Release
FAQ Category