249 changed files with 13168 additions and 6586 deletions
@ -1,23 +0,0 @@ |
|||
# N.B. the unix:/var/run/php/php7.2-fpm.sock path used repeatedly below will |
|||
# vary from system to system and will be probably need to be changed |
|||
|
|||
<VirtualHost *:80> |
|||
ServerName localhost |
|||
# adjust according to your installation path |
|||
DocumentRoot /usr/share/arsse/www |
|||
|
|||
# adjust according to your installation path |
|||
ProxyFCGISetEnvIf "true" SCRIPT_FILENAME "/usr/share/arsse/arsse.php" |
|||
ProxyPreserveHost On |
|||
|
|||
# Nextcloud News v1.2, Tiny Tiny RSS API, TT-RSS newsfeed icons |
|||
<LocationMatch "(/index\.php/apps/news/api/?.+|/tt-rss/(api|feed-icons))"> |
|||
ProxyPass "unix:/var/run/php/php7.2-fpm.sock|fcgi://localhost/usr/share/arsse" |
|||
</LocationMatch> |
|||
|
|||
# Nextcloud News API detection, Fever API |
|||
<LocationMatch "(/index\.php/apps/news/api/?$|/fever)"> |
|||
# these locations should not be behind HTTP authentication |
|||
ProxyPass "unix:/var/run/php/php7.2-fpm.sock|fcgi://localhost/usr/share/arsse" |
|||
</LocationMatch> |
|||
</VirtualHost> |
|||
@ -0,0 +1,34 @@ |
|||
# Nextcloud News protocol |
|||
<Location "/index.php/apps/news/api"> |
|||
ProxyPass ${ARSSE_PROXY} |
|||
</Location> |
|||
|
|||
# Tiny Tiny RSS protocol |
|||
<Location "/tt-rss/api"> |
|||
ProxyPass ${ARSSE_PROXY} |
|||
</Location> |
|||
|
|||
# Tiny Tiny RSS feed icons |
|||
<Location "/tt-rss/feed-icons"> |
|||
ProxyPass ${ARSSE_PROXY} |
|||
</Location> |
|||
|
|||
# Fever protocol |
|||
<Location "/fever"> |
|||
ProxyPass ${ARSSE_PROXY} |
|||
</Location> |
|||
|
|||
# Miniflux protocol |
|||
<Location "/v1"> |
|||
ProxyPass ${ARSSE_PROXY} |
|||
</Location> |
|||
|
|||
# Miniflux version number |
|||
<Location "/version"> |
|||
ProxyPass ${ARSSE_PROXY} |
|||
</Location> |
|||
|
|||
# Miniflux "health check" |
|||
<Location "/healthcheck"> |
|||
ProxyPass ${ARSSE_PROXY} |
|||
</Location> |
|||
@ -0,0 +1,11 @@ |
|||
DocumentRoot "/usr/share/arsse/www" |
|||
<Directory "/usr/share/arsse/www"> |
|||
Require all granted |
|||
</Directory> |
|||
|
|||
Define ARSSE_PROXY "unix:/var/run/php/arsse.sock|fcgi://localhost/usr/share/arsse/" |
|||
ProxyPreserveHost On |
|||
ProxyFCGISetEnvIf "true" SCRIPT_FILENAME "/usr/share/arsse/arsse.php" |
|||
ProxyFCGISetEnvIf "-n req('Authorization')" HTTP_AUTHORIZATION "%{req:Authorization}" |
|||
|
|||
Include "/etc/arsse/apache/arsse-loc.conf" |
|||
@ -0,0 +1,9 @@ |
|||
<VirtualHost *:443> |
|||
ServerName "news.example.com" |
|||
SSLEngine On |
|||
|
|||
SSLCertificateFile "/etc/letsencrypt/live/news.example.com/fullchain.pem" |
|||
SSLCertificateKeyFile "/etc/letsencrypt/live/news.example.com/privkey.pem" |
|||
|
|||
Include "/etc/arsse/apache/arsse.conf" |
|||
</VirtualHost> |
|||
@ -0,0 +1,57 @@ |
|||
# Maintainer: J. King <jking@jkingweb.ca> |
|||
pkgname="arsse" |
|||
pkgver=0.9.2 |
|||
pkgrel=1 |
|||
epoch= |
|||
pkgdesc="Multi-protocol RSS/Atom newsfeed synchronization server" |
|||
arch=("any") |
|||
url="https://thearsse.com/" |
|||
license=("MIT") |
|||
depends=() |
|||
makedepends=() |
|||
checkdepends=() |
|||
optdepends=("nginx: HTTP server" |
|||
"apache>=2.4: HTTP server" |
|||
"percona-server: Alternate database" |
|||
"postgresql>=10: Alternate database" |
|||
"php-pgsql>=7.1: PostgreSQL database support") |
|||
backup=("etc/webapps/arsse/config.php" |
|||
"etc/php/php-fpm.d/arsse.conf" |
|||
"etc/webapps/arsse/nginx/example.conf" |
|||
"etc/webapps/arsse/nginx/arsse.conf" |
|||
"etc/webapps/arsse/nginx/arsse-loc.conf" |
|||
"etc/webapps/arsse/nginx/arsse-fcgi.conf" |
|||
"etc/webapps/arsse/apache/example.conf" |
|||
"etc/webapps/arsse/apache/arsse.conf" |
|||
"etc/webapps/arsse/apache/arsse-loc.conf") |
|||
source=("arsse-0.9.2.tar.gz") |
|||
md5sums=("SKIP") |
|||
|
|||
package() { |
|||
# define runtime dependencies |
|||
depends=("php>=7.1" "php-intl>=7.1" "php-sqlite>=7.1" "php-fpm>=7.1") |
|||
# create most directories necessary for the final package |
|||
cd "$pkgdir" |
|||
mkdir -p "usr/share/webapps/arsse" "usr/share/doc/arsse" "usr/share/licenses/arsse" "usr/lib/systemd/system" "usr/lib/sysusers.d" "usr/lib/tmpfiles.d" "etc/php/php-fpm.d" "etc/webapps/arsse" |
|||
# copy requisite files |
|||
cd "$srcdir/arsse" |
|||
cp -r lib locale sql vendor www CHANGELOG UPGRADING README.md arsse.php "$pkgdir/usr/share/webapps/arsse" |
|||
cp -r manual/* "$pkgdir/usr/share/doc/arsse" |
|||
cp LICENSE AUTHORS "$pkgdir/usr/share/licenses/arsse" |
|||
cp dist/systemd/* "$pkgdir/usr/lib/systemd/system" |
|||
cp dist/sysuser.conf "$pkgdir/usr/lib/sysusers.d/arsse.conf" |
|||
cp dist/tmpfiles.conf "$pkgdir/usr/lib/tmpfiles.d/arsse.conf" |
|||
cp dist/php-fpm.conf "$pkgdir/etc/php/php-fpm.d/arsse.conf" |
|||
cp -r dist/man "$pkgdir/usr/share" |
|||
cp -r dist/nginx dist/apache config.defaults.php "$pkgdir/etc/webapps/arsse" |
|||
cd "$pkgdir" |
|||
# copy files requiring special permissions |
|||
cd "$srcdir/arsse" |
|||
install -Dm755 dist/arsse "$pkgdir/usr/bin/arsse" |
|||
install -Dm640 dist/config.php "$pkgdir/etc/webapps/arsse" |
|||
# patch generic configuration files to use Arch-specific paths and identifiers |
|||
sed -i -se 's/\/\(etc\|usr\/share\)\/arsse\//\/\1\/webapps\/arsse\//g' "$pkgdir/etc/webapps/arsse/nginx/"* "$pkgdir/etc/webapps/arsse/apache/"* "$pkgdir/usr/lib/tmpfiles.d/arsse.conf" "$pkgdir/usr/lib/systemd/system/"* "$pkgdir/usr/bin/"* |
|||
sed -i -se 's/\/var\/run\/php\//\/run\/php-fpm\//g' "$pkgdir/etc/webapps/arsse/nginx/"* "$pkgdir/etc/webapps/arsse/apache/"* "$pkgdir/etc/php/php-fpm.d/arsse.conf" |
|||
sed -i -se 's/www-data/http/g' "$pkgdir/etc/php/php-fpm.d/arsse.conf" |
|||
sed -i -e 's/^WorkingDirectory=.*$/WorkingDirectory=\/usr\/share\/webapps\/arsse/g' -e 's/^ConfigurationDirectory=.*$/ConfigurationDirectory=webapps\/arsse/g' "$pkgdir/usr/lib/systemd/system/arsse-fetch.service" |
|||
} |
|||
@ -0,0 +1,74 @@ |
|||
# Maintainer: J. King <jking@jkingweb.ca> |
|||
pkgname="arsse-git" |
|||
pkgver=0.9.2 |
|||
pkgrel=1 |
|||
epoch= |
|||
pkgdesc="Multi-protocol RSS/Atom newsfeed synchronization server, bugfix-testing version" |
|||
arch=("any") |
|||
url="https://thearsse.com/" |
|||
license=("MIT") |
|||
provides=("arsse") |
|||
conflicts=("arsse") |
|||
depends=("php>=7.1" "php-intl>=7.1" "php-sqlite>=7.1") |
|||
makedepends=("composer" "pandoc") |
|||
checkdepends=() |
|||
optdepends=("nginx: HTTP server" |
|||
"apache>=2.4: HTTP server" |
|||
"percona-server: Alternate database" |
|||
"postgresql>=10: Alternate database" |
|||
"php-pgsql>=7.1: PostgreSQL database support") |
|||
backup=("etc/webapps/arsse/config.php" |
|||
"etc/php/php-fpm.d/arsse.conf" |
|||
"etc/webapps/arsse/nginx/example.conf" |
|||
"etc/webapps/arsse/nginx/arsse.conf" |
|||
"etc/webapps/arsse/nginx/arsse-loc.conf" |
|||
"etc/webapps/arsse/nginx/arsse-fcgi.conf" |
|||
"etc/webapps/arsse/apache/example.conf" |
|||
"etc/webapps/arsse/apache/arsse.conf" |
|||
"etc/webapps/arsse/apache/arsse-loc.conf") |
|||
source=("git+https://code.mensbeam.com/MensBeam/arsse/") |
|||
md5sums=("SKIP") |
|||
|
|||
pkgver() { |
|||
cd "arsse" |
|||
git describe --tags | sed 's/\([^-]*-g\)/r\1/;s/-/./g' |
|||
} |
|||
|
|||
build() { |
|||
cd "$srcdir/arsse" |
|||
composer install |
|||
./robo manpage |
|||
./robo manual |
|||
composer install --no-dev -o --no-scripts |
|||
php arsse.php conf save-defaults config.defaults.php |
|||
rm -r vendor/bin |
|||
} |
|||
|
|||
package() { |
|||
# define runtime dependencies |
|||
depends=("php>=7.1" "php-intl>=7.1" "php-sqlite>=7.1" "php-fpm>=7.1") |
|||
# create most directories necessary for the final package |
|||
cd "$pkgdir" |
|||
mkdir -p "usr/share/webapps/arsse" "usr/share/doc/arsse" "usr/share/licenses/arsse" "usr/lib/systemd/system" "usr/lib/sysusers.d" "usr/lib/tmpfiles.d" "etc/php/php-fpm.d" "etc/webapps/arsse" |
|||
# copy requisite files |
|||
cd "$srcdir/arsse" |
|||
cp -r lib locale sql vendor www CHANGELOG UPGRADING README.md arsse.php "$pkgdir/usr/share/webapps/arsse" |
|||
cp -r manual/* "$pkgdir/usr/share/doc/arsse" |
|||
cp LICENSE AUTHORS "$pkgdir/usr/share/licenses/arsse" |
|||
cp dist/systemd/* "$pkgdir/usr/lib/systemd/system" |
|||
cp dist/sysuser.conf "$pkgdir/usr/lib/sysusers.d/arsse.conf" |
|||
cp dist/tmpfiles.conf "$pkgdir/usr/lib/tmpfiles.d/arsse.conf" |
|||
cp dist/php-fpm.conf "$pkgdir/etc/php/php-fpm.d/arsse.conf" |
|||
cp -r dist/man "$pkgdir/usr/share" |
|||
cp -r dist/nginx dist/apache config.defaults.php "$pkgdir/etc/webapps/arsse" |
|||
cd "$pkgdir" |
|||
# copy files requiring special permissions |
|||
cd "$srcdir/arsse" |
|||
install -Dm755 dist/arsse "$pkgdir/usr/bin/arsse" |
|||
install -Dm640 dist/config.php "$pkgdir/etc/webapps/arsse" |
|||
# patch generic configuration files to use Arch-specific paths and identifiers |
|||
sed -i -se 's/\/\(etc\|usr\/share\)\/arsse\//\/\1\/webapps\/arsse\//g' "$pkgdir/etc/webapps/arsse/nginx/"* "$pkgdir/etc/webapps/arsse/apache/"* "$pkgdir/usr/lib/tmpfiles.d/arsse.conf" "$pkgdir/usr/lib/systemd/system/"* "$pkgdir/usr/bin/"* |
|||
sed -i -se 's/\/var\/run\/php\//\/run\/php-fpm\//g' "$pkgdir/etc/webapps/arsse/nginx/"* "$pkgdir/etc/webapps/arsse/apache/"* "$pkgdir/etc/php/php-fpm.d/arsse.conf" |
|||
sed -i -se 's/www-data/http/g' "$pkgdir/etc/php/php-fpm.d/arsse.conf" |
|||
sed -i -e 's/^WorkingDirectory=.*$/WorkingDirectory=\/usr\/share\/webapps\/arsse/g' -e 's/^ConfigurationDirectory=.*$/ConfigurationDirectory=webapps\/arsse/g' "$pkgdir/usr/lib/systemd/system/arsse-fetch.service" |
|||
} |
|||
@ -0,0 +1,10 @@ |
|||
#! /usr/bin/env php |
|||
<?php |
|||
if (posix_geteuid() == 0) { |
|||
$info = posix_getpwnam("arsse"); |
|||
if ($info) { |
|||
posix_setgid($info['gid']); |
|||
posix_setuid($info['uid']); |
|||
} |
|||
} |
|||
require "/usr/share/arsse/arsse.php"; |
|||
@ -1,15 +0,0 @@ |
|||
[Unit] |
|||
Description=The Arsse feed fetching service |
|||
After=network.target mysql.service postgresql.service |
|||
|
|||
[Service] |
|||
User=www-data |
|||
Group=www-data |
|||
WorkingDirectory=/usr/share/arsse |
|||
Type=simple |
|||
StandardOutput=null |
|||
StandardError=syslog |
|||
ExecStart=/usr/bin/env php /usr/share/arsse/arsse.php daemon |
|||
|
|||
[Install] |
|||
WantedBy=multi-user.target |
|||
@ -0,0 +1,8 @@ |
|||
<?php |
|||
|
|||
# Please refer to config.defaults.php or the manual at /usr/share/doc/arsse/ |
|||
# for possible configuration parameters |
|||
|
|||
return [ |
|||
'dbSQLite3File' => "/var/lib/arsse/arsse.db", |
|||
]; |
|||
@ -0,0 +1,16 @@ |
|||
#!/bin/sh |
|||
|
|||
set -e |
|||
|
|||
. /usr/share/debconf/confmodule |
|||
|
|||
# Set up dbconfig-common |
|||
if test -f /usr/share/dbconfig-common/dpkg/config; then |
|||
. /usr/share/dbconfig-common/dpkg/config |
|||
dbc_dbtypes="sqlite3, pgsql, mysql" |
|||
dbc_authmethod_user="password" |
|||
dbc_go arsse "$@" |
|||
fi |
|||
|
|||
# Prompt for dbconfig-common configuration |
|||
db_go || true |
|||
@ -0,0 +1 @@ |
|||
var/lib/arsse |
|||
@ -0,0 +1,18 @@ |
|||
lib usr/share/arsse/ |
|||
locale usr/share/arsse/ |
|||
sql usr/share/arsse/ |
|||
vendor usr/share/arsse/ |
|||
www usr/share/arsse/ |
|||
CHANGELOG usr/share/arsse/ |
|||
UPGRADING usr/share/arsse/ |
|||
README.md usr/share/arsse/ |
|||
arsse.php usr/share/arsse/ |
|||
|
|||
config.defaults.php etc/arsse/ |
|||
manual usr/share/doc/arsse/ |
|||
dist/man/* usr/share/man/ |
|||
dist/debian/config.php etc/arsse/ |
|||
dist/debian/dbconfig-common.php usr/share/arsse/ |
|||
debian/bin/arsse usr/bin/ |
|||
debian/nginx etc/arsse/ |
|||
debian/apache etc/arsse/ |
|||
@ -0,0 +1 @@ |
|||
etc/arsse/config.php usr/share/arsse/config.php |
|||
@ -0,0 +1,29 @@ |
|||
#!/bin/sh |
|||
|
|||
set -e |
|||
|
|||
. /usr/share/debconf/confmodule |
|||
|
|||
if [ "$1" = "configure" ]; then |
|||
# Set permissions on configuration file |
|||
dpkg-statoverride --list "/etc/arsse/config.php" >/dev/null || dpkg-statoverride --update --add root www-data 640 "/etc/arsse/config.php" |
|||
# Set up dbconfig-common |
|||
if test -f /usr/share/dbconfig-common/dpkg/postinst; then |
|||
. /usr/share/dbconfig-common/dpkg/postinst |
|||
dbc_generate_include_owner="root:www-data" |
|||
dbc_generate_include_perms="0640" |
|||
dbc_generate_include="php:/var/lib/arsse/dbconfig.inc" |
|||
dbc_pgsql_createdb_encoding="UTF8' lc_collate='C" |
|||
dbc_mysql_createdb_encoding="UTF8" |
|||
dbc_dbfile_owner="root:www-data" |
|||
dbc_dbfile_perms="0660" |
|||
dbc_go arsse "$@" |
|||
fi |
|||
fi |
|||
|
|||
# dh_installdeb will replace this with shell code automatically |
|||
# generated by other debhelper scripts. |
|||
|
|||
#DEBHELPER# |
|||
|
|||
exit 0 |
|||
@ -0,0 +1,20 @@ |
|||
#!/bin/sh |
|||
|
|||
set -e |
|||
|
|||
if test -f /usr/share/debconf/confmodule; then |
|||
. /usr/share/debconf/confmodule |
|||
fi |
|||
|
|||
# Set up dbconfig-common |
|||
if test -f /usr/share/dbconfig-common/dpkg/postrm; then |
|||
. /usr/share/dbconfig-common/dpkg/postrm |
|||
dbc_go arsse "$@" |
|||
fi |
|||
|
|||
# dh_installdeb will replace this with shell code automatically |
|||
# generated by other debhelper scripts. |
|||
|
|||
#DEBHELPER# |
|||
|
|||
exit 0 |
|||
@ -0,0 +1,16 @@ |
|||
#!/bin/sh |
|||
|
|||
set -e |
|||
|
|||
. /usr/share/debconf/confmodule |
|||
|
|||
# Set up dbconfig-common |
|||
. /usr/share/dbconfig-common/dpkg/prerm |
|||
dbc_go arsse "$@" |
|||
|
|||
# dh_installdeb will replace this with shell code automatically |
|||
# generated by other debhelper scripts. |
|||
|
|||
#DEBHELPER# |
|||
|
|||
exit 0 |
|||
@ -0,0 +1 @@ |
|||
10 |
|||
@ -0,0 +1,15 @@ |
|||
<?php |
|||
/*** |
|||
Please refer to config.defaults.php or the manual at /usr/share/doc/arsse/ |
|||
for possible configuration parameters. |
|||
|
|||
The last line includes database auto-configuration information which |
|||
Debian may have created during installation; any database-related |
|||
configuration defined in this file will override anything defined in the |
|||
included file. |
|||
***/ |
|||
|
|||
return [ |
|||
'dbAutoUpdate' => true, |
|||
] |
|||
+ (@include "/usr/share/arsse/dbconfig-common.php"); |
|||
@ -0,0 +1,32 @@ |
|||
Source: arsse |
|||
Maintainer: J. King <jking@jkingweb.ca> |
|||
Section: contrib/net |
|||
Priority: optional |
|||
Standards-Version: 4.5.1 |
|||
Homepage: https://thearsse.com/ |
|||
Vcs-Browser: https://code.mensbeam.com/MensBeam/arsse/ |
|||
Vcs-Git: https://code.mensbeam.com/MensBeam/arsse/ |
|||
Build-Depends: debhelper |
|||
|
|||
Package: arsse |
|||
Architecture: all |
|||
Section: contrib/net |
|||
Priority: optional |
|||
Homepage: https://thearsse.com/ |
|||
Description: Multi-protocol RSS/Atom newsfeed synchronization server |
|||
The Arsse bridges the gap between multiple existing newsfeed aggregator |
|||
client protocols such as Tiny Tiny RSS, Nextcloud News and Miniflux, |
|||
allowing you to use compatible clients for many protocols with a single |
|||
server. |
|||
Depends: ${misc:Depends}, |
|||
dbconfig-sqlite3 | dbconfig-pgsql | dbconfig-mysql | dbconfig-no-thanks, |
|||
php (>= 7.1.0), |
|||
php-cli, |
|||
php-intl, |
|||
php-json, |
|||
php-xml, |
|||
php-sqlite3 | php-pgsql | php-mysql |
|||
Recommends: nginx | apache2, |
|||
php-fpm, |
|||
php-curl, |
|||
ca-certificates |
|||
@ -0,0 +1,34 @@ |
|||
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ |
|||
Upstream-Name: arsse |
|||
Upstream-Contact: J. King <jking@jkingweb.ca> |
|||
Source: https://code.mensbeam.com/MensBeam/arsse/ |
|||
License: Expat |
|||
|
|||
Files: * |
|||
Copyright: 2017 J. King <jking@jkingweb.ca> |
|||
2017 Dustin Wilson <dustin@dustinwilson.com> |
|||
License: Expat |
|||
|
|||
License: Expat |
|||
Copyright (c) 2017 J. King, Dustin Wilson |
|||
. |
|||
Permission is hereby granted, free of charge, to any person |
|||
obtaining a copy of this software and associated documentation |
|||
files (the "Software"), to deal in the Software without |
|||
restriction, including without limitation the rights to use, |
|||
copy, modify, merge, publish, distribute, sublicense, and/or sell |
|||
copies of the Software, and to permit persons to whom the |
|||
Software is furnished to do so, subject to the following |
|||
conditions: |
|||
. |
|||
The above copyright notice and this permission notice shall be |
|||
included in all copies or substantial portions of the Software. |
|||
. |
|||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
|||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES |
|||
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
|||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT |
|||
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, |
|||
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
|||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
|||
OTHER DEALINGS IN THE SOFTWARE. |
|||
@ -0,0 +1,44 @@ |
|||
<?php |
|||
|
|||
# This script transforms Debian's dbconfig-common PHP-format include files |
|||
# into a form usable by The Arsse. This is necessary because The Arsse |
|||
# supports defining configuration parameters for all supported database types |
|||
# at once, using separate keys for the different types |
|||
|
|||
$dbconfpath = "/var/lib/arsse/dbconfig.inc"; // path defined in postinst script |
|||
|
|||
if (file_exists($dbconfpath)) { |
|||
require_once "/var/lib/arsse/dbconfig.inc"; |
|||
$dbtype = $dbtype ?? ""; |
|||
// the returned configuration depends on the $dbtype |
|||
if ($dbtype === "sqlite3") { |
|||
$conf = ['dbDriver' => "sqlite3"]; |
|||
if (strlen((string) $basepath) && strlen((string) $dbname)) { |
|||
$conf['dbSQLite3File'] = "$basepath/$dbname"; |
|||
} |
|||
} elseif ($dbtype === "pgsql") { |
|||
$conf = [ |
|||
'dbDriver' => "postgresql", |
|||
'dbPostgreSQLHost' => $dbserver ?? "", |
|||
'dbPostgreSQLUser' => $dbuser ?? "arsse", |
|||
'dbPostgreSQLPass' => $dbpass ?? "", |
|||
'dbPostgreSQLPort' => (int) $dbport ?: 5432, |
|||
'dbPostgreSQLDb' => $dbname ?? "arsse", |
|||
]; |
|||
} elseif ($dbtype === "mysql") { |
|||
$conf = [ |
|||
'dbDriver' => "mysql", |
|||
'dbMySQLHost' => $dbserver ?? "", |
|||
'dbMySQLUser' => $dbuser ?? "arsse", |
|||
'dbMySQLPass' => $dbpass ?? "", |
|||
'dbMySQLPort' => (int) $dbport ?: 3306, |
|||
'dbMySQLDb' => $dbname ?? "arsse", |
|||
]; |
|||
} else { |
|||
throw new \Exception("Debian dbconfig-common configuration file $dbconfpath is invalid"); |
|||
} |
|||
return $conf; |
|||
} else { |
|||
// if no configuration file exists simply return an empty array |
|||
return []; |
|||
} |
|||
@ -0,0 +1,6 @@ |
|||
# We make reference to "Tiny Tiny RSS" |
|||
spelling-error-in-description Tiny Tiny (duplicate word) Tiny |
|||
# The manual for DrUUID (a dependency) includes a harmless "up" link |
|||
privacy-breach-generic usr/share/arsse/vendor/jkingweb/druuid/documentation/manual.html [<link rel="up" href="http://jkingweb.ca/code/">] (http://jkingweb.ca/code/) |
|||
# We only ask dbconfig-common questions, which don't seem to require templates |
|||
no-debconf-templates |
|||
@ -0,0 +1,40 @@ |
|||
#! /bin/bash -e |
|||
|
|||
### |
|||
# This script is fed to pbuilder to build Debian packages. The base tarball |
|||
# should be created with a command similar to the following: |
|||
# |
|||
# sudo pbuilder create --basetgz pbuilder-arsse.tgz --mirror http://ftp.ca.debian.org/debian/ --extrapackages "debhelper devscripts lintian" |
|||
# |
|||
# Thereafter pbuilder can be used to build packages with this command: |
|||
# |
|||
# sudo pbuilder execute --basetgz pbuilder-arsse.tgz --bindmounts `basedir "/path/to/release/tarball"` -- pbuilder.sh "/path/to/release/tarball" |
|||
# |
|||
# This somewhat roundabout procedure is used because the pbuilder debuild |
|||
# command does not seem to work in Arch Linux, nor does pdebuild. Doing |
|||
# as much as possible within the chroot itself works around these problems. |
|||
### |
|||
|
|||
# create a temporary directory |
|||
tmp=`mktemp -d` |
|||
|
|||
# define various variables |
|||
here=`dirname "$1"` |
|||
tarball=`basename "$1"` |
|||
version=`echo "$tarball" | grep -oP '\d+(?:\.\d+)*' | head -1` |
|||
out="$here/debian" |
|||
in="$tmp/arsse-$version" |
|||
|
|||
# create necessary directories |
|||
mkdir -p "$in" "$out" |
|||
# extract the release tarball |
|||
tar -C "$in" -xf "$1" --strip-components=1 |
|||
# repackage the release tarball into a Debian "orig" tarball |
|||
tar -C "$tmp" -czf "$tmp/arsse_$version.orig.tar.gz" "arsse-$version" |
|||
# copy the "dist/debian" directory down the tree where Debian expects it |
|||
cp -r "$in/dist/debian" "$in/debian" |
|||
# build the package |
|||
cd "$in" |
|||
debuild -us -uc |
|||
# move the resultant files to their final destination |
|||
find "$tmp" -maxdepth 1 -type f -exec mv '{}' "$out" \; |
|||
@ -0,0 +1,26 @@ |
|||
#!/usr/bin/make -f |
|||
|
|||
DH_VERBOSE = 1 |
|||
|
|||
%: |
|||
dh $@ |
|||
|
|||
execute_before_dh_install: |
|||
# Adapt the systemd service for Debian: this involves using only the "arsse-fetch" unit (renamed to "arsse"), removing the "PartOf" directive, and changing the user and group to "www-data" |
|||
cp dist/systemd/arsse-fetch.service debian/arsse.service |
|||
sed -i -se 's/^PartOf=.*//' debian/arsse.service |
|||
sed -i -se 's/^\(User\|Group\)=.*/\1=www-data/' debian/arsse.service |
|||
# Adapt the init script for Debian: this involves changing the user and group to "www-data" |
|||
cp dist/init.sh debian/arsse.init |
|||
sed -i -se 's/^\([ \t]*chown\) arsse:arsse /\1 www-data:www-data /' debian/arsse.init |
|||
# Change the user and group references in tmpfiles |
|||
cp dist/tmpfiles.conf debian/arsse.tmpfiles |
|||
sed -i -se 's/ arsse / www-data /' debian/arsse.tmpfiles |
|||
sed -i -se 's/ arsse / www-data /' debian/arsse.tmpfiles |
|||
# Change the user reference in the executable file |
|||
mkdir -p debian/bin |
|||
cp dist/arsse debian/bin/arsse |
|||
sed -i -se 's/posix_getpwnam("arsse"/posix_getpwnam("www-data"/' debian/bin/arsse |
|||
# Change PHP-FPM socket paths |
|||
cp -r dist/apache dist/nginx debian |
|||
sed -i -se 's/arsse\.sock/php-fpm.sock/' debian/apache/arsse.conf debian/nginx/arsse.conf |
|||
@ -0,0 +1 @@ |
|||
3.0 (quilt) |
|||
@ -0,0 +1,2 @@ |
|||
# Development environment is slightly out of date |
|||
newer-standards-version |
|||
@ -0,0 +1,78 @@ |
|||
#!/bin/sh |
|||
|
|||
### BEGIN INIT INFO |
|||
# Provides: arsse |
|||
# Required-Start: $local_fs $network |
|||
# Required-Stop: $local_fs postgresql mysql |
|||
# Should-Start: postgresql mysql |
|||
# Should-Stop: postgresql mysql |
|||
# Default-Start: 2 3 4 5 |
|||
# Default-Stop: 0 1 6 |
|||
# Short-Description: The Advanced RSS Environment |
|||
# Description: The Arsse is a multi-protocol Web newsfeed synchronization service |
|||
### END INIT INFO |
|||
|
|||
# This script is designed for Debian; some adaptation will be required for other systems |
|||
|
|||
PATH=/usr/sbin/:/usr/bin:/sbin:/bin |
|||
NAME=arsse |
|||
DESC="newsfeed synchronization server" |
|||
PIDFILE=/run/arsse.pid |
|||
DAEMON=/usr/bin/$NAME |
|||
|
|||
. /lib/init/vars.sh |
|||
. /lib/lsb/init-functions |
|||
|
|||
arsse_start() { |
|||
touch "$PIDFILE" |
|||
chown arsse:arsse "$PIDFILE" |
|||
$DAEMON daemon --fork="$PIDFILE" || return 2 |
|||
} |
|||
|
|||
arsse_stop() { |
|||
killproc -p "$PIDFILE" "$DAEMON" |
|||
} |
|||
|
|||
arsse_reload() { |
|||
killproc -p "$PIDFILE" "$DAEMON" HUP |
|||
} |
|||
|
|||
case "$1" in |
|||
start) |
|||
log_daemon_msg "Starting $DESC" "$NAME" |
|||
if pidofproc -p $PIDFILE "$DAEMON" > /dev/null 2>&1 ; then |
|||
return 1 |
|||
fi |
|||
arsse_start |
|||
;; |
|||
stop) |
|||
log_daemon_msg "Stopping $DESC" "$NAME" |
|||
arsse_stop |
|||
;; |
|||
restart) |
|||
log_daemon_msg "Restarting $DESC" "$NAME" |
|||
if pidofproc -p $PIDFILE "$DAEMON" > /dev/null 2>&1 ; then |
|||
arsse_stop |
|||
fi |
|||
arsse_start |
|||
;; |
|||
try-restart) |
|||
if pidofproc -p $PIDFILE "$DAEMON" > /dev/null 2>&1 ; then |
|||
log_daemon_msg "Restarting $DESC" "$NAME" |
|||
arsse_stop |
|||
arsse_start |
|||
fi |
|||
;; |
|||
reload|force-reload) |
|||
log_daemon_msg "Reloading $DESC" "$NAME" |
|||
arsse_reload |
|||
;; |
|||
status) |
|||
status_of_proc -p $PIDFILE $DAEMON $NAME |
|||
exit $? |
|||
;; |
|||
*) |
|||
echo "Usage: $0 {start|stop|restart|try-restart|reload|status}" >&2 |
|||
exit 3 |
|||
;; |
|||
esac |
|||
@ -1,58 +0,0 @@ |
|||
server { |
|||
server_name example.com; |
|||
listen 80; # adding HTTPS configuration is highly recommended |
|||
root /usr/share/arsse/www; # adjust according to your installation path |
|||
|
|||
location / { |
|||
try_files $uri $uri/ =404; |
|||
} |
|||
|
|||
location @arsse { |
|||
fastcgi_pass unix:/var/run/php/php7.2-fpm.sock; # adjust according to your system configuration |
|||
fastcgi_pass_header Authorization; # required if the Arsse is to perform its own HTTP authentication |
|||
fastcgi_pass_request_body on; |
|||
fastcgi_pass_request_headers on; |
|||
fastcgi_intercept_errors off; |
|||
fastcgi_buffering off; |
|||
fastcgi_param SCRIPT_FILENAME /usr/share/arsse/arsse.php; # adjust according to your installation path |
|||
fastcgi_param REQUEST_METHOD $request_method; |
|||
fastcgi_param CONTENT_TYPE $content_type; |
|||
fastcgi_param CONTENT_LENGTH $content_length; |
|||
fastcgi_param REQUEST_URI $uri; |
|||
fastcgi_param QUERY_STRING $query_string; |
|||
fastcgi_param HTTPS $https if_not_empty; |
|||
fastcgi_param REMOTE_USER $remote_user; |
|||
} |
|||
|
|||
# Nextcloud News protocol |
|||
location /index.php/apps/news/api { |
|||
try_files $uri @arsse; |
|||
|
|||
location ~ ^/index\.php/apps/news/api/?$ { |
|||
# this path should not be behind HTTP authentication |
|||
try_files $uri @arsse; |
|||
} |
|||
} |
|||
|
|||
# Tiny Tiny RSS protocol |
|||
location /tt-rss/api { |
|||
try_files $uri @arsse; |
|||
} |
|||
|
|||
# Tiny Tiny RSS feed icons |
|||
location /tt-rss/feed-icons/ { |
|||
try_files $uri @arsse; |
|||
} |
|||
|
|||
# Tiny Tiny RSS special-feed icons; these are static files |
|||
location /tt-rss/images/ { |
|||
# this path should not be behind HTTP authentication |
|||
try_files $uri =404; |
|||
} |
|||
|
|||
# Fever protocol |
|||
location /fever/ { |
|||
# this path should not be behind HTTP authentication |
|||
try_files $uri @arsse; |
|||
} |
|||
} |
|||
@ -0,0 +1,12 @@ |
|||
fastcgi_pass_header Authorization; # required if the Arsse is to perform its own HTTP authentication |
|||
fastcgi_pass_request_body on; |
|||
fastcgi_pass_request_headers on; |
|||
fastcgi_intercept_errors off; |
|||
fastcgi_buffering off; |
|||
fastcgi_param REQUEST_METHOD $request_method; |
|||
fastcgi_param CONTENT_TYPE $content_type; |
|||
fastcgi_param CONTENT_LENGTH $content_length; |
|||
fastcgi_param REQUEST_URI $uri; |
|||
fastcgi_param QUERY_STRING $query_string; |
|||
fastcgi_param HTTPS $https if_not_empty; |
|||
fastcgi_param REMOTE_USER $remote_user; |
|||
@ -0,0 +1,49 @@ |
|||
# Any provided static files |
|||
location / { |
|||
try_files $uri $uri/ =404; |
|||
} |
|||
|
|||
# Nextcloud News protocol |
|||
location /index.php/apps/news/api { |
|||
try_files $uri @arsse; |
|||
|
|||
location ~ ^/index\.php/apps/news/api/?$ { |
|||
try_files $uri @arsse_public; |
|||
} |
|||
} |
|||
|
|||
# Tiny Tiny RSS protocol |
|||
location /tt-rss/api { |
|||
try_files $uri @arsse; |
|||
} |
|||
|
|||
# Tiny Tiny RSS feed icons |
|||
location /tt-rss/feed-icons/ { |
|||
try_files $uri @arsse; |
|||
} |
|||
|
|||
# Tiny Tiny RSS special-feed icons; these are static files |
|||
location /tt-rss/images/ { |
|||
try_files $uri =404; |
|||
} |
|||
|
|||
# Fever protocol |
|||
location /fever/ { |
|||
try_files $uri @arsse; |
|||
} |
|||
|
|||
# Miniflux protocol |
|||
location /v1/ { |
|||
# If put behind HTTP authentication token login will not be possible |
|||
try_files $uri @arsse; |
|||
} |
|||
|
|||
# Miniflux version number |
|||
location /version { |
|||
try_files $uri @arsse_public; |
|||
} |
|||
|
|||
# Miniflux "health check" |
|||
location /healthcheck { |
|||
try_files $uri @arsse_public; |
|||
} |
|||
@ -0,0 +1,17 @@ |
|||
root /usr/share/arsse/www; |
|||
|
|||
location @arsse { |
|||
# HTTP authentication may be enabled for this location, though this may impact some features |
|||
fastcgi_pass unix:/var/run/php/arsse.sock; |
|||
fastcgi_param SCRIPT_FILENAME /usr/share/arsse/arsse.php; |
|||
include /etc/arsse/nginx/arsse-fcgi.conf; |
|||
} |
|||
|
|||
location @arsse_public { |
|||
# HTTP authentication should not be enabled for this location |
|||
fastcgi_pass unix:/var/run/php/arsse.sock; |
|||
fastcgi_param SCRIPT_FILENAME /usr/share/arsse/arsse.php; |
|||
include /etc/arsse/nginx/arsse-fcgi.conf; |
|||
} |
|||
|
|||
include /etc/arsse/nginx/arsse-loc.conf; |
|||
@ -0,0 +1,13 @@ |
|||
server { |
|||
server_name news.example.com; |
|||
listen 80; |
|||
listen [::]:80; |
|||
listen 443 ssl http2; |
|||
listen [::]:443 ssl http2; |
|||
|
|||
ssl_certificate /etc/letsencrypt/live/news.example.com/fullchain.pem; |
|||
ssl_certificate_key /etc/letsencrypt/live/news.example.com/privkey.pem; |
|||
ssl_trusted_certificate /etc/letsencrypt/live/news.example.com/chain.pem; |
|||
|
|||
include /etc/arsse/nginx/arsse.conf; |
|||
} |
|||
@ -0,0 +1,11 @@ |
|||
[arsse] |
|||
user = arsse |
|||
group = arsse |
|||
listen = /var/run/php/arsse.sock |
|||
listen.owner = arsse |
|||
listen.group = www-data |
|||
pm = dynamic |
|||
pm.max_children = 5 |
|||
pm.start_servers = 2 |
|||
pm.min_spare_servers = 1 |
|||
pm.max_spare_servers = 3 |
|||
@ -0,0 +1,36 @@ |
|||
[Unit] |
|||
Description=The Arsse newsfeed fetching service |
|||
Documentation=https://thearsse.com/manual/ |
|||
PartOf=arsse.service |
|||
|
|||
[Install] |
|||
WantedBy=multi-user.target |
|||
|
|||
[Service] |
|||
User=arsse |
|||
Group=arsse |
|||
Type=simple |
|||
WorkingDirectory=/usr/share/arsse |
|||
ExecStart=/usr/bin/arsse daemon |
|||
|
|||
ProtectProc=invisible |
|||
NoNewPrivileges=true |
|||
ProtectSystem=full |
|||
ProtectHome=true |
|||
StateDirectory=arsse |
|||
ConfigurationDirectory=arsse |
|||
PrivateTmp=true |
|||
PrivateDevices=true |
|||
RestrictSUIDSGID=true |
|||
StandardOutput=journal |
|||
StandardError=journal |
|||
SyslogIdentifier=arsse |
|||
Restart=on-failure |
|||
RestartPreventStatus= |
|||
|
|||
# These directives can be used for extra security, but are disabled for now for compatibility |
|||
|
|||
#ReadOnlyPaths=/ |
|||
#ReadWriePaths=/var/lib/arsse |
|||
#NoExecPaths=/ |
|||
#ExecPaths=/usr/bin/php |
|||
@ -0,0 +1,14 @@ |
|||
[Unit] |
|||
Description=The Arsse newsfeed management service |
|||
Documentation=https://thearsse.com/manual/ |
|||
Requires=arsse-fetch.service |
|||
BindsTo=php-fpm.service |
|||
After=php-fpm.service |
|||
|
|||
[Install] |
|||
WantedBy=multi-user.target |
|||
|
|||
[Service] |
|||
Type=oneshot |
|||
RemainAfterExit=true |
|||
ExecStart=/usr/bin/true |
|||
@ -0,0 +1 @@ |
|||
u arsse - "The Arsse" /var/lib/arsse - |
|||
@ -0,0 +1,4 @@ |
|||
z /usr/bin/arsse 0755 root arsse - - |
|||
z /etc/arsse/config.php 0640 root arsse - - |
|||
L /usr/share/arsse/config.php - root arsse - /etc/arsse/config.php |
|||
d /var/lib/arsse 0750 arsse arsse - - |
|||
@ -1,16 +0,0 @@ |
|||
The Arsse has the following requirements: |
|||
|
|||
- A Linux server running Nginx or Apache 2.4 |
|||
- PHP 7.1.0 or later with the following extensions: |
|||
- [intl](http://php.net/manual/en/book.intl.php), [json](http://php.net/manual/en/book.json.php), [hash](http://php.net/manual/en/book.hash.php), and [dom](http://php.net/manual/en/book.dom.php) |
|||
- [simplexml](http://php.net/manual/en/book.simplexml.php), and [iconv](http://php.net/manual/en/book.iconv.php) |
|||
- One of: |
|||
- [sqlite3](http://php.net/manual/en/book.sqlite3.php) or [pdo_sqlite](http://php.net/manual/en/ref.pdo-sqlite.php) for SQLite databases |
|||
- [pgsql](http://php.net/manual/en/book.pgsql.php) or [pdo_pgsql](http://php.net/manual/en/ref.pdo-pgsql.php) for PostgreSQL 10 or later databases |
|||
- [mysqli](http://php.net/manual/en/book.mysqli.php) or [pdo_mysql](http://php.net/manual/en/ref.pdo-mysql.php) for MySQL/Percona 8.0.11 or later databases |
|||
- [curl](http://php.net/manual/en/book.curl.php) (optional) |
|||
- Privileges either to create and run systemd services, or to run cron jobs |
|||
|
|||
Instructions for how to satisfy the PHP extension requirements for Debian systems are included in the next section. |
|||
|
|||
It is also be possible to run The Arsse on other operating systems (including Windows) and with other Web servers, but the configuration required to do so is not documented in this manual. |
|||
@ -1,41 +0,0 @@ |
|||
[TOC] |
|||
|
|||
# Downloading The Arse |
|||
|
|||
The latest version of The Arsse can be downloaded [from our Web site](https://thearsse.com/). If installing an older release from our archives, the attachments named _arsse-x.x.x.tar.gz_ should be used rather than those marked "Source Code". |
|||
|
|||
Installation from source code is also possible, but the release packages are recommended. |
|||
|
|||
# Installation |
|||
|
|||
In order for The Arsse to function correctly, [its requirements](Requirements) must first be satisfied. The process of installing the required PHP extensions differs from one system to the next, but on Debian the following series of commands should do: |
|||
|
|||
```sh |
|||
# Install PHP; this assumes the FastCGI process manager will be used |
|||
sudo apt install php-cli php-fpm |
|||
# Install the needed PHP extensions; php-curl is optional |
|||
sudo apt install php-intl php-json php-xml php-curl |
|||
# Install any one of the required database extensions |
|||
sudo apt install php-sqlite3 php-pgsql php-mysql |
|||
``` |
|||
|
|||
Then, it's a simple matter of unpacking the archive someplace (`/usr/share/arsse` is the recommended location on Debian systems, but it can be anywhere) and setting permissions: |
|||
|
|||
```sh |
|||
# Unpack the archive |
|||
sudo tar -xzf arsse-x.x.x.tar.gz -C "/usr/share" |
|||
# Make the user running the Web server the owner of the files |
|||
sudo chown -R www-data:www-data "/usr/share/arsse" |
|||
# Ensure the owner can create files such as the SQLite database |
|||
sudo chmod o+rwX "/usr/share/arsse" |
|||
``` |
|||
|
|||
# Next steps |
|||
|
|||
If using a database other than SQLite, you will likely want to [set it up](Database_Setup) before doing anything else. |
|||
|
|||
In order for the various synchronization protocols to work, a Web server [must be configured](Web_Server_Configuration), and in order for The Arsse to serve users, those users [must be created](/en/Using_The_Arsse/Managing_Users). |
|||
|
|||
You may also want to review the `config.defaults.php` file included in the download package and create [a configuration file](Configuration), though The Arsse can function even without using a configuration file. |
|||
|
|||
Finally, The Arsse's [newsfeed refreshing service](/en/Using_The_Arsse/Keeping_Newsfeeds_Up_to_Date) needs to be installed in order for news to actually be fetched from the Internet. |
|||
@ -0,0 +1,54 @@ |
|||
[TOC] |
|||
|
|||
# Downloading The Arsse |
|||
|
|||
Since version 0.9.2 The Arsse is available from the [Arch User Repository](https://aur.archlinux.org/) as packages `arsse` and `arsse-git`. The latter should normally only be used to test bug fixes. |
|||
|
|||
Generic release tarballs may also be downloaded [from our Web site](https://thearsse.com), and the `PKGBUILD` file (found under `arsse/dist/arch/`) can then be extracted alongside the tarball and used to build the `arsse` package. Installing directly from the generic release tarball without producing an Arch package is not recommended as the package-building process performs various adjustments to handle Arch peculiarities. |
|||
|
|||
# Installation |
|||
|
|||
For illustrative purposes, this document assumes the `yay` [AUR helper](https://wiki.archlinux.org/title/AUR_helpers) will be used to download, build, and install The Arsse. This section summarises the steps necessary to configure and use The Arsse after installtion: |
|||
|
|||
```sh |
|||
# Install the package |
|||
sudo yay -S arsse |
|||
# Enable the necessary PHP extensions; curl is optional but recommended; pdo_sqlite may be used instead of sqlite3, but this is not recommended |
|||
sudo sed -i -e 's/^;\(extension=\(curl\|iconv\|intl\|sqlite3\)\)$/\1/' /etc/php/php.ini |
|||
# Enable and start the necessary systemd units |
|||
sudo systemctl enable php-fpm arsse |
|||
sudo systemctl restart php-fpm arsse |
|||
``` |
|||
|
|||
Note that the above is the most concise process, not necessarily the recommended one. In particular [it is recommended](https://wiki.archlinux.org/title/PHP#Extensions) to use `/etc/php/conf.d/` to enable PHP extensions rather than editing `php.ini` as done above. |
|||
|
|||
# Web server configuration |
|||
|
|||
Sample configuration for both Nginx and Apache HTTP Server can be found in `/etc/webapps/arsse/nginx/` and `/etc/webapps/arsse/apache/`, respectively. The `example.conf` files are basic virtual host examples; the other files they include should normally be usable without modification, but may be modified if desired. |
|||
|
|||
If using Apache HTTP Server the `mod_proxy` and `mod_proxy_fcgi` modules must be enabled. This can be achieved by adding the following lines to your virtual host or global configuration: |
|||
|
|||
```apache |
|||
LoadModule proxy_module modules/mod_proxy.so |
|||
LoadModule proxy_fcgi_module modules/mod_proxy_fcgi.so |
|||
``` |
|||
|
|||
No additional set-up is required for Nginx. |
|||
|
|||
# Next steps |
|||
|
|||
If using a database other than SQLite, you will likely want to [set it up](/en/Getting_Started/Database_Setup) before doing anything else. |
|||
|
|||
In order for The Arsse to serve users, those users [must be created](/en/Using_The_Arsse/Managing_Users). |
|||
|
|||
You may also want to review the `config.defaults.php` file included in `/etc/webapps/arsse/` or consult [the documentation for the configuration file](/en/Getting_Started/Configuration), though The Arsse should function with the default configuration. |
|||
|
|||
# Upgrading |
|||
|
|||
Upgrading The Arsse is done like any other package. By default The Arsse will perform any required database schema upgrades when the new version is executed, so the service does need to be restarted: |
|||
|
|||
```sh |
|||
sudo systemctl restart arsse |
|||
``` |
|||
|
|||
Occasionally changes to Web server configuration have been required, such as when new protocols become supported; these changes are always explicit in the `UPGRADING` file. |
|||
@ -0,0 +1,72 @@ |
|||
[TOC] |
|||
|
|||
# Downloading The Arsse |
|||
|
|||
Since version 0.10.0 pre-built Debian packages for The Arsse are available from the [OpenSUSE Build Service](https://build.opensuse.org/) (OBS) under [the author's personal project repository](https://build.opensuse.org/package/show/home:JKingWeb/arsse). This is the preferred method for instaling the software and is the means documented below. |
|||
|
|||
Generic release tarballs may also be downloaded [from our Web site](https://thearsse.com), and a Debian package built manually. Installing directly from the generic release tarball without producing a Debian package is not recommended as the Debian packages make the set-up process on Debian systems significantly simpler. |
|||
|
|||
# Adding the repository |
|||
|
|||
In order to install The Arsse, the OBS repository must first be configured along with its signing key: |
|||
|
|||
```sh |
|||
# Add the key |
|||
wget -q -O - "https://download.opensuse.org/repositories/home:/JKingWeb/Debian_Unstable/Release.key" | gpg --dearmor | sudo tee "/usr/share/keyrings/arsse-obs-keyring.gpg" >/dev/null |
|||
# Add the repository |
|||
echo "deb [signed-by=/usr/share/keyrings/arsse-obs-keyring.gpg] https://download.opensuse.org/repositories/home:/JKingWeb/Debian_Unstable/ ./" | sudo tee "/etc/apt/sources.list.d/arsse-obs.list" >/dev/null |
|||
# Update APT's database |
|||
sudo apt update -qq |
|||
``` |
|||
|
|||
Please note that the "Unstable" qualifier in the repository URL is a reference to Debian's "sid" release and is not a reflection on The Arsse's stability. The repository should be suitable for any Debian version or derivative which includes a sufficiently recent version of PHP. |
|||
|
|||
# Installation |
|||
|
|||
Once the OBS repository is configured, installing The Arsse is achieved with a single command: |
|||
|
|||
```sh |
|||
sudo apt install arsse |
|||
``` |
|||
|
|||
After installation is complete The Arsse will be started automatically. |
|||
|
|||
During the installation process you will be prompted whether to allow `dbconfig-common` to configure The Arsse's database automatically. The default `sqlite3` (SQLite) option is a good choice, but `pgsql` (PostgreSQL) and `mysql` (MySQL) are possible alternatives. If you wish to [use a database other than SQLite](/en/Getting_Started/Database_Setup/index), you should install it before installing The Arsse: |
|||
|
|||
```sh |
|||
# Install PostgreSQL |
|||
sudo apt install postgresql php-pgsql |
|||
# Install MySQL |
|||
sudo apt install mysql-server php-mysql |
|||
# Install SQLite explicitly |
|||
sudo apt install php-sqlite3 |
|||
``` |
|||
|
|||
If you wish to change the database backend after having installed The Arsse, running `dpkg-reconfigure` after installing the database server can be used to achieve this: |
|||
|
|||
```sh |
|||
sudo dpkg-reconfigure arsse |
|||
``` |
|||
|
|||
# Web server configuration |
|||
|
|||
Sample configuration for both Nginx and Apache HTTP Server can be found in `/etc/arsse/nginx/` and `/etc/arsse/apache/`, respectively. The `example.conf` files are basic virtual host examples; the other files they include should normally be usable without modification, but may be modified if needed or desired. In particularly users of systems older than Debian 11 (Bullseye) or Ubuntu 20.04 (Focal Fossa) or derivatives will need to change the PHP-FPM socket path in Nginx or Apache's `arsse.conf`. |
|||
|
|||
In order to use Apache HTTP Server the FastCGI proxy module must be enabled and the server restarted: |
|||
|
|||
```sh |
|||
sudo a2enmod proxy proxy_fcgi |
|||
sudo systemctl restart apache2 |
|||
``` |
|||
|
|||
No additional set-up is required for Nginx. |
|||
|
|||
# Next steps |
|||
|
|||
In order for The Arsse to serve users, those users [must be created](/en/Using_The_Arsse/Managing_Users). |
|||
|
|||
You may also want to review the `config.defaults.php` file included in the download package and create [a configuration file](/en/Getting_Started/Configuration), though The Arsse can function even without using a configuration file. |
|||
|
|||
# Upgrading |
|||
|
|||
Upgrading The Arsse is done like any other package. Occasionally changes to Web server configuration have been required, such as when new protocols become supported; these changes are always explicit in the `UPGRADING` file. |
|||
@ -0,0 +1,53 @@ |
|||
# Downloading The Arsse |
|||
|
|||
The Arsse should run on any operating system for which PHP and a Web server are available, but only the combination of Linux, Systemd, Nginx, and PHP-FPM has been extensively tested. |
|||
|
|||
Below are very generic instructions and suggestions for installing The Arsse on systems for which pre-built packages are not available. |
|||
|
|||
# Requirements |
|||
|
|||
The Arsse has the following requirements: |
|||
|
|||
- A Web server such as: |
|||
- [Nginx](https://nginx.org) |
|||
- [Apache HTTP server](https://httpd.apache.org) 2.4 or later |
|||
- PHP 7.1.0 or later with the following extensions: |
|||
- [intl](https://php.net/manual/en/book.intl.php), [json](https://php.net/manual/en/book.json.php), [hash](https://php.net/manual/en/book.hash.php), [filter](https://php.net/manual/en/book.filter.php), and [dom](https://php.net/manual/en/book.dom.php) |
|||
- [simplexml](https://php.net/manual/en/book.simplexml.php), and [iconv](https://php.net/manual/en/book.iconv.php) |
|||
- One of: |
|||
- [sqlite3](https://php.net/manual/en/book.sqlite3.php) or [pdo_sqlite](https://php.net/manual/en/ref.pdo-sqlite.php) for SQLite databases |
|||
- [pgsql](https://php.net/manual/en/book.pgsql.php) or [pdo_pgsql](https://php.net/manual/en/ref.pdo-pgsql.php) for PostgreSQL 10 or later databases |
|||
- [mysqli](https://php.net/manual/en/book.mysqli.php) or [pdo_mysql](https://php.net/manual/en/ref.pdo-mysql.php) for MySQL/Percona 8.0.11 or later databases |
|||
- [curl](https://php.net/manual/en/book.curl.php) (optional) |
|||
- [posix](https://php.net/manual/en/book.posix.php) and [pcntl](https://php.net/manual/en/book.pcntl.php) (both optional) |
|||
- An interface between PHP and the Web server, such as [PHP-FPM](https://php.net/manual/en/install.fpm.php) |
|||
- Privileges either to create and run system services, or to run cron jobs |
|||
|
|||
# Installation |
|||
|
|||
1. Download [the latest release](https://thearsse.com/releases/current) and extract it somewhere, such as `/usr/share/arsse/` |
|||
2. [Set up your database](/en/Getting_Started/Database_Setup) |
|||
3. Create [a configuration file](/en/Getting_Started/Configuration) if needed |
|||
4. Consult the files under `dist/nginx` and `dist/apache` for sample Web server configuration |
|||
5. Consult `dist/arsse` for a sample executable script which drops privileges on POSIX systems |
|||
6. Start the newsfeed fetching service: |
|||
- Sample Systemd service files are available under `dist/systemd` |
|||
- A sample System V init script is available in `dist/init.sh` |
|||
- A persistent process can be started by running `php arsse.php daemon` |
|||
- It is also possible [to use cron](/en/Using_The_Arsse/Other_Topics.html#page_Refreshing_newsfeeds_with_a_cron_job) or a similar task-scheduling tool |
|||
7. [Create users](/en/Using_The_Arsse/Managing_Users) to grant them access |
|||
|
|||
# Upgrading |
|||
|
|||
Upgrading The Arsse is usually simple: |
|||
|
|||
1. Download the latest release |
|||
2. Check the `UPGRADING` file for any special notes |
|||
3. Stop the newsfeed refreshing service if it is running |
|||
4. Back up your configurationm and database |
|||
5. Extract the new version on top of the old one |
|||
6. Restart the newsfeed refreshing service |
|||
|
|||
By default The Arsse will perform any required database schema upgrades when the new version is executed. |
|||
|
|||
Occasionally changes to Web server configuration have been required, when new protocols become supported; such changes are always explicit in the `UPGRADING` file |
|||
@ -0,0 +1,16 @@ |
|||
# Installing from a package manager |
|||
|
|||
We currently provide a few pre-built installation packages for the following operating systems: |
|||
|
|||
- [Arch Linux and derivatives](On_Arch_Linux) |
|||
- [Debian and derivatives](On_Debian_and_Derivatives) |
|||
|
|||
These packages significantly simplify installation, though a bit of manual effort may still be required. Updating The Arsse using these packages should require no manual intervention. |
|||
|
|||
# Installing manually |
|||
|
|||
For other systems The Arsse must currently be installed manually. As each operating system is different, we can only provide very general instructions: |
|||
|
|||
- [Installing on other systems](On_Other_Systems) |
|||
|
|||
We hope to support more operating systems in the future. |
|||
@ -1,107 +0,0 @@ |
|||
[TOC] |
|||
|
|||
# Preface |
|||
|
|||
As a PHP application, The Arsse requires the aid of a Web server in order to communicate with clients. How to install and configure a Web server in general is outside the scope of this document, but this section provides examples and advice for Web server configuration specific to The Arsse. Any server capable of interfacing with PHP should work, though we have only tested Nginx and Apache 2.4. |
|||
|
|||
Samples included here only cover the bare minimum for configuring a virtual host. In particular, configuration for HTTPS (which is highly recommended) is omitted for the sake of clarity |
|||
|
|||
# Configuration for Nginx |
|||
|
|||
```nginx |
|||
server { |
|||
server_name example.com; |
|||
listen 80; # adding HTTPS configuration is highly recommended |
|||
root /usr/share/arsse/www; # adjust according to your installation path |
|||
|
|||
location / { |
|||
try_files $uri $uri/ =404; |
|||
} |
|||
|
|||
location @arsse { |
|||
fastcgi_pass unix:/var/run/php/php7.2-fpm.sock; # adjust according to your system configuration |
|||
fastcgi_pass_header Authorization; # required if the Arsse is to perform its own HTTP authentication |
|||
fastcgi_pass_request_body on; |
|||
fastcgi_pass_request_headers on; |
|||
fastcgi_intercept_errors off; |
|||
fastcgi_buffering off; |
|||
fastcgi_param SCRIPT_FILENAME /usr/share/arsse/arsse.php; # adjust according to your installation path |
|||
fastcgi_param REQUEST_METHOD $request_method; |
|||
fastcgi_param CONTENT_TYPE $content_type; |
|||
fastcgi_param CONTENT_LENGTH $content_length; |
|||
fastcgi_param REQUEST_URI $uri; |
|||
fastcgi_param QUERY_STRING $query_string; |
|||
fastcgi_param HTTPS $https if_not_empty; |
|||
fastcgi_param REMOTE_USER $remote_user; |
|||
} |
|||
|
|||
# Nextcloud News protocol |
|||
location /index.php/apps/news/api { |
|||
try_files $uri @arsse; |
|||
|
|||
location ~ ^/index\.php/apps/news/api/?$ { |
|||
# this path should not be behind HTTP authentication |
|||
try_files $uri @arsse; |
|||
} |
|||
} |
|||
|
|||
# Tiny Tiny RSS protocol |
|||
location /tt-rss/api { |
|||
try_files $uri @arsse; |
|||
} |
|||
|
|||
# Tiny Tiny RSS feed icons |
|||
location /tt-rss/feed-icons/ { |
|||
try_files $uri @arsse; |
|||
} |
|||
|
|||
# Tiny Tiny RSS special-feed icons; these are static files |
|||
location /tt-rss/images/ { |
|||
# this path should not be behind HTTP authentication |
|||
try_files $uri =404; |
|||
} |
|||
|
|||
# Fever protocol |
|||
location /fever/ { |
|||
# this path should not be behind HTTP authentication |
|||
try_files $uri @arsse; |
|||
} |
|||
} |
|||
``` |
|||
|
|||
# Configuration for Apache2 |
|||
|
|||
There are many ways for Apache to interface with PHP, but the recommended way today is to use `mod_proxy` and `mod_proxy_fcgi` to communicate with PHP-FPM. If necessary you can enable these modules on Debian systems using the following commands: |
|||
|
|||
```sh |
|||
sudo a2enmod proxy proxy_fcgi |
|||
sudo systemctl restart apache2 |
|||
``` |
|||
|
|||
Afterward the follow virtual host configuration should work, after modifying path as appropriate: |
|||
|
|||
```apache |
|||
# N.B. the unix:/var/run/php/php7.2-fpm.sock path used repeatedly below will |
|||
# vary from system to system and will be probably need to be changed |
|||
|
|||
<VirtualHost *:80> |
|||
ServerName localhost |
|||
# adjust according to your installation path |
|||
DocumentRoot /usr/share/arsse/www |
|||
|
|||
# adjust according to your installation path |
|||
ProxyFCGISetEnvIf "true" SCRIPT_FILENAME "/usr/share/arsse/arsse.php" |
|||
ProxyPreserveHost On |
|||
|
|||
# Nextcloud News v1.2, Tiny Tiny RSS API, TT-RSS newsfeed icons |
|||
<LocationMatch "(/index\.php/apps/news/api/?.+|/tt-rss/(api|feed-icons))"> |
|||
ProxyPass "unix:/var/run/php/php7.2-fpm.sock|fcgi://localhost/usr/share/arsse" |
|||
</LocationMatch> |
|||
|
|||
# Nextcloud News API detection, Fever API |
|||
<LocationMatch "(/index\.php/apps/news/api/?$|/fever)"> |
|||
# these locations should not be behind HTTP authentication |
|||
ProxyPass "unix:/var/run/php/php7.2-fpm.sock|fcgi://localhost/usr/share/arsse" |
|||
</LocationMatch> |
|||
</VirtualHost> |
|||
``` |
|||
@ -1,3 +0,0 @@ |
|||
Presently installing and setting up The Arsse is a manual process. We hope to have pre-configured installation packages available for various operating systems eventually, but for now the pages in this section should help get you up and running. |
|||
|
|||
Though The Arsse itself makes no assumptions about the operating system which hosts it, we use and have the most experience with Debian; the instructions contained here therefore are for Debian systems and will probably either not work with other systems or not be consistent with their conventions. Nevertheless, they should still serve as a useful guide. |
|||
@ -1,49 +0,0 @@ |
|||
[TOC] |
|||
|
|||
# Preface |
|||
|
|||
In normal operation The Arsse is expected to regularly check whether newsfeeds might have new articles, then fetch them and process them to present new or updated articles to clients. This can be achieved either by having The Arsse operate a persistent background process (termed a [daemon](https://en.wikipedia.org/wiki/Daemon_(computing)) or service), or by using an external scheduler to periodically perform single checks. Normally a daemon is preferred. |
|||
|
|||
There are many ways to administer daemons, and many schedulers can be used. This section outlines a few, but many other arrangements are possible. |
|||
|
|||
# As a daemon via systemd |
|||
|
|||
The Arsse includes a sample systemd service unit file which can be used to quickly get a daemon running with the following procedure: |
|||
|
|||
```sh |
|||
# Copy the service unit |
|||
sudo cp "/usr/share/arsse/dist/arsse.service" "/etc/systemd/system" |
|||
# Modify the unit file if needed |
|||
sudoedit "/etc/systemd/system/arsse.service" |
|||
# Enable and start the service |
|||
sudo systemctl enable --now arsse |
|||
``` |
|||
|
|||
The Arsse's feed updater can then be manipulated as with any other service. Consult [the `systemctl` manual](https://www.freedesktop.org/software/systemd/man/systemctl.html) for details. |
|||
|
|||
# As a cron job |
|||
|
|||
Keeping newsfeeds updated with [cron](https://en.wikipedia.org/wiki/Cron) is not difficult. Simply run the following command: |
|||
|
|||
|
|||
```sh |
|||
sudo crontab -u www-data -e |
|||
``` |
|||
|
|||
And add a line such as this one: |
|||
|
|||
``` |
|||
*/2 * * * * /usr/bin/env php /usr/share/arsse/arsse.php refresh-all |
|||
``` |
|||
|
|||
Thereafter The Arsse's will be scheduled to check newsfeeds every two minutes. Consult the manual pages for the `crontab` [format](http://man7.org/linux/man-pages/man5/crontab.5.html) and [command](http://man7.org/linux/man-pages/man1/crontab.1.html) for details. |
|||
|
|||
# Appendix: how often newsfeeds are fetched |
|||
|
|||
Though by default The Arsse will wake up every two minutes, newsfeeds are not actually downloaded so frequently. Instead, each newsfeed is assigned a time at which it should next be fetched, and once that time is reached a [conditional request](https://developer.mozilla.org/en-US/docs/Web/HTTP/Conditional_requests) is made. The interval between requests for a particular newsfeed can vary from 15 minutes to 24 hours based on multiple factors such as: |
|||
|
|||
- The length of time since the newsfeed last changed |
|||
- The interval between publishing of articles in the newsfeed |
|||
- Whether the last fetch or last several fetches resulted in error |
|||
|
|||
As a general rule, newsfeeds which change frequently are checked frequently, and those which change seldom are fetched at most daily. |
|||
@ -0,0 +1,34 @@ |
|||
[TOC] |
|||
|
|||
# Preface |
|||
|
|||
This section describes in brief some CLI commands. Please read [the general notes on the command line interface](index) before continuing. |
|||
|
|||
# Refreshing newsfeeds with a cron job |
|||
|
|||
Normally The Arsse has a systemd service which checks newsfeeds for updates and processes them into its database for the user. If for whatever reason this is not practical a [cron](https://en.wikipedia.org/wiki/Cron) job may be used instead. |
|||
|
|||
Keeping newsfeeds updated with cron is not difficult. Simply run the following command: |
|||
|
|||
|
|||
```sh |
|||
sudo crontab -u arsse -e |
|||
``` |
|||
|
|||
And add a line such as this one: |
|||
|
|||
``` |
|||
*/2 * * * * /usr/bin/arsse refresh-all |
|||
``` |
|||
|
|||
Thereafter The Arsse's will be scheduled to check newsfeeds every two minutes. Consult the manual pages for the `crontab` [format](http://man7.org/linux/man-pages/man5/crontab.5.html) and [command](http://man7.org/linux/man-pages/man1/crontab.1.html) for details. |
|||
|
|||
# How often newsfeeds are fetched |
|||
|
|||
Though by default The Arsse will wake up every two minutes, newsfeeds are not actually downloaded so frequently. Instead, each newsfeed is assigned a time at which it should next be fetched, and once that time is reached a [conditional request](https://developer.mozilla.org/en-US/docs/Web/HTTP/Conditional_requests) is made. The interval between requests for a particular newsfeed can vary from 15 minutes to 24 hours based on multiple factors such as: |
|||
|
|||
- The length of time since the newsfeed last changed |
|||
- The interval between publishing of articles in the newsfeed |
|||
- Whether the last fetch or last several fetches resulted in error |
|||
|
|||
As a general rule, newsfeeds which change frequently are checked frequently, and those which change seldom are fetched at most daily. |
|||
@ -1,12 +0,0 @@ |
|||
Upgrading The Arsse is usually simple: |
|||
|
|||
1. Download the latest release |
|||
2. Check the `UPGRADING` file for any special notes |
|||
3. Stop the newsfeed refreshing service if it is running |
|||
4. Extract the new version on top of the old one |
|||
5. Ensure permissions are still correct |
|||
6. Restart the newsfeed refreshing service |
|||
|
|||
By default The Arsse will perform any required database schema upgrades when the new version is executed, and release packages contain all newly required library dependencies. |
|||
|
|||
Occasionally changes to Web server configuration have been required, when new protocols become supported; such changes are always explicit in the `UPGRADING` file |
|||
@ -0,0 +1,60 @@ |
|||
[TOC] |
|||
|
|||
# About |
|||
|
|||
<dl> |
|||
<dt>Supported since</dt> |
|||
<dd>0.9.0</dd> |
|||
<dt>Base URL</dt> |
|||
<dd>/</dd> |
|||
<dt>API endpoint</dt> |
|||
<dd>/v1/</dd> |
|||
<dt>Specifications</dt> |
|||
<dd><a href="https://miniflux.app/docs/api.html">API Reference</a>, <a href="https://miniflux.app/docs/rules.html#filtering-rules">Filtering Rules</a></dd> |
|||
</dl> |
|||
|
|||
The Miniflux protocol is a fairly well-designed protocol supporting a wide variety of operations on newsfeeds, folders (termed "categories"), and articles; it also allows for user administration, and native OPML importing and exporting. Architecturally it is similar to the Nextcloud News protocol, but has more capabilities. |
|||
|
|||
Miniflux version 2.0.28 is emulated, though not all features are implemented |
|||
|
|||
# Missing features |
|||
|
|||
- JSON Feed format is not suported |
|||
- Various feed-related features are not supported; attempting to use them has no effect |
|||
- Rewrite rules and scraper rules |
|||
- Custom User-Agent strings |
|||
- The `disabled`, `ignore_http_cache`, and `fetch_via_proxy` flags |
|||
- Changing the URL, username, or password of a feed |
|||
- Manually refreshing feeds |
|||
- Titles and types are not available during feed discovery and are filled with generic data |
|||
- Reading time is not calculated and will always be zero |
|||
- Only the first enclosure of an article is retained |
|||
- Comment URLs of articles are not exposed |
|||
|
|||
# Differences |
|||
|
|||
- Various error codes and messages differ due to significant implementation differences |
|||
- The "All" category is treated specially (see below for details) |
|||
- Feed and category titles consisting only of whitespace are rejected along with the empty string |
|||
- Filtering rules may not function identically (see below for details) |
|||
- The `checked_at` field of feeds indicates when the feed was last updated rather than when it was last checked |
|||
- Creating a feed with the `scrape` property set to `true` might not return scraped content for the initial synchronization |
|||
- Querying articles for both read/unread and removed statuses will not return all removed articles |
|||
- Search strings will match partial words |
|||
- OPML import either succeeds or fails atomically: if one feed fails, no feeds are imported |
|||
|
|||
# Behaviour of filtering (block and keep) rules |
|||
|
|||
The Miniflux documentation gives only a brief example of a pattern for its filtering rules; the allowed syntax is described in full [in Google's documentation for RE2](https://github.com/google/re2/wiki/Syntax). Being a PHP application, The Arsse instead accepts [PCRE syntax](http://www.pcre.org/original/doc/html/pcresyntax.html) (or since PHP 7.3 [PCRE2 syntax](https://www.pcre.org/current/doc/html/pcre2syntax.html)), specifically in UTF-8 mode. Delimiters should not be included, and slashes should not be escaped; anchors may be used if desired. For example `^(?i)RE/MAX$` is a valid pattern. |
|||
|
|||
For convenience the patterns are tested after collapsing whitespace. Unlike Miniflux, The Arsse tests the patterns against an article's author-supplied categories if they do not match its title. Also unlike Miniflux, when filter rules are modified they are re-evaluated against all applicable articles immediately. |
|||
|
|||
# Special handling of the "All" category |
|||
|
|||
Nextcloud News' root folder and Tiny Tiny RSS' "Uncategorized" catgory are mapped to Miniflux's initial "All" category. This Miniflux category can be renamed, but it cannot be deleted. Attempting to do so will delete the child feeds it contains, but not the category itself. |
|||
|
|||
Because the root folder does not existing in the database as a separate entity, it will always sort first when ordering by `category_id` or `category_title`. |
|||
|
|||
# Interaction with nested categories |
|||
|
|||
Tiny Tiny RSS is unique in allowing newsfeeds to be grouped into categories nested to arbitrary depth. When newsfeeds are placed into nested categories, they simply appear in the top-level category when accessed via the Miniflux protocol. This does not affect OPML exports, where full nesting is preserved. |
|||
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
@ -0,0 +1,26 @@ |
|||
<?php |
|||
/** @license MIT |
|||
* Copyright 2017 J. King, Dustin Wilson et al. |
|||
* See LICENSE and AUTHORS files for details */ |
|||
|
|||
declare(strict_types=1); |
|||
namespace JKingWeb\Arsse\Db\PostgreSQL; |
|||
|
|||
class PDOResult extends \JKingWeb\Arsse\Db\PDOResult { |
|||
|
|||
// This method exists to transparent handle byte-array results |
|||
|
|||
public function valid() { |
|||
$this->cur = $this->set->fetch(\PDO::FETCH_ASSOC); |
|||
if ($this->cur !== false) { |
|||
foreach ($this->cur as $k => $v) { |
|||
if (is_resource($v)) { |
|||
$this->cur[$k] = stream_get_contents($v); |
|||
fclose($v); |
|||
} |
|||
} |
|||
return true; |
|||
} |
|||
return false; |
|||
} |
|||
} |
|||
@ -0,0 +1,13 @@ |
|||
<?php |
|||
/** @license MIT |
|||
* Copyright 2017 J. King, Dustin Wilson et al. |
|||
* See LICENSE and AUTHORS files for details */ |
|||
|
|||
declare(strict_types=1); |
|||
namespace JKingWeb\Arsse; |
|||
|
|||
class Factory { |
|||
public function get(string $class) { |
|||
return new $class; |
|||
} |
|||
} |
|||
@ -0,0 +1,19 @@ |
|||
<?php |
|||
/** @license MIT |
|||
* Copyright 2017 J. King, Dustin Wilson et al. |
|||
* See LICENSE and AUTHORS files for details */ |
|||
|
|||
declare(strict_types=1); |
|||
namespace JKingWeb\Arsse\REST\Miniflux; |
|||
|
|||
use JKingWeb\Arsse\Arsse; |
|||
|
|||
class ErrorResponse extends \Laminas\Diactoros\Response\JsonResponse { |
|||
public function __construct($data, int $status = 400, array $headers = [], int $encodingOptions = self::DEFAULT_JSON_FLAGS) { |
|||
assert(isset(Arsse::$lang) && Arsse::$lang instanceof \JKingWeb\Arsse\Lang, new \Exception("Language database must be initialized before use")); |
|||
$data = (array) $data; |
|||
$msg = array_shift($data); |
|||
$data = ["error_message" => Arsse::$lang->msg("API.Miniflux.Error.".$msg, $data)]; |
|||
parent::__construct($data, $status, $headers, $encodingOptions); |
|||
} |
|||
} |
|||
@ -0,0 +1,37 @@ |
|||
<?php |
|||
/** @license MIT |
|||
* Copyright 2017 J. King, Dustin Wilson et al. |
|||
* See LICENSE and AUTHORS files for details */ |
|||
|
|||
declare(strict_types=1); |
|||
namespace JKingWeb\Arsse\REST\Miniflux; |
|||
|
|||
use Psr\Http\Message\ServerRequestInterface; |
|||
use Psr\Http\Message\ResponseInterface; |
|||
use Laminas\Diactoros\Response\EmptyResponse; |
|||
use Laminas\Diactoros\Response\TextResponse; |
|||
|
|||
class Status extends \JKingWeb\Arsse\REST\AbstractHandler { |
|||
public function __construct() { |
|||
} |
|||
|
|||
public function dispatch(ServerRequestInterface $req): ResponseInterface { |
|||
$target = parse_url($req->getRequestTarget())['path'] ?? ""; |
|||
if (!in_array($target, ["/version", "/healthcheck"])) { |
|||
return new EmptyResponse(404); |
|||
} |
|||
$method = $req->getMethod(); |
|||
if ($method === "OPTIONS") { |
|||
return new EmptyResponse(204, ['Allow' => "HEAD, GET"]); |
|||
} elseif ($method !== "GET") { |
|||
return new EmptyResponse(405, ['Allow' => "HEAD, GET"]); |
|||
} |
|||
$out = ""; |
|||
if ($target === "/version") { |
|||
$out = V1::VERSION; |
|||
} elseif ($target === "/healthcheck") { |
|||
$out = "OK"; |
|||
} |
|||
return new TextResponse($out); |
|||
} |
|||
} |
|||
Some files were not shown because too many files changed in this diff
Loading…
Reference in new issue