Client Settings - AttiliaTheHun/Songbook-Manager GitHub Wiki
Settings
There are many variable values that affect the behavior of the program. You have the ability to change many of these by modifying the settings.json
file or inside the Settings Editor window, that you can open from the Main window using the Ctrl + Alt + S keyboard shortcut.
The settings in the General tab are the ones you mostly want to change. In the Environment tab, there are settings that define the program's environment and their modification might cause it to crash or behave unexpectedly. The Version Control System tab allows you to manage the VCS
Songbook language
is injected into the HTML pages and is supposed to fix issues with special characters among some languages. You may need to google a bit to find out the language code for your language.
Bind song titles
means that when a song title changes either in the Collection Editor or in the HTML source, the change will be reflected to the other place. In other words the titles in the collection and the source file will be in sync.
Enable frontpage
adds a special page at the beginning of the songbook. This page is generated from the frontpage.html
layout.
Enable dynamic songlist
adds a page (or pages) with an index of all the songs in the collection sorted alphabetically.
Songs per column
specifies how many songs should be in one column of the dynamically generated songlist.
Load data on startup
specifies whether the program should perform the load operation when it first opens up. The nature of the operation depends on the saving mode (remote or local).
Use default encryption password
will use a default encryption password to encrypt the authentication tokens that are stored in the .auth
file. This option reduces the security, but given the nature and value of mentioned tokens, it seems to be acceptable. Has no effect if the VCS is disabled.
Auth file path
specifies the path to the .auth
file that contains the encrypted authentication tokens.
Export enabled
specifies whether the components necessary for exporting the songbook should be loaded. Disable this to mitigate export related errors.
Browser executable path
specifies a path to a headless browser executable. This is crucial for exporting.
Keep browser instance alive
specifies whether the program should create an instance of the headless browser every time an export task (export or preview) is received or whether it should keep an instance ready all the time. Checking this will speed up any export related task. If the program starts crashing, disable this option.
The default file names just specify how will the exported files be named.