Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Environment variables and configuration flags for Kolibri options are persisted to the options.ini file by generate_empty_options_file #9551

Closed
rtibbles opened this issue Jul 6, 2022 · 2 comments · Fixed by #11737
Assignees
Labels
help wanted Open source contributors welcome P2 - normal Priority: Nice to have

Comments

@rtibbles
Copy link
Member

rtibbles commented Jul 6, 2022

Observed behavior

When using either environment variables or configuration flags like --port or --debug on the first run of a Kolibri device, these will be written to the empty options.ini file generated by generate_empty_options_file - this means that settings chosen on the first run by ephemeral configuration like environment variables and runtime flags will be persisted for subsequent runs of the server.

Expected behavior

Ephemeral configuration should not be persisted to disk.

User-facing consequences

The main place this could be problematic is if someone is using a base Kolibri to generate a KOLIBRI_HOME image and they do not intend their configuration flags to be persisted.

Additionally, Kolibri developers might be confused why flags are being persisted when they shouldn't.

Steps to reproduce

Run kolibri with a new KOLIBRI_HOME directory. Run with the --debug flag.

See that options.ini contains an uncommented line DEBUG = True

Context

Tell us about your environment, including:

  • Kolibri version: 0.15.5
  • Operating system: Ubuntu
@rtibbles rtibbles added the P2 - normal Priority: Nice to have label Jul 6, 2022
@rtibbles rtibbles changed the title Environment variables and configuration flags for Kolibri options are persisted to the options.ini file by generate_empty_options_file Environment variables and configuration flags for Kolibri options are persisted to the options.ini file by generate_empty_options_file Jul 6, 2022
@rtibbles rtibbles added this to the Planned Patch 6 milestone Jul 12, 2022
@rtibbles rtibbles added the help wanted Open source contributors welcome label Jan 3, 2024
@thesujai
Copy link
Contributor

I want to work on this.

@AlexVelezLl
Copy link
Member

Hi @thesujai. I have assigned this issue to you 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Open source contributors welcome P2 - normal Priority: Nice to have
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants