galileorc(5)

galileorc ๐Ÿ’– (section 5, File Formats Manual)

okay bestie, so this is the manual for galileorc โ€” the config files for the galileo Fitbit synchronization utility. yep, the whole thing. it's giving "settings but make it a vibe" โœจ

NAME

galileorc โ€” configuration files for the galileo Fitbit synchronization utility ๐ŸŽ€


DESCRIPTION

so the galileorc file is literally just there to hand galileo(1) some default settings, so you don't have to keep typing the same stuff over and over like a broken record ๐Ÿ˜ญ any setting you'd normally pass as a command-line argument to galileo can live in this config file instead. no cap, it saves your wrists.

but here's the tea: settings you put in the config files can be overridden by run-time command-line switches. see galileo(1). ๐Ÿ‘‘


FILES

these files get read if they exist. later ones override previous settings, and settings given on the command line override anything defined in configuration files. hierarchy? slay. ๐Ÿ’…

  • /etc/galileo/config
  • $XDG_CONFIG_HOME/galileo/config (the XDG_CONFIG_HOME environment variable defaults to ~/.config if it's not defined, just fyi)
  • ~/.galileorc
  • any file specified with the -c command-line switch

SYNTAX

the settings file is defined in YAML format, bestie. blank lines and comments (from the first hash character # all the way to the end of the line) are ignored โ€” so go off, annotate your heart out ๐Ÿฆ‹

the config file is parsed as a dictionary of settings, which means every setting is defined using a keyword followed by a colon character. for single-value settings (the majority of them), the value just follows the colon, like:

do-upload: true

and for settings of type list (such as the tracker ID inclusion and exclusion lists), the values show up with an indentation on subsequent lines and prefixed with a dash, like:

include:
  - '123456789ABC'
  - '9876543210AB'
notice the quotes on those IDs? that's not decoration, that's survival. more on that in BUGS ๐Ÿ‘€

SETTINGS โœจ

the following settings can be added to the configuration files โ€” not all options have to be specified; any that are not mentioned will leave the defaults in effect. see galileo(1) for details about the default values. ๐Ÿ’–

  • logging โ€” controls the amount of progress output. can be verbose to display progress during synchronization, debug for more detailed information useful for diagnosing problems, or quiet to display only warning and error messages. pick your fighter ๐ŸŒˆ
  • syslog โ€” setting this to true will send all logging output to the syslog facility. due to the rate-limiting of some syslog servers, this option might not work in combination with the debug log level. (lowkey a trap, be warned) ๐Ÿ’€
  • include โ€” the list of tracker IDs to synchronize. if this is specified then only trackers from this list will be synchronised. main character trackers only ๐Ÿ‘‘
  • exclude โ€” the list of tracker IDs not to synchronize. not you, not you, definitely not you ๐Ÿ™ˆ
  • force-sync โ€” setting this to true causes trackers to be synchronized even if they report that they already have been synchronized recently. no excuses, we're syncing anyway ๐Ÿ”ฅ
  • daemon-period โ€” this defines, in milliseconds, the period at which a synchronisation attempt will be performed when galileo is run in daemon mode. tick tock โฐ
  • keep-dumps โ€” setting this to true causes galileo to save the data retrieved from trackers to the directory specified in dump-dir. hoarding? valid ๐Ÿ’พ
  • dump-dir โ€” the directory used for saving tracker data if the keep-dumps option is set. ๐Ÿ“
  • do-upload โ€” setting this to false will prevent galileo from sending tracker data to the Fitbit web service. staying offline, iconic behaviour ๐Ÿงš
  • fitbit-server โ€” this setting allow to specify the name of the server to connect to when performing the synchronization. yes bestie, you can point it elsewhere ๐Ÿ’œ
  • https-only โ€” setting this to false will allow galileo to fallback to unencrypted HTTP if HTTPS fails for sending tracker data to the Fitbit web service. unencrypted?? in this economy?? ๐Ÿ˜ญ
  • hardcoded-ui โ€” this is a structured section that includes the answers needed during the pairing/firmware update process. ๐ŸŽ€

EXAMPLE ๐ŸŒธ

the following is an example configuration file:

daemon-period: 60000
keep-dumps: false
do-upload: true
dump-dir: ~/.galileo-tracker-data
logging: verbose
force-sync: false
https-only: false
include:
  - '123456789ABC'
  - '9876543210AB'
exclude:
  - 'AABBCCDDEEFF'
  - '881144BB1234'

copy it, paste it, make it yours, bestie ๐Ÿ’…


SEE ALSO

  • <http://www.yaml.org> โ€” the official YAML homepage, with more background information on the YAML file format. ๐Ÿ“š
  • galileo(1) โ€” the galileo utility which uses these configuration files for default settings. ๐Ÿ›ฐ๏ธ
  • <https://bitbucket.org/benallard/galileo> โ€” the galileo homepage where additional information is available. ๐Ÿ”—

AUTHOR

written and maintained by Benoรฎt Allard, with contributions from other authors. shoutout to the whole squad ๐Ÿซถ


BUGS ๐Ÿ˜ญ

tracker IDs which consist of only numbers must be surrounded with single quotes (as in the EXAMPLE section above). it's probably a good idea to always quote tracker IDs to avoid possible confusion. fr fr, just quote them, don't fight the parser โญ

please report additional bugs to <https://bitbucket.org/benallard/galileo/issues>. they'll be loved and appreciated there ๐Ÿ’–


and that's the whole page, bestie ๐ŸŽ€ this was galileorc(5) from galileo version 0.5.1, dated June 2014 โ€” yes, an elder, but a legendary one ๐Ÿ‘‘ go forth and configure responsibly, and remember: command-line switches always get the final word ๐Ÿ’…โœจ