Add ENABLE_BROWSERS_LIST & CUSTOM_BROWSERS env variables #163
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#Browsers List - During startup, if a `browsers.list` file already exists in the `/goaccess-config` directory, it is removed and replaced with the original goaccess `browsers.list` file. - If the file doesn't exist, it is copied from the `/goaccess/config` directory to the `/goaccess-config` directory. #Modifying the browsers list - Given the user's definition of the `CUSTOM_BROWSERS` env variable, each browser:browser category combo is appended to the `browsers.list` file (only if the browser isn't already defined in the `browsers.list`).
- If the user sets the env variable `ENABLE_BROWSERS_LIST` to true, their `goaccess.conf` file is modified to include the `browsers-file` which points to the `/goaccess-config/browsers.list` file. - In the event that the user's `goaccess.conf` file already references a `browsers.list` file, the `/goaccess-config/browsers.list` file is ignored in favor of the user's file.
|
I'll look at this today or tomorrow. I briefly looked over, and it looks good. Thanks. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
ENABLE_BROWSERS_LISTandCUSTOM_BROWSERSvariables.start.shscript changesbrowsers.list(located in/goaccess/config/) is copied to the/goaccess-configdirectory. If the user defined theCUSTOM_BROWSERSvariable with a comma delimited list consisting ofBrowser:Browser_categoryitems, these are appended to the/goaccess-config/browsers.listfile.browsers.listis already present in the/goaccess-configdirectory at container runtime and subsequently removing it prior to copying over a fresh copy from the/goaccess/configdirectory, we can ensure that thebrowsers.listalways aligns with the user'sCUSTOM_BROWSERSvariable. Since the/goaccess/config/browsers.listfile is persistent, appending to it would result in custom browsers being left behind within the file when a user removes browser(s) from theCUSTOM_BROWSERSvariable during a container restart - copying over a fresh file prior to appending custom browsers gets around this potential issue.CUSTOM_BROWSERS, if a Browser has already been defined inbrowsers.list, it will be ignored and not appended to the list. Only the browser category (e.g., Crawlers) can be the same for multiple custom browser definitions.custom.sh,ncsa_combined.sh,npm.sh,npm_error.sh,npm_redirection.sh,traefik.shscript changesENABLE_BROWSERS_LISTvariable is set to True, for each log type the correspondinggoaccess.conffile has the linebrowsers-file /goaccess-config/browsers.listappended to it enabling the use of thebrowsers.listfile.CUSTOM_BROWSERSvariable, this will still allow them to use the default goaccess browsers list.Note regarding Custom Log Types: Since a user may already have abrowser.listfile defined in theirgoaccess.conffile, if that is the case, their choice is respected instead of forcing them to use the file located at/goaccess-config/browsers.list. However, if they don't, but did enable the browsers list via the variable, then/goaccess-config/browsers.listis used and their custom browsers (if any defined) are appended to said file.Documentation