Image Browser · Burnham-on-Sea History Project

Admin Guide: running the Image Browser

For the people who look after the Image Browser: logging in, changing the admin password, and bringing new photos and spreadsheet changes onto the site. You'll need to be comfortable using a web browser; no technical knowledge is needed beyond that.

1. First time: change the default password

Do this first, before anyone else uses the Image Browser. A new Image Browser comes with a default admin password, which whoever installed it will give you. It's the same on every new installation, so anyone who knows it could log in and run imports: change it the very first time you log in.

  1. Open the Image Browser and click Admin at the top right (next to Help).
  2. Type the default password in the Password box and click Login.
  3. The Admin Panel opens with a red warning across the top:
    Red warning: You're still using the default admin password. Change it under Admin Password before deploying.
  4. In the 🔑 Admin Password box on the right, type:
    • Current password: the default password
    • New password: your new password, at least 8 characters long
    • Confirm new password: the same new password again
  5. Click Change Password. Under the button you'll see "✓ Password changed successfully."
  6. Click ← Back to image browser, then Admin again, and log in with the new password to check it works. The red warning has gone.

Choosing a password: a few unrelated words strung together, such as harbour-kettle-violet-1911, is long, hard to guess and easy to remember. Keep it somewhere safe that the other admins can get to, such as the centre's password book or a password manager. There's only one admin password, shared by everyone who runs the Image Browser.

2. Logging in and out

The Admin Login page: a Password box, a blue Login button, and a link back to the image browser
The login page, reached from Admin at the top right of the main page.

3. The Admin Panel at a glance

The whole Admin Panel: the Import box on the left with the Full Reimport danger zone at its foot, the Admin Password box on the right, and Back and Logout at the bottom
The Admin Panel.
PartWhat it's for
📥 Import (left)Bringing new and changed photos and descriptions onto the site: Import from Spreadsheet. Under the button: where the photos are read from and copied to, and the progress and result of the latest import.
⚠ Full Reimport (red box)Throwing away everything on the site and importing it all again. Rarely needed.
🔑 Admin Password (right)Changing the password.
? Admin guide (top right)Opens this guide in a new tab.
← Back to image browser / LogoutBack to the photos (still logged in), or log out.

4. Changing the admin password

The Admin Password box: Current password, New password, Confirm new password, and a Change Password button

Fill in all three boxes and click Change Password, as in section 1. The new password is used from the next login; you stay logged in now. If it isn't accepted, the message under the button says why:

MessageWhat to do
Current password is incorrect.Re-type the password you logged in with.
New passwords do not match.Type the new password again, the same in both boxes.
New password must be at least 8 characters (and at most 72 bytes).Use a longer one (or, very rarely, a shorter one: about 70 ordinary letters is the most).

The box under New password says At least 8 characters., and a password that's too short is stopped by the browser itself before it's sent: it asks you to make it longer.

Forgotten the password? It can't be recovered or shown, only reset, and that needs whoever installed the Image Browser: they delete the admin_password_hash row of the app_configs table in its database and restart it, which puts back the default password. Then change it again straight away.

5. Importing: putting changes on the site

The photos on the site come from two places, both kept up to date by the image maintenance team:

Changes to either don't show on the site by themselves. An import reads the spreadsheet and the photo folders and brings the site up to date. Run one whenever the team tells you they've added photos or changed the spreadsheet.

The Import box: an explanation, the blue Import from Spreadsheet button, the Collection Images folders, the Output path, and the red Full Reimport box
  1. Ask the team to save and close the spreadsheet first, so the import reads their latest changes.
  2. Click ↺ Import from Spreadsheet.
  3. Watch the progress bar (next section), then read the summary when it finishes (section 8).
  4. Visit the main page and check the new photos are there. The counts in the collection and category lists are updated by the import.

An import is safe to run as often as you like. It only copies photos that are new or have changed and updates descriptions; it never removes photos from the site, and visitors can keep using the site while it runs. The first import of a new installation copies every photo and can take a long time; after that, imports usually take a minute or two.

Where the photos are read from

Collection Images: one line per collection with its folder; then the Output path

Under the button, Collection Images lists every collection the import reads, each with the folder its photos are read from, and Output path is where the Image Browser keeps its own copies of them. These folders are set when the Image Browser is installed; you don't need to change anything. They're useful to:

The photos are only read from these folders, never changed. The Image Browser shows visitors its own copies, so the site keeps working even if the NAS is switched off (until the next import).

6. While an import runs

The progress area: 'Starting...', a progress bar at 0%, and a grey Cancel Import button

The Import box shows:

You don't have to watch it. Closing the page, going back to the image browser or even logging out doesn't stop an import. Come back to the Admin Panel later and you'll see its progress, or how it ended.

Only one import can run at a time. Clicking Import again while one is running just says "An import is already in progress." and shows its progress.

7. Cancelling an import

Click ✖ Cancel Import if you started an import by mistake or need the computer for something else. The Image Browser asks you to confirm:

An amber box: Cancel the import? It explains that the import stops after the current file, nothing is lost, and the next import carries on. Buttons: Keep importing, Yes, cancel the import

Nothing is lost: everything already copied stays on the site. The panel then shows an amber box headed ✖ Import cancelled, saying how far it got, for example "Import cancelled after copying 3 of 40 file(s).", and when it stopped. It stays there, even after leaving and coming back to the panel, until the next import starts (or the Image Browser is restarted). Run Import from Spreadsheet later and it carries on from where it stopped.

8. Reading the import summary

When the import finishes, the box shows a summary. The first line says how it went:

The next line, Import method, says whether it was an Import or a Full reimport. Then come the counts:

The summary's counts under two headings, Whole spreadsheet and Importable images, then a Download the full import report link and 'Finished at 08:43'
The counts part of a summary (the first two lines aren't shown here).
LineWhat it meansWorry?
Whole spreadsheet (every category sheet)
Total populated rowsRows with anything in them.No
Total rows without an imageRows for items with no photo file (the archive's other records, such as postcards not yet scanned).No
Total empty rowsBlank rows between filled ones.No
Importable images
Total image rowsRows naming a photo file: the photos on the site.No
Total rows with missing image fileRows naming a photo whose file isn't where the row says. Usually a typing mistake in the folder or file name, or a photo not yet copied to the NAS.Yes: pass the report to the image maintenance team
Total image files with no rowPhoto files in a collection's folder that no row names: scanned, but not yet added to the spreadsheet (or named differently there). Only if they should be on the site
Total image files importedPhotos new to the site this time.No
Total files updatedPhotos copied again because the file or its description changed.No
Total files ignoredPhotos unchanged since the last import (and any files that aren't JPEGs).No
Total errorsThings that went wrong, for example a photo that couldn't be copied. The first 20 are listed.Yes, if more than 0
Total import timeHow long it took.No

Under the summary, Finished at 14:32 says when it ended.

9. The full import report

The summary only gives counts. Click ⬇ Download the full import report under it to save a text file (import-report-date-time.txt) with the same counts followed by every item behind them:

Open it with Notepad (or any text editor), or email it to the image maintenance team so they can put things right. Only the latest import's report is kept, and only until the Image Browser is restarted.

10. Full Reimport: starting again from nothing

The red Full Reimport box with its explanation and a red Full Reimport button

A Full Reimport deletes every photo record and every copied photo from the site, then imports everything again as if for the first time. Because of that, it asks you to confirm with a red warning:

A red box: Full Reimport: delete everything and start again? It lists what will be deleted and warns visitors see no images until copying finishes. Buttons: Keep everything, cancel; Yes, delete everything and reimport

While it runs, visitors see no photos at all, and it takes as long as a first import: possibly hours for the whole archive. Every photo also gets a new number, so any web links people have saved to a particular photo stop working. Run it when the centre is closed.

If you cancel a Full Reimport part-way, the photos not yet copied stay missing: run Import from Spreadsheet afterwards to finish.

11. Import or Full Reimport?

An ordinary import adds and updates, but never removes. So almost always you want Import from Spreadsheet. You need a Full Reimport only when something has to disappear from the site:

The team has…Run
added new photos and their rowsImport
changed descriptions or datesImport
replaced a photo's file with a better scan (same name)Import
moved a row to a different category sheetFull Reimport (otherwise the photo shows in both categories)
deleted a row, or renamed a photo's file or folderFull Reimport (otherwise the old one stays on the site)
nothing, but the site seems out of step with the spreadsheetFull Reimport

Saving the waiting time: whoever installed the Image Browser can back up an import (the database and the copied photos) and restore it later, which is much quicker than a Full Reimport if something goes wrong. Ask them about the backup and restore scripts.

12. When something goes wrong

If an import can't finish, the box shows a red message starting "Import failed while: …" with the step it was on and why. Nothing done before then is lost; fix the cause and import again, and it carries on.

What you seeLikely cause and what to do
Failed while Scanning input files…, saying a folder doesn't exist or can't be readThe NAS is switched off, asleep or not connected. Check it's on, wait a minute and try again.
Failed while Reading the spreadsheet… or Reading … records…The spreadsheet is damaged, or wasn't saved as an .xlsx file. Ask the team to open it, save it as Excel Workbook (.xlsx) and close it.
Lots of rows with missing image fileDownload the report: if they're all in one folder, that folder is probably named differently from the spreadsheet's Folder/Page No.
A collection missing from Collection ImagesIts folder isn't where the Image Browser expects. Ask whoever installed it.
New photos imported but not on the main pageReload the main page (F5), and check the collection and category lists are set to All.
The Image Browser doesn't open at allAsk whoever installed it. One cause: a category sheet was renamed or deleted in the spreadsheet; the Image Browser won't start without every category sheet it's set up for.

If the panel shows 🧪 Dry run mode, it has been started for testing: imports only report what they would do, and change nothing. Ask whoever installed it to restart it normally.

13. The library's kiosk PC

The kiosk PC shows only the Image Browser, full screen, with no address bar, tabs or Back button. It signs itself into its kiosk account when it starts. You look after it from your own admin account on the same PC.

To…Do this
Get from the kiosk to your admin accountPress Ctrl + Alt + Del, choose Sign out, then pick your account at the bottom left of the sign-in screen. If it goes straight back into the kiosk, hold Shift while it signs out.
Get back to the kioskRestart the PC (or sign out and choose the kiosk account).
Run an import on the kiosk PCOn the kiosk itself, click Admin, log in, and import as usual. Click Log out when you've finished, so no visitor can use the panel. If the kiosk restarts after a few minutes without anyone touching it, you are logged out, but an import that's running carries on: log in again to see how it's getting on.
Get back to the photos after opening the Help guidePress the blue ← Back to the photos button at the top of the guide. The guide opens in a window of its own; the button closes it, and the photos are underneath, as they were. With a keyboard, Ctrl + Shift + W does the same (Ctrl + W doesn't work in the kiosk).
Get back to the photos from the login pageClick the site's name at the top left, or press Alt + ← (Back).
Any of these, with no keyboardWait: after a few minutes with nobody using it (5, as set up), the kiosk starts again at the photos.