jotta / jotta-cli-issues

45 stars 1 forks source link

Request: More documentation on configuration options #184

Open imchairmanm opened 1 year ago

imchairmanm commented 1 year ago

jotta-cli release (jotta-cli version):

0.14.60923

Description of problem:

It would be helpful to have more documentation on some of the configurable behavior of both jottad and jotta-cli.

In general, with the transition from reading the configuration file to the jotta-cli config set workflow, the configurability of the jotta-cli and jottad has decreased a bit. There's no longer obvious ways to do things like change the location of the log file for example.

For jottad, if you run jottad help, you can see some info on available options, but it's unclear exactly how to use the information provided. You can track down examples in the run_jottad script and the jottad.service file, but this is not obvious.

Another thing that I noticed is that the included systemd user service file contains a line that optionally loads an environment file at ~/.config/jotta-cli/jotta-cli.env if present. However, it's unclear what environment variables we can use in that file to influence the behavior of jottad.

It'd be great to get some more info on these parts of the tools so that we can run them in our environments a bit better.