OpenLog/README.md

OpenLog

OpenLog is an online logbook application. It allows anyone with a web browser to read, enter, and search for notes on any subject.

The available shifts, employees, and subjects are easily configured. Notes can be referred to other notes and the entire chain of referenced notes can be displayed in a single page. This makes it convenient to track ongoing projects or actions on a particular piece of equipment over a long period of time.

Version 5.0 adds parts tracking functionality. Notes can have parts change information associated with them and maintenance/repair forms can be generated for parts. Parts related functions can be disabled to reduce clutter if they are not needed.

Version 5.1 adds scheduled maintenance functionality, which can also be disabled if not needed. Notes, parts, and maintenance forms can be searched for based on a number of criteria.

The look and feel of the OpenLog pages are easily changed. Settings that affect all users can be changed in the Administration menu. Each user can personalize his or her own settings in the My Profile menu.

No browser specific HTML is used in OpenLog, so it should be useable in any browser, and it has been tested using Google Chrome, Mozilla Firefox, Microsoft Internet Explorer, and Edge.

Prerequisites

• Linux - The installer is written to automate installation on Debian based Linux servers, but OpenLog itself should run on any current Linux distribution, albeit installation will need to be accomplished manually.
• Apache2 - Current development is using version 2.4.65
• MySQL or MariaDB - Current development is using MariaDB version 11.8.3
• php - Current development is using version 8.4.11

Installation

Note

These instructions are used to either install a new instance of OpenLog or upgrade an existing one.

1. Unzip the OpenLog-x.x.x.tar.gz file you've downloaded into a convenient place.
2. cd OpenLog-x.x.x
3. sudo ./install.sh

• The installer will check for installation of the required packages and prompt for their installation if not found.
• You'll then be prompted for the webserver's install location. The default should work for standard installations.
• You'll then be prompted for the installation location of this instance of OpenLog. You should come up with a unique name.
• If this directory already exists and contains an instance of OpenLog, you will be prompted to cancel the process or upgrade this instance.
  • If you choose to upgrade, your OpenLog instance will be upgraded and you're done.
• If this directory does not exist, it will be created and a new instance will be installed. You can have multiple instances of OpenLog running under different names in different directories. For example, if you wanted to create an Operations Log, you could enter opslog.
  • In the Operations Log example referred to above, you could enter OpsLog or Operations Log.
  • You'll br prompted for the name of the database to be created. You should choose something appropriate, like opslog for the example given.
  • Next, you'll be prompted to enable the apache2 configuration for this instance. *The new instance will now be installed and accessible. You will be given some important information.

  Important

  The default login credentials for the initial admin user are: login: OpenLogAdmin password: OpenLog-1 Make note of these credentials, otherwise you will not be able to login and configure your new installation.

  It is highly recommended that you change the OpenLogAdmin user password and/or create your own admin user (with a secure password) and disable this default account after logging in for the first time.

History

OpenLog was written to replace a creaky old inefficient error prone Access database which had in turn replaced stacks of paper logbooks. Now, with some improvements and over 15 years and 44000 notes later in a production environment, it's still going strong.