feat: trending_enabled and search_enabled params added

[NorkzYT]

This pull request contains two new config parameters, trending_enabled and search_enabled.

These parameters allow administrators to selectively enable or disable the trending and search functionalities within their Invidious instance. This was done with the motive to provide greater control over the feature set exposed to users.

[NorkzYT]

Code formatting issues will be fixed soon.

[unixfox]

If we are going to allow every specific pages to be disabled, we might as well use an array for that like:

pages_enabled:
  trending: true
  popular: true
  search: true

[NorkzYT]

@unixfox

Great suggestion. Do you recommend I implement it in this GitHub Pull Request or in a separate one?

[unixfox]

Would prefer in this one but we would need to keep compatibility with existing popular_enabled parameter.

[NorkzYT]

Understood, that works.

[unixfox]

@SamantazFox advice on my comment please: #4674 (comment)

[SamantazFox]

If we are going to allow every specific pages to be disabled, we might as well use an array for that like:

pages_enabled:
  trending: true
  popular: true
  search: true

Yes, I second that! However, it will be a breaking change (will go with the next major version release).

@NorkzYT Though, why do you want to disable search? For the trending feed, I can understand that you may not want random crap in your home page, but why search?

[NorkzYT]

@SamantazFox

My plan is to enable Invidious admins to control which features are accessible to users. This is particularly important for families/my family with young children who prefer YouTube over YouTube Kids. I found that existing tools lacked the ability to give admins such granular control over user features, thus I decided to contribute to Invidious by developing these admin control features.

For instance, in my case, I want to restrict access for some users that only very young children use to only allow certain YouTube channels that are pre-approved and subscribed to their user account. By disabling features like search, trending, and popular, I can ensure that children only interact with videos from these subscribed channels and playlists, thereby preventing exposure to unsuitable and overage content.

Additionally, I propose adding a search bar specifically for subscriptions and playlists. This would allow users to quickly find videos within these predefined categories without the need to navigate through entire channels or playlists, thus saving time and ensuring a safer viewing experience.

I know that a tool called TubeArchivist has a search feature for videos that have already been downloaded. However, I am switching from TubeArchivist to Invidious because I no longer want to host 5TB of downloaded YouTube videos, especially as the library keeps growing.

[NorkzYT]

I will start working on this to complete as soon as I can.

[NorkzYT]

Complete. Someone please test as the only issue I know is the Invidious docker container becoming unhealthy if I specify pages_enabled in the environmental variables under INVIDIOUS_CONFIG: as shown below even though it works without issues in Invidious itself.

services:
  invidious:
    container_name: invidious
    hostname: invidious
    build:
      context: .
      dockerfile: docker/Dockerfile.arm64
    restart: unless-stopped
    ports:
      - "3000:3000"
    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: |
        db:
          dbname: invidious
          user: kemal
          password: kemal
          host: invidious-db
          port: 5432
        check_tables: true
        # external_port:
        # domain:
        # https_only: false
        # statistics_enabled: false
        hmac_key: "xxx"
        player_style: youtube
        save_player_pos: true
        registration_enabled: true
        pages_enabled:
          popular: false
          trending: false
          search: false
        captcha_enabled: false
        feed_menu: ["Subscriptions", "Playlists"]
        default_home: <none>
        related_videos: false
        admins: ["norkz"] # set your user name
    healthcheck:
      test: wget -nv --tries=1 --spider http://127.0.0.1:3000/api/v1/trending || exit 1
      interval: 30s
      timeout: 5s
      retries: 2
    networks:
      - proxy

[iBicha]

Complete. Someone please test as the only issue I know is the Invidious docker container becoming unhealthy if I specify pages_enabled in the environmental variables under INVIDIOUS_CONFIG: as shown below even though it works without issues in Invidious itself.

The health check is hitting the trending endpoint

    healthcheck:
      test: wget -nv --tries=1 --spider http://127.0.0.1:3000/api/v1/trending || exit 1

Which you have disabled, so it is natural for it to appear unhealthy

[NorkzYT]

@iBicha

Ah, thank you for the explanation. Much appreciated. I went right by it and did not notice.

[NorkzYT]

@SamantazFox

Thank you for the info. Suggestions have been added and completed.