You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Go to file
Dag 7f1b32f390
feat: add a proper feed item uid when the bridge errors out (#3237)
4 days ago
.github [Core] Update GH Actions (#3235) 6 days ago
actions feat: add a proper feed item uid when the bridge errors out (#3237) 4 days ago
bridges fix: # and / in filter bridge (#3236) 5 days ago
cache [TwitterBridge] Fix the bridge using a brand new API 3 years ago
caches fix: make filecache be case-sensitive on key (#3113) 3 months ago
config docker: Switch to nginx in docker image (#2721) 9 months ago
contrib refactor: rename rssbridge.php to bootstrap.php (#2987) 5 months ago
docs docs (#3238) 5 days ago
formats refactor: html format (#3062) 4 months ago
lib feat: add a proper feed item uid when the bridge errors out (#3237) 4 days ago
static docs: more screenshots (#3149) 3 months ago
templates feat: system alert message (#3139) 3 months ago
tests refactor: extract frontpage to template (#3130) 3 months ago
vendor Add php-urljoin license 8 months ago
.dockerignore [Docker file] Fix wrong version string in docker images (#2497) 11 months ago
.git-blame-ignore-revs Add .git-blame-ignore-revs file (#2903) 7 months ago
.gitattributes [Docker] force unix line ending on bash files to prevent docker run failing on windows (#2629) 10 months ago
.gitignore docker: Switch to nginx in docker image (#2721) 9 months ago
CONTRIBUTORS.md chore: introduce CONTRIBUTORS.md (#2839) 7 months ago
Dockerfile fix: remove duplicate apt install in dockerfile (#3172) 2 months ago
README.md php 7.4 (or higher) (#3232) 7 days ago
UNLICENSE let's unlicense ! 9 years ago
app.json Update app.json 10 months ago
composer.json [OLXBridge] new bridge (#2944) 3 months ago
composer.lock composer: Update lockfile 7 months ago
config.default.ini.php feat: add max file size to http responses (#3140) 3 months ago
docker-bake.hcl New docker build mechanism (#2268) 1 year ago
docker-entrypoint.sh [docker-entrypoint.sh] Add custom formats (#3179) 2 months ago
index.php refactor: rename rssbridge.php to bootstrap.php (#2987) 5 months ago
phpcompatibility.xml refactor: general code base refactor (#2950) 6 months ago
phpcs.xml docs (#3217) 3 weeks ago
phpunit.xml refactor: rename rssbridge.php to bootstrap.php (#2987) 5 months ago
scalingo.json Typo 7 years ago
whitelist.default.txt feat: new list of default bridges (#3148) 3 months ago

README.md

RSS-Bridge

RSS-Bridge

RSS-Bridge is a PHP project capable of generating RSS and Atom feeds for websites that don't have one.

LICENSE GitHub release irc.libera.chat Chat on Matrix Actions Status

Screenshot #1 Screenshot #2
Screenshot #3 Screenshot #4
Screenshot #5 Screenshot #6
Screenshot #7 Screenshot #8

A subset of bridges

  • YouTube : YouTube user channel, playlist or search
  • Twitter : Return keyword/hashtag search or user timeline
  • Telegram : Return the latest posts from a public group
  • Reddit : Return the latest posts from a subreddit or user
  • Filter : Filter an existing feed url
  • Vk : Latest posts from a user or group
  • FeedMerge : Merge two or more existing feeds into one
  • Twitch : Fetch the latest videos from a channel
  • ThePirateBay : Returns the newest indexed torrents from The Pirate Bay with keywords

And many more, thanks to the community!

Full documentation

Check out RSS-Bridge right now on https://rss-bridge.org/bridge01 or find another public instance.

Tutorial

RSS-Bridge requires php 7.4 (or higher).

Install with git:

cd /var/www
git clone https://github.com/RSS-Bridge/rss-bridge.git

# Give the http user write permission to the cache folder
chown www-data:www-data /var/www/rss-bridge/cache

# Optionally copy over the default config file
cp config.default.ini.php config.ini.php

# Optionally copy over the default whitelist file
cp whitelist.default.txt whitelist.txt

Example config for nginx:

# /etc/nginx/sites-enabled/rssbridge
server {
    listen 80;
    server_name example.com;
    root /var/www/rss-bridge;
    index index.php;

    location ~ \.php$ {
        include snippets/fastcgi-php.conf;
        fastcgi_read_timeout 60s;
        fastcgi_pass unix:/run/php/php-fpm.sock;
    }
}

Install with Docker:

Install by using docker image from Docker Hub:

# Create container
docker create --name=rss-bridge --publish 3000:80 rssbridge/rss-bridge

# Start container
docker start rss-bridge

Browse http://localhost:3000/

Install by locally building the image:

# Build image from Dockerfile
docker build -t rss-bridge .

# Create container
docker create --name rss-bridge --publish 3000:80 rss-bridge

# Start the container
docker start rss-bridge

Browse http://localhost:3000/

Install with docker-compose

Create a docker-compose.yml file locally with with the following content:

version: '2'
services:
  rss-bridge:
    image: rssbridge/rss-bridge:latest
    volumes:
      - </local/custom/path>:/config
    ports:
      - 3000:80
    restart: unless-stopped

Then launch with docker-compose:

docker-compose up

Browse http://localhost:3000/

Alternative installation methods

Deploy on Scalingo Deploy to Heroku Deploy to Cloudron

The Heroku quick deploy currently does not work. It might possibly work if you fork this repo and modify the repository in scalingo.json. See https://github.com/RSS-Bridge/rss-bridge/issues/2688

Learn more in Installation.

How-to

How to create a new bridge from scratch

Create the new bridge in e.g. bridges/BearBlogBridge.php:

<?php

class BearBlogBridge extends BridgeAbstract
{
    const NAME = 'BearBlog (bearblog.dev)';

    public function collectData()
    {
        $dom = getSimpleHTMLDOM('https://herman.bearblog.dev/blog/');
        foreach ($dom->find('.blog-posts li') as $li) {
            $a = $li->find('a', 0);
            $this->items[] = [
                'title' => $a->plaintext,
                'uri' => 'https://herman.bearblog.dev' . $a->href,
            ];
        }
    }
}

Learn more in bridge api.

How to enable all bridges

Write an asterisks to whitelist.txt:

echo '*' > whitelist.txt

Learn more in enabling briges

How to enable a bridge

Add the bridge name to whitelist.txt:

echo 'FirefoxAddonsBridge' >> whitelist.txt

How to enable debug mode

Create a file named DEBUG:

touch DEBUG

Learn more in debug mode.

How to create a new output format

Create a new format.

Explanation

We are RSS-Bridge community, a group of developers continuing the project initiated by sebsauvage, webmaster of sebsauvage.net, author of Shaarli and ZeroBin.

See CONTRIBUTORS.md

RSS-Bridge uses caching to prevent services from banning your server for repeatedly updating feeds. The specific cache duration can be different between bridges. Cached files are deleted automatically after 24 hours.

RSS-Bridge allows you to take full control over which bridges are displayed to the user. That way you can host your own RSS-Bridge service with your favorite collection of bridges!

Reference

FeedItem properties

    $item = [
        'uri' => 'https://example.com/blog/hello',
        'title' => 'Hello world',
        // Publication date in unix timestamp
        'timestamp' => 1668706254,
        'author' => 'Alice',
        'content' => 'Here be item content',
        'enclosures' => [
            'https://example.com/foo.png',
            'https://example.com/bar.png'
        ],
        'categories' => [
            'news',
            'tech',
        ],
        // Globally unique id
        'uid' => 'e7147580c8747aad',
    ]

Output formats:

  • Atom : Atom feed, for use in feed readers
  • Html : Simple HTML page
  • Json : JSON, for consumption by other applications
  • Mrss : MRSS feed, for use in feed readers
  • Plaintext : Raw text, for consumption by other applications

Licenses

The source code for RSS-Bridge is Public Domain.

RSS-Bridge uses third party libraries with their own license:

Rant

Dear so-called "social" websites.

Your catchword is "share", but you don't want us to share. You want to keep us within your walled gardens. That's why you've been removing RSS links from webpages, hiding them deep on your website, or removed feeds entirely, replacing it with crippled or demented proprietary API. FUCK YOU.

You're not social when you hamper sharing by removing feeds. You're happy to have customers creating content for your ecosystem, but you don't want this content out - a content you do not even own. Google Takeout is just a gimmick. We want our data to flow, we want RSS or Atom feeds.

We want to share with friends, using open protocols: RSS, Atom, XMPP, whatever. Because no one wants to have your service with your applications using your API force-feeding them. Friends must be free to choose whatever software and service they want.

We are rebuilding bridges you have willfully destroyed.

Get your shit together: Put RSS/Atom back in.