Troubleshooting Guide

Every once in a while you may run into an issue with the application which may prove hard to debug. These issues may include:

1. Startup Issues
   • Application does not show up even after a while
   • Application gets stuck during the splash screen
2. Application Crashes
   • Application disappears without displaying a dialogue
   • Application displays an error dialogue without sufficient information
3. Application Freezes

Troubleshooting Steps

1. Locate the application log directory:
   • Windows: %APPDATA%/Beacon/log
   • Linux, Mac OS and other UNIX compatible systems: ~/.beacon/log (e.g. /home/<user>/.beacon/log)
2. Open latest.log and check for obvious problems
3. If nothing stands out, open an issue and attach latest.log to your ticket (Important: Do not change or edit the log; Do not paste it directly into the ticket)

Important: Sometimes you may be asked to upload prior log files. These files may be located within the same directory as latest.log and are written in order of their respective numbering (e.g. beacon.log.1 contains the log of a later application startup than beacon.log.2). Up to 10 application starts are retained by the application by default.

Troubleshooting Steps (pre 2.1.0)

In these cases you may retrieve the application log by invoking the application via the command line:

1. Download a jar version of the application if you haven't done so already (e.g. Windows users)
2. Start the application on a command line (preferably running bash) via java -jar Beacon.jar
3. Check the logs for any obvious problems
4. If nothing stands out or the issue is not related to your system's configuration, submit it as a bug report (please make sure to attach the log as a text file rather than pasting it in your issue)