Giter VIP home page Giter VIP logo

better-video-rss's Introduction

BetterVideoRss

Latest Version Software License

BetterVideoRss is a PHP script for generating YouTube channel and playlist RSS feeds using YouTube's Data API and RSS feeds.

screenshot

Installation

docker-compose

Show/hide details
version: '3'

services:
  app:
    image: ghcr.io/verifiedjoseph/better-video-rss:1.8.1
    container_name: BetterVideoRss
    environment:
      BVRSS_YOUTUBE_API_KEY: ''
      BVRSS_SELF_URL_PATH: 'https://example.com/'
      BVRSS_TIMEZONE: 'Europe/London'
    ports:
      - '127.0.0.1:8080:8080'
    volumes:
      - cache:/app/cache
    cap_drop:
      - ALL
    security_opt:
      - no-new-privileges:true

volumes:
  cache:

Manually

Show/hide install details
  1. Download the latest release to your web server and extract the zip archive.

  2. Configure the application using config.php copied from config.example.php.

    cp config.example.php config.php
    

Notes

The cache and vendor folders do not need to be reachable in the browser and access should blocked.

Configuration

Environment variables are used to adjust the configuration. Alternatively, you can use config.php (copied from config.example.php).

Required variables

Name Type Description
BVRSS_SELF_URL_PATH string Fully qualified URL used to access BetterVideoRss.
BVRSS_YOUTUBE_API_KEY string YouTube API Key (developers.google.com)

Optional variables

Name Type Default value Description
BVRSS_TIMEZONE string UTC Timezone (php docs)
BVRSS_DATE_FORMAT string F j, Y Date format (php docs)
BVRSS_TIME_FORMAT string H:i Time format (php docs)
BVRSS_CACHE_DIR string cache Cache directory path.
BVRSS_DISABLE_CACHE boolean false Disables caching.
BVRSS_ENABLE_CACHE_VIEWER boolean false Enables cache viewer.
BVRSS_ENABLE_IMAGE_PROXY boolean false Enables video thumbnail image proxy.
BVRSS_DISABLE_CSP boolean false Disables content security policy.
BVRSS_RAW_API_ERRORS boolean false Enables displaying of raw API errors.

Documentation

Requirements

Changelog

All notable changes to this project are documented in the CHANGELOG.

License

MIT License. Please see LICENSE for more information.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.