A subset of bridges (15/447)

Tutorial

How to install on traditional shared web hosting

How to install on Debian 12 (nginx + php-fpm)

timedatectl set-timezone Europe/Osloapt install git nginx php8.2-fpm php-mbstring php-simplexml php-curl php-intl# Create a user accountuseradd --shell /bin/bash --create-home rss-bridgecd /var/www# Create folder and change its ownership to rss-bridgemkdir rss-bridge&& chown rss-bridge:rss-bridge rss-bridge/# Become rss-bridgesu rss-bridge# Clone master branch into existing foldergit clone https://github.com/RSS-Bridge/rss-bridge.git rss-bridge/cd rss-bridge# Copy over the default config (OPTIONAL)cp -v config.default.ini.php config.ini.php# Recursively give full permissions to user/ownerchmod 700 --recursive ./# Give read and execute to others on folder ./staticchmod o+rx ./ ./static# Recursively give give read to others on folder ./staticchmod o+r --recursive ./static

# /etc/nginx/sites-enabled/rss-bridge.confserver{listen80;    # TODO: change to your own server nameserver_name example.com;access_log /var/log/nginx/rss-bridge.access.log;error_log /var/log/nginx/rss-bridge.error.log;log_not_found off;    # Intentionally not setting a root folder    # Static content only served herelocation /static/{alias /var/www/rss-bridge/static/;}    # Pass off to php-fpm only when location is EXACTLY == /location = /{root /var/www/rss-bridge/;include snippets/fastcgi-php.conf;fastcgi_read_timeout45s;fastcgi_pass unix:/run/php/rss-bridge.sock;}    # Reduce log noiselocation = /favicon.ico{access_log off;}    # Reduce log noiselocation = /robots.txt{access_log off;}}

; /etc/php/8.2/fpm/pool.d/rss-bridge.conf[rss-bridge]user = rss-bridgegroup = rss-bridgelisten = /run/php/rss-bridge.socklisten.owner = www-datalisten.group = www-data; Create 10 workers standing by to serve requestspm = staticpm.max_children = 10; Respawn worker after 500 requests (workaround for memory leaks etc.)pm.max_requests = 500

; /etc/php/8.2/fpm/conf.d/30-rss-bridge.inimax_execution_time = 15memory_limit = 64M

# Lint and restart php-fpmphp-fpm8.2 -t&& systemctl restart php8.2-fpm# Lint and restart nginxnginx -t&& systemctl restart nginx

How to install from Composer

cd /var/wwwcomposer create-project -v --no-dev --no-scripts rss-bridge/rss-bridge

How to install with Caddy

Install from Docker Hub:

# Create containerdocker create --name=rss-bridge --publish 3000:80 --volume$(pwd)/config:/config rssbridge/rss-bridge

# Start containerdocker start rss-bridge

Install by locally building from Dockerfile

# Build image from Dockerfiledocker build -t rss-bridge.# Create containerdocker create --name rss-bridge --publish 3000:80 --volume$(pwd)/config:/config rss-bridge

# Start containerdocker start rss-bridge

Install with docker-compose (using Docker Hub)

docker-compose up

Other installation methods

How-to

How to fix "Access denied."

chown rss-bridge:rss-bridge /var/www/rss-bridge/index.php

How to password-protect the instance (token)

[authentication]token = "hunter2"

How to remove all cache items

bin/cache-clear

sudo -u rss-bridge bin/cache-clear

sudo bin/cache-clear

How to remove all expired cache items

bin/cache-prune

How to fix "PHP Fatal error: Uncaught Exception: The FileCache path is not writable"

# Give rss-bridge ownershipchown rss-bridge:rss-bridge -R /var/www/rss-bridge/cache# Or, give www-data ownershipchown www-data:www-data -R /var/www/rss-bridge/cache# Or, give everyone write permissionchmod 777 -R /var/www/rss-bridge/cache# Or last ditch effort (CAREFUL)rm -rf /var/www/rss-bridge/cache/&& mkdir /var/www/rss-bridge/cache/

How to fix "attempt to write a readonly database"

chown -v rss-bridge:rss-bridge cache/*

How to fix "Unable to prepare statement: 1, no such table: storage"

rm cache/*

How to create a completely new bridge

<?phpdeclare(strict_types=1);

<?phpdeclare(strict_types=1);class BearBlogBridgeextends BridgeAbstract{constNAME ='BearBlog (bearblog.dev)';publicfunctioncollectData()    {$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,            ];        }    }}

How to enable all bridges

enabled_bridges[] = *

How to enable some bridges

enabled_bridges[] = TwitchBridgeenabled_bridges[] = GettrBridge

How to switch to memcached as cache backend

[cache]; Cache backend: file (default), sqlite, memcached, nulltype = "memcached"

How to switch to sqlite3 as cache backend

type = "sqlite"

How to disable bridge errors (as feed items)

[error]; Defines how error messages are returned by RSS-Bridge;; "feed" = As part of the feed (default); "http" = As HTTP error message; "none" = No errors are reportedoutput = "http"

How to accumulate errors before finally reporting it

; Defines how often an error must occur before it is reported to the userreport_limit = 3

How to password-protect the instance (HTTP Basic Auth)

[authentication]enable = trueusername = "alice"password = "cat"

How to create a new output format

How to run unit tests and linter

./vendor/bin/phpunit

./vendor/bin/phpunit --filter UrlTest

./vendor/bin/phpcs --standard=phpcs.xml --warning-severity=0 --extensions=php -p ./

How to spawn a minimal development environment

php -S 127.0.0.1:9001

Explanation

Reference

Feed item structure

$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

Cache backends

Licenses

Rant