sm00thpay/gopayroll-viewer

This repository provides users with an offline gopayroll database viewer for their gopayroll database files (see [**] for more information about goPayroll online*)

Your most recent payroll database archive (as a zip file) can be downloaded anytime from your goPayroll online account. Unzip the file and move your db file to an appropriate folder which can be attached to the offline viewer as a data volume (it should only contain db files and they will be automatically moved into the correct folder structure when attached).

For example, if you have a folder called "payrolldb" which we'll refer to a "YourPayrolldbFolder":

• on Windows it might be a folder called C:\payrolldb
• on a Mac it might be ~/Documents/payrolldb
• you place your database "gopayroll_1234.db" extracted from your downloaded archive into that folder (the "1234" part is generally your serial number), then
• start the gopayroll-viewer container with -v YourPayrolldbFolder:/app/data in the command-line (see example below - that points YourPayrolldbFolder to the viewer's internal data folder), then
• the viewer will automatically move that file to YourPayrolldbFolder/gopayroll/1234/gopayroll_1234.db and create the additional support folders required for files, backups etc.
• the first database will be loaded automatically when you visit localhost:port, and any additional databases can be selected from the "blocks" menu
• NOTE: port is generally 81, 8080, 8081 etc. - use whatever is available (any port not being used by other applications - we use port 81 in the examples).

To install gopayroll viewer

1. https://www.docker.com/products/docker-desktop

2. Issue the command docker pull sm00thpay/gopayroll-viewer:latest

Check it works with the demo database

3. docker run --name payroll -d --rm=true -p=81:8080 sm00thpay/gopayroll-viewer

• NOTE: use a port that is not used by any other application - port 81 is just an example

4. in your Chrome browser enter the URL localhost:81

• This should display the dashboard for the demo New Zealand payroll

5. when done, issue docker stop payroll

• if that port is unavailable you'll probably need to issue docker rm payroll to kill the running container process, then try again from Step 3 above

Use your own gopayroll db files

6. extract your most recent gopayroll db file/s into a dedicated folder (e.g. the payrolldb folder discussed above)

7. docker run --name payroll -d --rm=true -p=81:8080 -v YourPayrolldbFolder:/app/data sm00thpay/gopayroll-viewer (replace port 81 if necessary with another available port, and replace YourPayrolldbFolder with the path to your payrolldb folder).

Examples:

• Windows (using example folder - note the slash character is "/"): docker run --name payroll -d --rm=true -p=81:8080 -v c:/payrolldb:/app/data sm00thpay/gopayroll-viewer
• MacOS (using example folder): docker run --name payroll -d --rm=true -p=81:8080 -v ~/Documents/payrolldb:/app/data sm00thpay/gopayroll-viewer

8. In your Chrome browser enter the URL localhost:81

9. If you have more than one database available you can select which one you want to view using the "blocks" menu (top left)

The offline viewer is unsupported, however feedback is welcome. It does NOT let you process payroll.