Skip to content

vsimakhin/web-logbook

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Web-logbook

This is a simple free EASA-style logbook application written in golang.

You can clone the repo and compile the binaries yourself, or just download the latest ones for your operating system from the releases.

Once you start the app it automatically creates an SQLite local DB and starts listening on port 4000 by default. So you can open it in your standard web browser at http://localhost:4000

You also can easily export all flight records into EASA style pdf format, print it, sign and use it as a usual paper logbook.

Changelog

[2.34.0] - 03.04.2024

  • New: Add support for MySQL database. Check readme for more details.
  • Update: Refactored PDF export package. No UI changes.
  • New: Add support for a custom title page for PDF A4/A5 exports.
  • Update: Update openlayers lib from 7.3.0 to 9.0.0. No UI changes.
  • Update: Update golang from 1.20.3 to 1.21.8. No UI changes.
  • Fix: Finally fixed the unit tests. No UI changes.

[2.33.0] - 08.03.2024

  • New: License Number and Address fields on the Settings page. They are printed (if not empty) on the title page for PDF exported logbook.
  • Fix: Try to fix a Map page layout for Mac OS

[2.32.1] - 06.03.2024

  • Fix: Add additional checks for time field autoformat, so app will not crash

[2.32.0] - 25.02.2024

  • New: Add autoformat for time fields. You can choose from three options: None, HH:MM (will add leading 0) and H:MM (will remove leading 0). Please note that this feature only affects how the time is displayed in the UI and does not modify the data in the database table. You can find this option in the Settings, Export PDF A4, and Export PDF A5 pages.

The full changelog is here

Usage

  1. Download the latest release from https://github.com/vsimakhin/web-logbook/releases
  2. Extract the archive to some folder/directory
  3. Run:
  • Windows:
    • Double-click on the web-logbook.exe file. It will show you some warning about how unsafe it can be (need to solve it later), but just run it.
  • Linux:
    • Open a terminal and navigate to the directory
    • Run ./web-logbook
  • MacOS:
    • I still didn't test it for MacOS, so in theory, should be as same as for Linux, but... who knows ¯\(ツ)
  1. Open your browser, type http://localhost:4000 and the application is ready to use
  • (first run) Go to the Settings page, Airports tab and click on the Update Airport DB button
  1. To close the application, use Ctrl+C in the terminal window or just close it

CLI options

$ ./web-logbook -h
  -cert string
      certificate path (default "certs/localhost.pem")
  -disable-authentication
      Disable authentication (in case you forgot login credentials)
  -dsn string
      Data source name {sqlite: file path|mysql: user:password@protocol(address)/dbname?param=value} (default "web-logbook.sql")
  -enable-https
      Enable TLS/HTTPS
  -engine string
      Database engine {sqlite|mysql} (default "sqlite")
  -env string
      Environment {dev|prod} (default "prod")
  -key string
      private key path (default "certs/localhost-key.pem")
  -port int
      Server port (default 4000)
  -url string
      Server URL (default empty - the app will listen on all network interfaces)
  -version
      Prints current version

Supported operating systems

Since it's written in golang it can run on any system if you compile the sources. For now, on the Release page, there are 3 binaries for Linux, MacOS and Windows, all of them are amd64.

There is an application Web Logbook Mobile Ionic for Android (and later I hope will be for IOS), which can sync with the main application.

Interface

Currently, there are implemented several modules in the logbook app:

  • Logbook itself
    • Flight records
    • Attachments for the flight records
    • Automatic night-time calculation
    • Map drawing and distance calculation for the flight record
  • Settings
    • Signature and owner name
    • Signature pad to automatically include signatures to the PDF exports
    • Enable/Disable authentication (in case you need to expose the app to the public internet)
    • Aircraft groups/classes
    • List global airport database
    • Your own custom airfields or heliports
    • Some interface settings
  • Export
    • Export to EASA PDF format (A4 and A5)
    • Additional export formats (XLSX, CSV)
    • Adjustable settings for each export format
  • Import
    • CSV support
    • Automatic WebLogbook profile load
  • Map
    • Filters for routes and airports
    • Filters for the aircraft
  • Licensing & Certification
    • Document attachments and preview
    • Expiration time tracking
  • Statistics
    • Totals
    • By Year
    • By Aircraft
    • By Aircraft group/class, defined in settings

Logbook

Main logbook page

Export

Export

A4

Export to PDF

A5

Export to PDF Export to PDF

So in real life the logbook could look like Pilot logbook

Flight record

Flight record

Attachments

Flight record attachments

Settings

Settings

Settings-Airports

Stats

Flight stats

Map

Licensing & Certifications

Licensing

Licensing record

Airports Databases

The app supports 3 sources:

If you enable the No ICAO codes filter option, the app will ignore ICAO airport codes that contain numbers and dashes, which are not commonly used ICAO codes. By default, this option is unchecked, which makes the database slightly smaller and cleaner.

Please make sure to click the Save button before updating the database to ensure that all changes are saved.

Advanced configuration

HTTPS enable

Since the app is running on localhost it's not possible to create a public certificate that would be valid by public CAs. As an option, you can create a self-signed certificate and add it to the root CA in your operating system. For that, you can use mkcert tool.

  • Open a terminal/console and navigate to the web-logbook directory
  • Create a directory certs
  • In this new directory run commands:
    • mkcert -instal - it will create a new local CA
    • mkcert localhost - it will generate a key(localhost-key.pem) and a certificate(localhost.pem)
  • Now just run the Web Logbook App with the new parameter: web-logbook --enable-https

You don't need to install a new local CA in you system, but in this case, browser will always show you a warning message, that certificate is self-signed and not trusted.

Also, you can always generate your own certificate and key and store it in the different directories in your operating system. For that use --key and --cert parameters to specify the exact location.

MySQL database

To store all data, you can use MySQL database. To get started, create a database and a user with access to it. On the first run, the application will create all necessary tables and views. If you want to migrate your data from SQLite to MySQL, you can use the export to CSV function first and then import from CSV.

The DSN format for MySQL connections

user:password@protocol(address)/dbname?param=value

For example,

./web-logbook -engine mysql -dsn "web-logbook-user:pwd@tcp(192.168.0.222)/web-logbook

New features/Issues

In case you'd like to add some other features to the logbook or you found a bug, please open an "issue" here https://github.com/vsimakhin/web-logbook/issues with a description. I cannot promise I'll implement it or fix it at a reasonable time but at least I can take a look.

Contributors

Used libraries