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

default_user_preferences in the compose file isn't documented anywhere #413

Open
TheFrenchGhosty opened this issue Jun 25, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@TheFrenchGhosty
Copy link
Member

Multiple people have been reported that they couldn't figure out how to change the default instance settings.

After digging into it... I discovered that it wasn't documented anywhere.

We need to document that this is the expected format:

(this is taken from my own instances)

    environment:
      # Please read the following file for a comprehensive list of all available
      # configuration options and their associated syntax:
      # https://github.com/iv-org/invidious/blob/master/config/config.example.yml
      INVIDIOUS_CONFIG: |
        check_tables: true
        db:
          dbname: invidious
          user: kemal
          password: kemal
          host: postgres
          port: 5432
        https_only: true
        domain: <REDACTED>
        external_port: 443
        log_level: Error
        popular_enabled: false
        registration_enabled: false
        login_enabled: false
        hmac_key: <REDACTED>
        default_user_preferences:
          dark_mode: dark
          feed_menu: []
          default_home: Search
          annotations: true
          annotations_subscribed: true
          related_videos: false
          quality: dash
          quality_dash: 1080p
          local: true
@unixfox
Copy link
Member

unixfox commented Jun 25, 2023

It has always been documented inside the config.example.yml itself: https://github.com/iv-org/invidious/blob/master/config/config.example.yml#L517

Like stated in https://docs.invidious.io/configuration/

@TheFrenchGhosty
Copy link
Member Author

@unixfox I mean, yes, but it easy to miss when setting up a compose file.

@unixfox unixfox added the documentation Improvements or additions to documentation label Nov 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants