-
Notifications
You must be signed in to change notification settings - Fork 12
04 Logarr Settings
Last updated: 03 JAN 2020 by @seanvree
- Clone/download the Logarr repository to your webserver:
git clone https://github.com/Monitorr/logarr/
- NOTE: Docker repo can be found here: https://hub.docker.com/r/monitorr/logarr/
-
Browse to
<localhost\domain>/logarr/index.php
. The required config.php file will be automatically generated from the config.sample-DATE.php file upon first browser hit to index.php at the location:[logarr install path]/assets/config/config.php
. -
Configure log paths and the options detailed below in config.php.
-
Edit permissions for LOG files so the webserver can display log content.
-
Browse to: <localhost\domain>/logarr/index.php
The below options are configurable in the config.php file:
NOTE: The config.php file is located at: [logarr install path]/assets/config/config.php
1. Site Title:
'title' => 'Logarr',
2. Timezone: Timezone used for UI clock.
'timezone' => 'UTC',
- If on Linux, the timezone script will automatically select your timezone, however, you can override this by editing this value. If on Windows, this value is a requirement.
- Timezone format: 'America/Los_Angeles'. Timezones are listed here: https://php.net/manual/en/timezones.php
3. Time Standard: Time format for the UI clock display
'timestandard' => 0,
- Format: 1 = 12-hour format | 0 = 24-hour format
4. Time Refresh interval: (updated): Time display update interval (in milliseconds)
'rftime' => '180000',
- Specifies how frequently (in milliseconds) the UI clock will synchronize time with the hosting webserver.
- Time deviation should be minimal, therefore the suggested value is ~ 180000 ms (3 min).
5. Log Auto-Update interval: Log auto-update interval (in milliseconds) when enabled via the toggle switch in the Logarr UI.
'rflog' => '30000',
- Set this value with the size of your logs as a deciding factor. If set too low (below ~10000ms), your browser will crash.
- During log update, the browser will have NO response.
6. Update Branch: update branch to use when updating via the Logarr GUI
'updateBranch' => 'master',
- Values: "master" or "develop".
7. Max line limit: (new): Default line limit to display for all logs.
'max-lines' => 2000,
- NOTE: This value will drastically affect the loading time, and performance of Logarr. If the Logarr UI loads slow, lower this value and/or ensure your logs are not too large. See "rflog" note above.
- Example: It's imperative to understand that EVERY time Logarr loads and/or performs a log refresh it must download the total size of ALL logs that are enabled into the browser. Note that a log file with 2000 lines of text is approx 300KB in size.
8. Logs: Absolute path to the log file on the webserver's filesystem.
"Sonarr" => 'C:\ProgramData\nzbdrone\logs\sonarr.txt',
"Radarr" => 'C:\ProgramData\Radarr\logs\radarr.txt',
"PHP" => 'C:\php\7.1\logs\php.log',
- Path locations are CASE SENSITIVE in a Windows environment.
- Ensure correct permissions are set on the target log file.
- Ensure the logging applications' settings are set to "roll over/refresh" the log files at regular intervals. Depending on your environment, large log files could cause your webserver to crash.
- If your Logarr index.php page is exposed to the WAN, check the logging applications' settings for sensitive data within logs.
If an application creates multiple versions of log files and you want to always display the latest, then you can use this feature. For example when an application creates the following files:
- C:\logs\log20170201.txt
- C:\logs\log20170202.txt
- C:\logs\log20170203.txt\
-
The
*
represents the dynamic part in the path. -
Set the path to
C:\logs\log*.txt
, and Logarr will automatically detect which log file has been last modified. -
NOTE: PHP must have READ privileges for the parent directory and ALL files within.
If you need help, join us on Discord here: https://discord.gg/YKbRXtt