diff --git a/.gitignore b/.gitignore index d90e245d..42f0b63a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,16 +1,25 @@ -# Temporary files and dependencies +# Temporary files + +/release/ +/documentation/ +/manual/ +/tests/coverage/ +/dist/arch/arsse/ +/dist/arch/src/ +/dist/arch/pkg/ +/dist/man/ +/arsse.db* +/config.php +/.php_cs.cache +/tests/.phpunit.result.cache + +# Dependencies /vendor/ /vendor-bin/*/vendor /node_modules -/documentation/ -/manual/ -/tests/coverage/ -/arsse.db* -/config.php -/.php_cs.cache +/yarn.lock /yarn-error.log -/tests/.phpunit.result.cache # Windows files @@ -26,7 +35,6 @@ $RECYCLE.BIN/ .DS_Store .AppleDouble .LSOverride -Icon ._* .Spotlight-V100 .Trashes @@ -37,6 +45,7 @@ Icon *.zip *.7z *.tar.gz +*.tar.xz *.tgz *.deb *.rpm diff --git a/CHANGELOG b/CHANGELOG index f679cfa1..24312f29 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,60 @@ +Version 0.10.0 (2021-07-11) +=========================== + +New features: +- Complete Unix manual page +- Support for running service as a forking daemon +- Respond to TERM and HUP signals when possible + +Changes: +- Packages for Debian and related are now available (see manual for details) + +Version 0.9.2 (2021-05-25) +========================== + +Bug fixes: +- Do not fail adding users to an empty database (regression since 0.9.0) +- Cleanly ignore unknown configuration properties +- Set access mode to rw-r---- when creating SQLite databases + +Changes: +- Packages for Arch Linux are now available (see manual for details) +- Numerous improvements to the manual + +Version 0.9.1 (2021-03-18) +========================== + +Bug fixes: +- Respond to PUT requests with 201 rather than 200 in Miniflux + +Changes: +- Correct Web server configuration in manual + +Version 0.9.0 (2021-03-06) +========================== + +New features: +- Support for the Miniflux protocol (see manual for details) +- Support for API level 15 of Tiny Tiny RSS +- Support for feed icons in Fever +- Command-line functionality for managing user metadata +- Command-line functionality for managing Miniflux login tokens + +Bug fixes: +- Further relax Fever HTTP correctness, to fix more clients +- Use icons specified in Atom feeds when available +- Do not return null as subscription unread count +- Explicitly forbid U+003A COLON and control characters in usernames, for + compatibility with RFC 7617 +- Never return 401 in response to an OPTIONS request +- Accept "t" and "f" as booleans in Tiny Tiny RSS + +Changes: +- Administrator account requirements for Nextcloud News functionality are + now enforced +- E_DEPRECATED is now suppressed for compatibility with PHP 8 until affected + dependencies can be replaced + Version 0.8.5 (2020-10-27) ========================== @@ -84,7 +141,7 @@ Bug fixes: Version 0.6.1 (2019-01-23) ========================== -Bug Fixes: +Bug fixes: - Unify SQL timeout settings - Correctly escape shell command in subprocess service driver - Correctly allow null time intervals in configuration when appropriate @@ -204,4 +261,5 @@ Bug fixes: Version 0.1.0 (2017-08-29) ========================== -Initial release +New features: +- Initial release diff --git a/README.md b/README.md index 74831aa4..d9befc72 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Information on how to install and use the software can be found in [the manual]( The main repository for The Arsse can be found at [code.mensbeam.com](https://code.mensbeam.com/MensBeam/arsse/), with a mirror also available [at GitHub](https://github.com/mensbeam/arsse/). The GitHub mirror does not accept bug reports, but the two should otherwise be equivalent. -[Composer](https://getcomposer.org/) is required to manage PHP dependencies. After cloning the repository or downloading a source code tarball, running `composer install` will download all the required dependencies, and will advise if any PHP extensions need to be installed. If not installing as a programming environment, running `composer install --no-dev` is recommended. +[Composer](https://getcomposer.org/) is required to manage PHP dependencies. After cloning the repository or downloading a source code tarball, running `composer install` will download all the required dependencies, and will advise if any PHP extensions need to be installed. If not installing as a programming environment, running `composer install -o --no-dev --no-scripts` is recommended. # Repository structure @@ -34,13 +34,15 @@ Also necessary to the functioning of the application is the `/vendor/` directory The `/locale/` and `/sql/` directories contain human-language files and database schemata, both of which are occasionally used by the application in the course of execution. The `/www/` directory serves as a document root for a few static files to be made available to users by a Web server. -The `/dist/` directory, on the other hand, contains samples of configuration for Web servers and init systems. These are not used by The Arsse itself, but are merely distributed with it for reference. +The `/dist/` directory, on the other hand, contains general and system-specific build files, and samples of configuration for Web servers and other system integration. These are not used by The Arsse itself, but are used during the process of preparing new releases for supported operating systems. ## Documentation The source text for The Arsse's manual can be found in `/docs/`, with pages written in [Markdown](https://spec.commonmark.org/current/) and converted to HTML [with Daux](#building-the-manual). If a static manual is generated its files will appear under `/manual/`. -In addition to the manual the files `/README.md` (this file), `/CHANGELOG`, `/UPGRADING`, `/LICENSE`, and `/AUTHORS` also document various things about the software, rather than the software itself. +The Arsse also has a UNIX manual page, also written in Markdown, which can be found under `/manpages/`. [Pandoc](https://pandoc.org/) is needed to convert it to the appropriate format, with the results stored under `/dist/man/`. + +In addition to the manuals the files `/README.md` (this file), `/CHANGELOG`, `/UPGRADING`, `/LICENSE`, and `/AUTHORS` also document various things about the software, rather than the software itself. ## Tests @@ -50,7 +52,7 @@ The `/tests/` directory contains everything related to automated testing. It is |--------------------|------------------------------------------------------------------------------------| | `cases/` | The test cases themselves, organized in roughly the same structure as the code | | `coverage/` | (optional) Generated code coverage reports | -| `docroot/` | Sample documents used in some tests, to be returned by the PHP's basic HTTP server | +| `docroot/` | Sample documents used in some tests, to be returned by PHP's basic HTTP server | | `lib/` | Supporting classes which do not contain test cases | | `bootstrap.php` | Bootstrap script, equivalent to `/arsse.php`, but for tests | | `phpunit.dist.xml` | PHPUnit configuration file | @@ -74,7 +76,7 @@ The `/vendor-bin/` directory houses the files needed for the tools used in The A | `/robo` | Simple wrapper for executing Robo on POSIX systems | | `/robo.bat` | Simple wrapper for executing Robo on Windows | -In addition the files `/package.json`, `/yarn.lock`, and `/postcss.config.js` as well as the `/node_modules/` directory are used by [Yarn](https://yarnpkg.com/) and [PostCSS](https://postcss.org/) when modifying the stylesheet for The Arsse's manual. +In addition the files `/package.json` and `/postcss.config.js` as well as the `/node_modules/` directory are used by [Yarn](https://yarnpkg.com/) and [PostCSS](https://postcss.org/) when modifying the stylesheet for The Arsse's manual. # Common tasks @@ -105,15 +107,20 @@ The Arsse's user manual, made using [Daux](https://daux.io/), can be compiled by The manual employs a custom theme derived from the standard Daux theme. If the standard Daux theme receives improvements, the custom theme can be rebuilt by running `./robo manual:theme`. This requires that [NodeJS](https://nodejs.org) and [Yarn](https://yarnpkg.com/) be installed, but JavaScript tools are not required to modify The Arsse itself, nor the content of the manual. +## Building the man page + +The Arsse's UNIX manual page is authored in Markdown, and must be converted to the native roff format using [Pandoc](https://pandoc.org/). This can be done by running `./robo manpage`, which will output appropriate files to `/dist/man/`. The conversion should not be done manually as there is post-processing required for optimal output. + ## Packaging a release -Producing a release package is done by running `./robo package`. This performs the following operations: +Producing release packages is done by running `./robo package`. This performs the following operations: -- Duplicates a working tree with the commit (usually a release tag) to package -- Generates the manual +- Duplicates a [Git](https://git-scm.com/) working tree with the commit (usually a release tag) to package +- Generates UNIX manual pages with [Pandoc](https://pandoc.org/) +- Generates the HTML manual - Installs runtime Composer dependencies with an optimized autoloader - Deletes numerous unneeded files - Exports the default configuration of The Arsse to a file - Compresses the remaining files into a tarball - -Due to the first step, [Git](https://git-scm.com/) is required to package a release. +- Produces a binary package for Arch Linux, if possible +- Produces source and binary packages for Debian using [pbuilder](https://pbuilder-team.pages.debian.net/pbuilder/), if possible diff --git a/RoboFile.php b/RoboFile.php index 17456c10..63e14910 100644 --- a/RoboFile.php +++ b/RoboFile.php @@ -1,11 +1,14 @@ taskExec($executor)->option("-d", "zend.assertions=1")->arg($execpath)->option("-c", $confpath)->args(array_merge($set, $args))->run(); } + protected function commitVersion(?string $commit): array { + $target = $commit ?? $this->askDefault("Reference commit:", "HEAD"); + $base = escapeshellarg(BASE); + $blackhole = $this->blackhole(); + // get useable version strings from Git + $version = trim(`git -C $base describe --tags $target $blackhole`); + if (!$version) { + throw new \Exception("Commit reference invalid"); + } + return [$target, $version]; + } + + protected function toolExists(string ...$binary): bool { + $blackhole = $this->blackhole(IS_WIN); + foreach ($binary as $bin) { + if ( + (IS_WIN && (!exec(escapeshellarg($bin)." --help $blackhole", $junk, $status) || $status)) + || (!IS_WIN && (!exec("which ".escapeshellarg($bin)." $blackhole", $junk, $status) || $status)) + ) { + return false; + } + } + return true; + } + /** Packages a given commit of the software into a release tarball * - * The version to package may be any Git tree-ish identifier: a tag, a branch, + * The commit to package may be any Git tree-ish identifier: a tag, a branch, * or any commit hash. If none is provided on the command line, Robo will prompt - * for a commit to package; the default is "head". + * for a commit to package; the default is "HEAD". * * Note that while it is possible to re-package old versions, the resultant tarball * may not be equivalent due to subsequent changes in the exclude list, or because * of new tooling. */ - public function package(string $version = null): Result { + public function packageGeneric(string $commit = null): Result { + if (!$this->toolExists("git", "pandoc")) { + throw new \Exception("Git and Pandoc are required in PATH to produce generic release tarballs"); + } // establish which commit to package - $version = $version ?? $this->askDefault("Commit to package:", "HEAD"); - $archive = BASE."arsse-$version.tar.gz"; + [$commit, $version] = $this->commitVersion($commit); + $archVersion = preg_replace('/^([^-]+)-(\d+)-(\w+)$/', "$1.r$2.$3", $version); + // name the generic release tarball + $tarball = BASE."release/$version/arsse-$version.tar.gz"; // start a collection $t = $this->collectionBuilder(); // create a temporary directory $dir = $t->tmpDir().\DIRECTORY_SEPARATOR; // create a Git worktree for the selected commit in the temp location - $t->taskExec("git worktree add ".escapeshellarg($dir)." ".escapeshellarg($version)); - // perform Composer installation in the temp location with dev dependencies - $t->taskComposerInstall()->dir($dir); - // generate the manual - $t->taskExec(escapeshellarg($dir."robo")." manual")->dir($dir); - // perform Composer installation in the temp location for final output - $t->taskComposerInstall()->dir($dir)->noDev()->optimizeAutoloader()->arg("--no-scripts"); - // delete unwanted files - $t->taskFilesystemStack()->remove([ - $dir.".git", - $dir.".gitignore", - $dir.".gitattributes", - $dir."composer.json", - $dir."composer.lock", - $dir.".php_cs.dist", - $dir."phpdoc.dist.xml", - $dir."build.xml", - $dir."RoboFile.php", - $dir."CONTRIBUTING.md", - $dir."docs", - $dir."tests", - $dir."vendor-bin", - $dir."vendor/bin", - $dir."robo", - $dir."robo.bat", - $dir."package.json", - $dir."yarn.lock", - $dir."postcss.config.js", - ]); - // generate a sample configuration file - $t->taskExec(escapeshellarg(\PHP_BINARY)." arsse.php conf save-defaults config.defaults.php")->dir($dir); - // package it all up - $t->taskPack($archive)->addDir("arsse", $dir); - // execute the collection + $result = $this->taskExec("git worktree add ".escapeshellarg($dir)." ".escapeshellarg($version))->dir(BASE)->run(); + if ($result->getExitCode() > 0) { + return $result; + } + try { + // generate the Debian changelog; this also validates our original changelog + $debianChangelog = $this->changelogDebian($this->changelogParse(file_get_contents($dir."CHANGELOG"), $version), $version); + // save commit description to VERSION file for reference + $t->addTask($this->taskWriteToFile($dir."VERSION")->text($version)); + // patch the Arch PKGBUILD file with the correct version string + $t->addTask($this->taskReplaceInFile($dir."dist/arch/PKGBUILD")->regex('/^pkgver=.*$/m')->to("pkgver=$archVersion")); + // patch the Arch PKGBUILD file with the correct source file + $t->addTask($this->taskReplaceInFile($dir."dist/arch/PKGBUILD")->regex('/^source=\("arsse-[^"]+"\)$/m')->to('source=("'.basename($tarball).'")')); + // save the Debian-format changelog + $t->addTask($this->taskWriteToFile($dir."dist/debian/changelog")->text($debianChangelog)); + // perform Composer installation in the temp location with dev dependencies + $t->addTask($this->taskComposerInstall()->arg("-q")->dir($dir)); + // generate manpages + $t->addTask($this->taskExec("./robo manpage")->dir($dir)); + // generate the HTML manual + $t->addTask($this->taskExec("./robo manual -q")->dir($dir)); + // perform Composer installation in the temp location for final output + $t->addTask($this->taskComposerInstall()->dir($dir)->noDev()->optimizeAutoloader()->arg("--no-scripts")->arg("-q")); + // delete unwanted files + $t->addTask($this->taskFilesystemStack()->remove([ + $dir.".git", + $dir.".gitignore", + $dir.".gitattributes", + $dir."dist/debian/.gitignore", + $dir."composer.json", + $dir."composer.lock", + $dir.".php_cs.dist", + $dir."phpdoc.dist.xml", + $dir."build.xml", + $dir."RoboFile.php", + $dir."CONTRIBUTING.md", + $dir."docs", + $dir."manpages", + $dir."tests", + $dir."vendor-bin", + $dir."vendor/bin", + $dir."robo", + $dir."robo.bat", + $dir."package.json", + $dir."yarn.lock", + $dir."postcss.config.js", + ])); + $t->addCode(function() use ($dir) { + // Remove files which lintian complains about; they're otherwise harmless + $files = []; + foreach (new \CallbackFilterIterator(new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($dir."vendor", \FilesystemIterator::CURRENT_AS_PATHNAME | \FilesystemIterator::SKIP_DOTS)), function($v, $k, $i) { + return preg_match('/\/\.git(?:ignore|attributes|modules)$/D', $v); + }) as $f) { + $files[] = $f; + } + return $this->taskFilesystemStack()->remove($files)->run(); + }); + // generate a sample configuration file + $t->addTask($this->taskExec(escapeshellarg(\PHP_BINARY)." arsse.php conf save-defaults config.defaults.php")->dir($dir)); + // remove any existing archive + $t->addTask($this->taskFilesystemStack()->remove($tarball)); + // package it all up + $t->addTask($this->taskFilesystemStack()->mkdir(dirname($tarball))); + $t->addTask($this->taskPack($tarball)->addDir("arsse", $dir)); + // execute the collection + $result = $t->run(); + } finally { + // remove the Git worktree + $this->taskFilesystemStack()->remove($dir)->run(); + $this->taskExec("git worktree prune")->dir(BASE)->run(); + } + return $result; + } + + /** Packages a given commit of the software into an Arch package + * + * The commit to package may be any Git tree-ish identifier: a tag, a branch, + * or any commit hash. If none is provided on the command line, Robo will prompt + * for a commit to package; the default is "HEAD". + * + * The Arch base-devel group should be installed for this. + */ + public function packageArch(string $commit = null): Result { + if (!$this->toolExists("git", "makepkg", "updpkgsums")) { + throw new \Exception("Git, makepkg, and updpkgsums are required in PATH to produce Arch packages"); + } + // establish which commit to package + [$commit, $version] = $this->commitVersion($commit); + $tarball = BASE."release/$version/arsse-$version.tar.gz"; + $dir = dirname($tarball).\DIRECTORY_SEPARATOR; + // start a collection + $t = $this->collectionBuilder(); + // build the generic release tarball if it doesn't exist + if (!file_exists($tarball)) { + $t->addTask($this->taskExec(BASE."robo package:generic $commit")); + } + // extract the PKGBUILD from the tarball + $t->addCode(function() use ($tarball, $dir) { + // because Robo doesn't support extracting a single file we have to do it ourselves + (new \Archive_Tar($tarball))->extractList("arsse/dist/arch/PKGBUILD", $dir, "arsse/dist/arch/", false); + // perform a do-nothing filesystem operation since we need a Robo task result + return $this->taskFilesystemStack()->chmod($dir."PKGBUILD", 0644)->run(); + })->completion($this->taskFilesystemStack()->remove($dir."PKGBUILD")); + // build the package + $t->addTask($this->taskExec("makepkg -Ccf")->dir($dir)); + return $t->run(); + } + + /** Packages a given commit of the software into source and binary Debian packages + * + * The commit to package may be any Git tree-ish identifier: a tag, a branch, + * or any commit hash. If none is provided on the command line, Robo will prompt + * for a commit to package; the default is "HEAD". + * + * The pbuilder tool should be installed for this. + */ + public function packageDebian(string $commit = null): Result { + if (!$this->toolExists("git", "sudo", "pbuilder")) { + throw new \Exception("Git, sudo, and pbuilder are required in PATH to produce Debian packages"); + } + // establish which commit to package + [$commit, $version] = $this->commitVersion($commit); + $tarball = BASE."release/$version/arsse-$version.tar.gz"; + // define some more variables + $tgz = BASE."release/pbuilder-arsse.tgz"; + $bind = dirname($tarball); + $script = BASE."dist/debian/pbuilder.sh"; + $user = trim(`id -un`); + $group = trim(`id -gn`); + // start a task collection + $t = $this->collectionBuilder(); + // check that the pbuilder base exists and create it if it does not + if (!file_exists($tgz)) { + $t->addTask($this->taskFilesystemStack()->mkdir(BASE."release")); + $t->addTask($this->taskExec('sudo pbuilder create --basetgz '.escapeshellarg($tgz).' --mirror http://ftp.ca.debian.org/debian/ --extrapackages "debhelper devscripts lintian"')); + } + // build the generic release tarball if it doesn't exist + if (!file_exists($tarball)) { + $t->addTask($this->taskExec(BASE."robo package:generic $commit")); + } + // build the packages + $t->addTask($this->taskExec('sudo pbuilder execute --basetgz '.escapeshellarg($tgz).' --bindmounts '.escapeshellarg($bind).' -- '.escapeshellarg($script).' '.escapeshellarg("$bind/".basename($tarball)))); + // take ownership of the output files + $t->addTask($this->taskExec("sudo chown -R $user:$group ".escapeshellarg($bind))); + return $t->run(); + } + + /** Generates all possible package types for a given commit of the software + * + * The commit to package may be any Git tree-ish identifier: a tag, a branch, + * or any commit hash. If none is provided on the command line, Robo will prompt + * for a commit to package; the default is "HEAD". + * + * Generic release tarballs will always be generated, but distribution-specific + * packages are skipped when the required tools are not available + */ + public function package(string $commit = null): Result { + if (!$this->toolExists("git")) { + throw new \Exception("Git is required in PATH to produce packages"); + } + [$commit,] = $this->commitVersion($commit); + // determine whether the distribution-specific packages can be built + $dist = [ + 'Arch' => $this->toolExists("git", "makepkg", "updpkgsums"), + 'Debian' => $this->toolExists("git", "sudo", "pbuilder"), + ]; + // start a collection + $t = $this->collectionBuilder(); + // build the generic release tarball + $t->addTask($this->taskExec(BASE."robo package:generic $commit")); + // build other packages + foreach ($dist as $distro => $run) { + if ($run) { + $subcmd = strtolower($distro); + $t->addTask($this->taskExec(BASE."robo package:$subcmd $commit")); + } + } $out = $t->run(); - // clean the Git worktree list - $this->_exec("git worktree prune"); + // note any packages which were not built + foreach ($dist as $distro => $run) { + if (!$run) { + $this->say("Packages for $distro skipped"); + } + } return $out; } @@ -229,6 +409,9 @@ class RoboFile extends \Robo\Tasks { * Daux's theme changes */ public function manualTheme(array $args): Result { + if (!$this->toolExists("yarn")) { + throw new \Exception("Yarn is required in PATH to update the Daux theme"); + } $postcss = escapeshellarg(norm(BASE."node_modules/.bin/postcss")); $themesrc = norm(BASE."docs/theme/src/").\DIRECTORY_SEPARATOR; $themeout = norm(BASE."docs/theme/arsse/").\DIRECTORY_SEPARATOR; @@ -246,4 +429,144 @@ class RoboFile extends \Robo\Tasks { // execute the collection return $t->run(); } + + /** Generates the "arsse" command's manual page (UNIX man page) + * + * This requires that the Pandoc document converter be installed and + * available in $PATH. + */ + public function manpage(): Result { + if (!$this->toolExists("pandoc")) { + throw new \Exception("Pandoc is required in PATH to generate manual pages"); + } + $t = $this->collectionBuilder(); + $man = [ + 'en' => "man1/arsse.1", + ]; + foreach ($man as $src => $out) { + $src = BASE."manpages/$src.md"; + $out = BASE."dist/man/$out"; + $t->addTask($this->taskFilesystemStack()->mkdir(dirname($out), 0755)); + $t->addTask($this->taskExec("pandoc -s -f markdown-smart -t man -o ".escapeshellarg($out)." ".escapeshellarg($src))); + $t->addTask($this->taskReplaceInFile($out)->regex('/\.\n(?!\.)/s')->to(". ")); + } + return $t->run(); + } + + protected function changelogParse(string $text, string $targetVersion): array { + $lines = preg_split('/\r?\n/', $text); + $version = ""; + $section = ""; + $out = []; + $entry = []; + $expected = ["version"]; + for ($a = 0; $a < sizeof($lines);) { + $l = rtrim($lines[$a++]); + if (in_array("version", $expected) && preg_match('/^Version (\d+(?:\.\d+)*) \(([\d\?]{4}-[\d\?]{2}-[\d\?]{2})\)\s*$/D', $l, $m)) { + $version = $m[1]; + if (!preg_match('/^\d{4}-\d{2}-\d{2}$/D', $m[2])) { + // uncertain dates are allowed only for the top version, and only if it does not match the target version (otherwise we have forgotten to set the correct date before tagging) + if (!$out && $targetVersion !== $version) { + // use today's date; local time is fine + $date = date("Y-m-d"); + } else { + throw new \Exception("CHANGELOG: Date at line $a is incomplete"); + } + } else { + $date = $m[2]; + } + if ($entry) { + $out[] = $entry; + } + $entry = ['version' => $version, 'date' => $date, 'features' => [], 'fixes' => [], 'changes' => []]; + $expected = ["separator"]; + } elseif (in_array("separator", $expected) && preg_match('/^=+/', $l)) { + $length = strlen($lines[$a - 2]); + if (strlen($l) !== $length) { + throw new \Exception("CHANGELOG: Separator at line $a is of incorrect length"); + } + $expected = ["blank line"]; + $section = ""; + } elseif (in_array("blank line", $expected) && $l === "") { + $expected = [ + '' => ["features section", "fixes section", "changes section"], + 'features' => ["fixes section", "changes section", "version"], + 'fixes' => ["changes section", "version"], + 'changes' => ["version"], + ][$section]; + $expected[] = "end-of-file"; + } elseif (in_array("features section", $expected) && $l === "New features:") { + $section = "features"; + $expected = ["item"]; + } elseif (in_array("fixes section", $expected) && $l === "Bug fixes:") { + $section = "fixes"; + $expected = ["item"]; + } elseif (in_array("changes section", $expected) && $l === "Changes:") { + $section = "changes"; + $expected = ["item"]; + } elseif (in_array("item", $expected) && preg_match('/^- (\w.*)$/D', $l, $m)) { + $entry[$section][] = $m[1]; + $expected = ["item", "continuation", "blank line"]; + } elseif (in_array("continuation", $expected) && preg_match('/^ (\w.*)$/D', $l, $m)) { + $last = sizeof($entry[$section]) - 1; + $entry[$section][$last] .= "\n".$m[1]; + } else { + if (sizeof($expected) > 1) { + throw new \Exception("CHANGELOG: Expected one of [".implode(", ", $expected)."] at line $a"); + } else { + throw new \Exception("CHANGELOG: Expected ".$expected[0]." at line $a"); + } + } + } + if (!in_array("end-of-file", $expected)) { + if (sizeof($expected) > 1) { + throw new \Exception("CHANGELOG: Expected one of [".implode(", ", $expected)."] at end of file"); + } else { + throw new \Exception("CHANGELOG: Expected ".$expected[0]." at end of file"); + } + } + $out[] = $entry; + return $out; + } + + protected function changelogDebian(array $log, string $targetVersion): string { + $latest = $log[0]['version']; + $baseVersion = preg_replace('/^(\d+(?:\.\d+)*).*/', "$1", $targetVersion); + if ($baseVersion !== $targetVersion && version_compare($latest, $baseVersion, ">")) { + // if the changelog contains an entry for a future version, change its version number to match the target version instead of using the future version + $log[0]['version'] = $targetVersion; + $log[0]['distribution'] = "UNRELEASED"; + } elseif ($baseVersion !== $targetVersion) { + // otherwise synthesize a changelog entry for the changes since the last tag + array_unshift($log, ['version' => $targetVersion, 'date' => date("Y-m-d"), 'features' => [], 'fixes' => [], 'changes' => ["Unspecified changes"], 'distribution' => "UNRELEASED"]); + } + $out = ""; + foreach ($log as $entry) { + // normalize the version string + preg_match('/^(\d+(?:\.\d+)*)(?:-(\d+)-.+)?$/D', $entry['version'], $m); + $version = $m[1]."-".($m[2] ?: "1"); + // output the entry + $out .= "arsse ($version) ".($entry['distribution'] ?? "unstable")."; urgency=low\n"; + if ($entry['features']) { + $out .= "\n"; + foreach ($entry['features'] as $item) { + $out .= " * ".trim(preg_replace("/^/m", " ", $item))."\n"; + } + } + if ($entry['fixes']) { + $out .= "\n"; + foreach ($entry['fixes'] as $item) { + $out .= " * ".trim(preg_replace("/^/m", " ", $item))."\n"; + } + } + if ($entry['changes']) { + $out .= "\n"; + foreach ($entry['changes'] as $item) { + $out .= " * ".trim(preg_replace("/^/m", " ", $item))."\n"; + } + } + $out .= "\n -- J. King ".\DateTimeImmutable::createFromFormat("Y-m-d", $entry['date'], new \DateTimeZone("UTC"))->format("D, d M Y")." 00:00:00 +0000\n\n"; + } + return $out; + } } diff --git a/UPGRADING b/UPGRADING index f18bf760..f6dcfff6 100644 --- a/UPGRADING +++ b/UPGRADING @@ -11,6 +11,23 @@ usually prudent: `composer install -o --no-dev` +Upgrading from 0.8.5 to 0.9.0 +============================= + +- The database schema has changed from rev6 to rev7; if upgrading the database + manually, apply the 6.sql file +- Web server configuration has changed to accommodate Miniflux; the following + URL paths are affected: + - /v1/ + - /version + - /healthcheck +- Icons for existing feeds in Miniflux and Fever will only appear once the + feeds in question have been fetched and parsed after upgrade. This may take + some time to occur depending on how often the feed is updated +- An administrator account is now required to refresh feeds via the + Nextcloud News protocol + + Upgrading from 0.8.4 to 0.8.5 ============================= diff --git a/arsse.php b/arsse.php index 546723b9..7e13cc39 100644 --- a/arsse.php +++ b/arsse.php @@ -13,17 +13,19 @@ require_once BASE."vendor".DIRECTORY_SEPARATOR."autoload.php"; ignore_user_abort(true); ini_set("memory_limit", "-1"); ini_set("max_execution_time", "0"); +// FIXME: This is required by a dependency of Picofeed +error_reporting(\E_ALL & ~\E_DEPRECATED); if (\PHP_SAPI === "cli") { - // initialize the CLI; this automatically handles --help and --version + // initialize the CLI; this automatically handles --help and --version else + Arsse::$obj = new Factory; $cli = new CLI; // handle other CLI requests; some do not require configuration $exitStatus = $cli->dispatch(); exit($exitStatus); } else { // load configuration - $conf = file_exists(BASE."config.php") ? new Conf(BASE."config.php") : new Conf; - Arsse::load($conf); + Arsse::bootstrap(); // handle Web requests $emitter = new \Laminas\HttpHandlerRunner\Emitter\SapiEmitter; $response = (new REST)->dispatch(); diff --git a/composer.json b/composer.json index 26bab1c8..afab259e 100644 --- a/composer.json +++ b/composer.json @@ -18,10 +18,11 @@ ], "require": { - "php": "^7.1", + "php": "^7.1 || ^8.0", "ext-intl": "*", "ext-json": "*", "ext-hash": "*", + "ext-filter": "*", "ext-dom": "*", "nicolus/picofeed": "^0.1.43", "hosteurope/password-generator": "1.*", @@ -33,6 +34,9 @@ "require-dev": { "bamarni/composer-bin-plugin": "*" }, + "suggest": { + "ext-pcntl": "To respond to signals, particular to reload configuration via SIGHUP" + }, "config": { "platform": { "php": "7.1.33" diff --git a/composer.lock b/composer.lock index 77d43df5..9f8f3712 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "9880398f241b2e782876bb510207cde7", + "content-hash": "c658930fbc56b2b2cf646e34c6a8d8d3", "packages": [ { "name": "docopt/docopt", @@ -50,6 +50,10 @@ "cli", "docs" ], + "support": { + "issues": "https://github.com/docopt/docopt.php/issues", + "source": "https://github.com/docopt/docopt.php/tree/1.0.4" + }, "time": "2019-12-03T02:48:46+00:00" }, { @@ -117,20 +121,24 @@ "rest", "web service" ], + "support": { + "issues": "https://github.com/guzzle/guzzle/issues", + "source": "https://github.com/guzzle/guzzle/tree/6.5" + }, "time": "2020-06-16T21:01:06+00:00" }, { "name": "guzzlehttp/promises", - "version": "1.4.0", + "version": "1.4.1", "source": { "type": "git", "url": "https://github.com/guzzle/promises.git", - "reference": "60d379c243457e073cff02bc323a2a86cb355631" + "reference": "8e7d04f1f6450fef59366c399cfad4b9383aa30d" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/guzzle/promises/zipball/60d379c243457e073cff02bc323a2a86cb355631", - "reference": "60d379c243457e073cff02bc323a2a86cb355631", + "url": "https://api.github.com/repos/guzzle/promises/zipball/8e7d04f1f6450fef59366c399cfad4b9383aa30d", + "reference": "8e7d04f1f6450fef59366c399cfad4b9383aa30d", "shasum": "" }, "require": { @@ -168,20 +176,24 @@ "keywords": [ "promise" ], - "time": "2020-09-30T07:37:28+00:00" + "support": { + "issues": "https://github.com/guzzle/promises/issues", + "source": "https://github.com/guzzle/promises/tree/1.4.1" + }, + "time": "2021-03-07T09:25:29+00:00" }, { "name": "guzzlehttp/psr7", - "version": "1.7.0", + "version": "1.8.2", "source": { "type": "git", "url": "https://github.com/guzzle/psr7.git", - "reference": "53330f47520498c0ae1f61f7e2c90f55690c06a3" + "reference": "dc960a912984efb74d0a90222870c72c87f10c91" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/guzzle/psr7/zipball/53330f47520498c0ae1f61f7e2c90f55690c06a3", - "reference": "53330f47520498c0ae1f61f7e2c90f55690c06a3", + "url": "https://api.github.com/repos/guzzle/psr7/zipball/dc960a912984efb74d0a90222870c72c87f10c91", + "reference": "dc960a912984efb74d0a90222870c72c87f10c91", "shasum": "" }, "require": { @@ -239,7 +251,11 @@ "uri", "url" ], - "time": "2020-09-30T07:37:11+00:00" + "support": { + "issues": "https://github.com/guzzle/psr7/issues", + "source": "https://github.com/guzzle/psr7/tree/1.8.2" + }, + "time": "2021-04-26T09:17:50+00:00" }, { "name": "hosteurope/password-generator", @@ -279,6 +295,10 @@ } ], "description": "Password generator for generating policy-compliant passwords.", + "support": { + "issues": "https://github.com/hosteurope/password-generator/issues", + "source": "https://github.com/hosteurope/password-generator/tree/master" + }, "time": "2016-12-08T09:32:12+00:00" }, { @@ -324,6 +344,10 @@ "keywords": [ "uuid" ], + "support": { + "issues": "https://github.com/JKingweb/DrUUID/issues", + "source": "https://github.com/JKingweb/DrUUID/tree/3.0.0" + }, "time": "2017-02-09T14:17:01+00:00" }, { @@ -399,6 +423,10 @@ "rfc7234", "validation" ], + "support": { + "issues": "https://github.com/Kevinrob/guzzle-cache-middleware/issues", + "source": "https://github.com/Kevinrob/guzzle-cache-middleware/tree/master" + }, "time": "2017-08-17T12:23:43+00:00" }, { @@ -484,6 +512,14 @@ "psr-17", "psr-7" ], + "support": { + "chat": "https://laminas.dev/chat", + "docs": "https://docs.laminas.dev/laminas-diactoros/", + "forum": "https://discourse.laminas.dev", + "issues": "https://github.com/laminas/laminas-diactoros/issues", + "rss": "https://github.com/laminas/laminas-diactoros/releases.atom", + "source": "https://github.com/laminas/laminas-diactoros" + }, "funding": [ { "url": "https://funding.communitybridge.org/projects/laminas-project", @@ -549,6 +585,14 @@ "psr-15", "psr-7" ], + "support": { + "chat": "https://laminas.dev/chat", + "docs": "https://docs.laminas.dev/laminas-httphandlerrunner/", + "forum": "https://discourse.laminas.dev", + "issues": "https://github.com/laminas/laminas-httphandlerrunner/issues", + "rss": "https://github.com/laminas/laminas-httphandlerrunner/releases.atom", + "source": "https://github.com/laminas/laminas-httphandlerrunner" + }, "funding": [ { "url": "https://funding.communitybridge.org/projects/laminas-project", @@ -605,6 +649,14 @@ "security", "xml" ], + "support": { + "chat": "https://laminas.dev/chat", + "docs": "https://docs.laminas.dev/laminas-xml/", + "forum": "https://discourse.laminas.dev", + "issues": "https://github.com/laminas/laminas-xml/issues", + "rss": "https://github.com/laminas/laminas-xml/releases.atom", + "source": "https://github.com/laminas/laminas-xml" + }, "time": "2019-12-31T18:05:42+00:00" }, { @@ -653,6 +705,12 @@ "laminas", "zf" ], + "support": { + "forum": "https://discourse.laminas.dev/", + "issues": "https://github.com/laminas/laminas-zendframework-bridge/issues", + "rss": "https://github.com/laminas/laminas-zendframework-bridge/releases.atom", + "source": "https://github.com/laminas/laminas-zendframework-bridge" + }, "funding": [ { "url": "https://funding.communitybridge.org/projects/laminas-project", @@ -721,6 +779,9 @@ ], "description": "RSS/Atom parsing library", "homepage": "https://github.com/nicolus/picoFeed", + "support": { + "source": "https://github.com/nicolus/picoFeed/tree/0.1.43" + }, "time": "2020-09-15T07:28:23+00:00" }, { @@ -773,6 +834,9 @@ "request", "response" ], + "support": { + "source": "https://github.com/php-fig/http-factory/tree/master" + }, "time": "2019-04-30T12:38:16+00:00" }, { @@ -823,6 +887,9 @@ "request", "response" ], + "support": { + "source": "https://github.com/php-fig/http-message/tree/master" + }, "time": "2016-08-06T14:39:51+00:00" }, { @@ -876,20 +943,24 @@ "response", "server" ], + "support": { + "issues": "https://github.com/php-fig/http-server-handler/issues", + "source": "https://github.com/php-fig/http-server-handler/tree/master" + }, "time": "2018-10-30T16:46:14+00:00" }, { "name": "psr/log", - "version": "1.1.3", + "version": "1.1.4", "source": { "type": "git", "url": "https://github.com/php-fig/log.git", - "reference": "0f73288fd15629204f9d42b7055f72dacbe811fc" + "reference": "d49695b909c3b7628b6289db5479a1c204601f11" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/php-fig/log/zipball/0f73288fd15629204f9d42b7055f72dacbe811fc", - "reference": "0f73288fd15629204f9d42b7055f72dacbe811fc", + "url": "https://api.github.com/repos/php-fig/log/zipball/d49695b909c3b7628b6289db5479a1c204601f11", + "reference": "d49695b909c3b7628b6289db5479a1c204601f11", "shasum": "" }, "require": { @@ -913,7 +984,7 @@ "authors": [ { "name": "PHP-FIG", - "homepage": "http://www.php-fig.org/" + "homepage": "https://www.php-fig.org/" } ], "description": "Common interface for logging libraries", @@ -923,7 +994,10 @@ "psr", "psr-3" ], - "time": "2020-03-23T09:12:05+00:00" + "support": { + "source": "https://github.com/php-fig/log/tree/1.1.4" + }, + "time": "2021-05-03T11:20:27+00:00" }, { "name": "ralouphie/getallheaders", @@ -963,20 +1037,24 @@ } ], "description": "A polyfill for getallheaders.", + "support": { + "issues": "https://github.com/ralouphie/getallheaders/issues", + "source": "https://github.com/ralouphie/getallheaders/tree/develop" + }, "time": "2019-03-08T08:55:37+00:00" }, { "name": "symfony/polyfill-intl-idn", - "version": "v1.20.0", + "version": "v1.23.0", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-intl-idn.git", - "reference": "3b75acd829741c768bc8b1f84eb33265e7cc5117" + "reference": "65bd267525e82759e7d8c4e8ceea44f398838e65" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-intl-idn/zipball/3b75acd829741c768bc8b1f84eb33265e7cc5117", - "reference": "3b75acd829741c768bc8b1f84eb33265e7cc5117", + "url": "https://api.github.com/repos/symfony/polyfill-intl-idn/zipball/65bd267525e82759e7d8c4e8ceea44f398838e65", + "reference": "65bd267525e82759e7d8c4e8ceea44f398838e65", "shasum": "" }, "require": { @@ -990,7 +1068,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-main": "1.20-dev" + "dev-main": "1.23-dev" }, "thanks": { "name": "symfony/polyfill", @@ -1033,6 +1111,9 @@ "portable", "shim" ], + "support": { + "source": "https://github.com/symfony/polyfill-intl-idn/tree/v1.23.0" + }, "funding": [ { "url": "https://symfony.com/sponsor", @@ -1047,20 +1128,20 @@ "type": "tidelift" } ], - "time": "2020-10-23T14:02:19+00:00" + "time": "2021-05-27T09:27:20+00:00" }, { "name": "symfony/polyfill-intl-normalizer", - "version": "v1.20.0", + "version": "v1.23.0", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-intl-normalizer.git", - "reference": "727d1096295d807c309fb01a851577302394c897" + "reference": "8590a5f561694770bdcd3f9b5c69dde6945028e8" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-intl-normalizer/zipball/727d1096295d807c309fb01a851577302394c897", - "reference": "727d1096295d807c309fb01a851577302394c897", + "url": "https://api.github.com/repos/symfony/polyfill-intl-normalizer/zipball/8590a5f561694770bdcd3f9b5c69dde6945028e8", + "reference": "8590a5f561694770bdcd3f9b5c69dde6945028e8", "shasum": "" }, "require": { @@ -1072,7 +1153,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-main": "1.20-dev" + "dev-main": "1.23-dev" }, "thanks": { "name": "symfony/polyfill", @@ -1114,6 +1195,9 @@ "portable", "shim" ], + "support": { + "source": "https://github.com/symfony/polyfill-intl-normalizer/tree/v1.23.0" + }, "funding": [ { "url": "https://symfony.com/sponsor", @@ -1128,20 +1212,20 @@ "type": "tidelift" } ], - "time": "2020-10-23T14:02:19+00:00" + "time": "2021-02-19T12:13:01+00:00" }, { "name": "symfony/polyfill-php72", - "version": "v1.20.0", + "version": "v1.23.0", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-php72.git", - "reference": "cede45fcdfabdd6043b3592e83678e42ec69e930" + "reference": "9a142215a36a3888e30d0a9eeea9766764e96976" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-php72/zipball/cede45fcdfabdd6043b3592e83678e42ec69e930", - "reference": "cede45fcdfabdd6043b3592e83678e42ec69e930", + "url": "https://api.github.com/repos/symfony/polyfill-php72/zipball/9a142215a36a3888e30d0a9eeea9766764e96976", + "reference": "9a142215a36a3888e30d0a9eeea9766764e96976", "shasum": "" }, "require": { @@ -1150,7 +1234,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-main": "1.20-dev" + "dev-main": "1.23-dev" }, "thanks": { "name": "symfony/polyfill", @@ -1187,6 +1271,9 @@ "portable", "shim" ], + "support": { + "source": "https://github.com/symfony/polyfill-php72/tree/v1.23.0" + }, "funding": [ { "url": "https://symfony.com/sponsor", @@ -1201,7 +1288,7 @@ "type": "tidelift" } ], - "time": "2020-10-23T14:02:19+00:00" + "time": "2021-05-27T09:17:38+00:00" } ], "packages-dev": [ @@ -1249,6 +1336,10 @@ "isolation", "tool" ], + "support": { + "issues": "https://github.com/bamarni/composer-bin-plugin/issues", + "source": "https://github.com/bamarni/composer-bin-plugin/tree/master" + }, "time": "2020-05-03T08:27:20+00:00" } ], @@ -1258,15 +1349,16 @@ "prefer-stable": false, "prefer-lowest": false, "platform": { - "php": "^7.1", + "php": "^7.1 || ^8.0", "ext-intl": "*", "ext-json": "*", "ext-hash": "*", + "ext-filter": "*", "ext-dom": "*" }, "platform-dev": [], "platform-overrides": { "php": "7.1.33" }, - "plugin-api-version": "1.1.0" + "plugin-api-version": "2.1.0" } diff --git a/dist/apache.conf b/dist/apache.conf deleted file mode 100644 index 3c27b5a2..00000000 --- a/dist/apache.conf +++ /dev/null @@ -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 - - - 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 - - ProxyPass "unix:/var/run/php/php7.2-fpm.sock|fcgi://localhost/usr/share/arsse" - - - # Nextcloud News API detection, Fever API - - # these locations should not be behind HTTP authentication - ProxyPass "unix:/var/run/php/php7.2-fpm.sock|fcgi://localhost/usr/share/arsse" - - diff --git a/dist/apache/arsse-loc.conf b/dist/apache/arsse-loc.conf new file mode 100644 index 00000000..611c1fc6 --- /dev/null +++ b/dist/apache/arsse-loc.conf @@ -0,0 +1,34 @@ +# Nextcloud News protocol + + ProxyPass ${ARSSE_PROXY} + + +# Tiny Tiny RSS protocol + + ProxyPass ${ARSSE_PROXY} + + +# Tiny Tiny RSS feed icons + + ProxyPass ${ARSSE_PROXY} + + +# Fever protocol + + ProxyPass ${ARSSE_PROXY} + + +# Miniflux protocol + + ProxyPass ${ARSSE_PROXY} + + +# Miniflux version number + + ProxyPass ${ARSSE_PROXY} + + +# Miniflux "health check" + + ProxyPass ${ARSSE_PROXY} + diff --git a/dist/apache/arsse.conf b/dist/apache/arsse.conf new file mode 100644 index 00000000..b16c80e8 --- /dev/null +++ b/dist/apache/arsse.conf @@ -0,0 +1,11 @@ +DocumentRoot "/usr/share/arsse/www" + + Require all granted + + +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" diff --git a/dist/apache/example.conf b/dist/apache/example.conf new file mode 100644 index 00000000..0e1f356f --- /dev/null +++ b/dist/apache/example.conf @@ -0,0 +1,9 @@ + + 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" + diff --git a/dist/arch/PKGBUILD b/dist/arch/PKGBUILD new file mode 100644 index 00000000..872f06b7 --- /dev/null +++ b/dist/arch/PKGBUILD @@ -0,0 +1,57 @@ +# Maintainer: J. King +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" +} diff --git a/dist/arch/PKGBUILD-git b/dist/arch/PKGBUILD-git new file mode 100644 index 00000000..428456ca --- /dev/null +++ b/dist/arch/PKGBUILD-git @@ -0,0 +1,74 @@ +# Maintainer: J. King +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" +} diff --git a/dist/arsse b/dist/arsse new file mode 100644 index 00000000..987c1596 --- /dev/null +++ b/dist/arsse @@ -0,0 +1,10 @@ +#! /usr/bin/env php + "/var/lib/arsse/arsse.db", +]; diff --git a/dist/debian/arsse.config b/dist/debian/arsse.config new file mode 100644 index 00000000..6839c26b --- /dev/null +++ b/dist/debian/arsse.config @@ -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 diff --git a/dist/debian/arsse.dirs b/dist/debian/arsse.dirs new file mode 100644 index 00000000..2e135526 --- /dev/null +++ b/dist/debian/arsse.dirs @@ -0,0 +1 @@ +var/lib/arsse \ No newline at end of file diff --git a/dist/debian/arsse.install b/dist/debian/arsse.install new file mode 100644 index 00000000..b3b7ebad --- /dev/null +++ b/dist/debian/arsse.install @@ -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/ diff --git a/dist/debian/arsse.links b/dist/debian/arsse.links new file mode 100644 index 00000000..15663aad --- /dev/null +++ b/dist/debian/arsse.links @@ -0,0 +1 @@ +etc/arsse/config.php usr/share/arsse/config.php \ No newline at end of file diff --git a/dist/debian/arsse.postinst b/dist/debian/arsse.postinst new file mode 100644 index 00000000..90d4633f --- /dev/null +++ b/dist/debian/arsse.postinst @@ -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 diff --git a/dist/debian/arsse.postrm b/dist/debian/arsse.postrm new file mode 100644 index 00000000..f9c525b3 --- /dev/null +++ b/dist/debian/arsse.postrm @@ -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 diff --git a/dist/debian/arsse.prerm b/dist/debian/arsse.prerm new file mode 100644 index 00000000..c0cc81d7 --- /dev/null +++ b/dist/debian/arsse.prerm @@ -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 diff --git a/dist/debian/compat b/dist/debian/compat new file mode 100644 index 00000000..f599e28b --- /dev/null +++ b/dist/debian/compat @@ -0,0 +1 @@ +10 diff --git a/dist/debian/config.php b/dist/debian/config.php new file mode 100644 index 00000000..81f5e64f --- /dev/null +++ b/dist/debian/config.php @@ -0,0 +1,15 @@ + true, +] ++ (@include "/usr/share/arsse/dbconfig-common.php"); diff --git a/dist/debian/control b/dist/debian/control new file mode 100644 index 00000000..083c5080 --- /dev/null +++ b/dist/debian/control @@ -0,0 +1,32 @@ +Source: arsse +Maintainer: J. King +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 diff --git a/dist/debian/copyright b/dist/debian/copyright new file mode 100644 index 00000000..a3b5afa8 --- /dev/null +++ b/dist/debian/copyright @@ -0,0 +1,34 @@ +Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Upstream-Name: arsse +Upstream-Contact: J. King +Source: https://code.mensbeam.com/MensBeam/arsse/ +License: Expat + +Files: * +Copyright: 2017 J. King + 2017 Dustin Wilson +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. diff --git a/dist/debian/dbconfig-common.php b/dist/debian/dbconfig-common.php new file mode 100644 index 00000000..ee8b6745 --- /dev/null +++ b/dist/debian/dbconfig-common.php @@ -0,0 +1,44 @@ + "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 []; +} diff --git a/dist/debian/lintian-overrides b/dist/debian/lintian-overrides new file mode 100644 index 00000000..1847d9af --- /dev/null +++ b/dist/debian/lintian-overrides @@ -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 [] (http://jkingweb.ca/code/) +# We only ask dbconfig-common questions, which don't seem to require templates +no-debconf-templates diff --git a/dist/debian/pbuilder.sh b/dist/debian/pbuilder.sh new file mode 100755 index 00000000..e7f0468c --- /dev/null +++ b/dist/debian/pbuilder.sh @@ -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" \; diff --git a/dist/debian/rules b/dist/debian/rules new file mode 100755 index 00000000..18a2ae70 --- /dev/null +++ b/dist/debian/rules @@ -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 diff --git a/dist/debian/source/format b/dist/debian/source/format new file mode 100644 index 00000000..163aaf8d --- /dev/null +++ b/dist/debian/source/format @@ -0,0 +1 @@ +3.0 (quilt) diff --git a/dist/debian/source/lintian-overrides b/dist/debian/source/lintian-overrides new file mode 100644 index 00000000..ab33538b --- /dev/null +++ b/dist/debian/source/lintian-overrides @@ -0,0 +1,2 @@ +# Development environment is slightly out of date +newer-standards-version diff --git a/dist/init.sh b/dist/init.sh new file mode 100644 index 00000000..861d1279 --- /dev/null +++ b/dist/init.sh @@ -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 diff --git a/dist/nginx.conf b/dist/nginx.conf deleted file mode 100644 index c9c7845b..00000000 --- a/dist/nginx.conf +++ /dev/null @@ -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; - } -} diff --git a/dist/nginx/arsse-fcgi.conf b/dist/nginx/arsse-fcgi.conf new file mode 100644 index 00000000..eb83097f --- /dev/null +++ b/dist/nginx/arsse-fcgi.conf @@ -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; diff --git a/dist/nginx/arsse-loc.conf b/dist/nginx/arsse-loc.conf new file mode 100644 index 00000000..d7e3ec78 --- /dev/null +++ b/dist/nginx/arsse-loc.conf @@ -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; +} diff --git a/dist/nginx/arsse.conf b/dist/nginx/arsse.conf new file mode 100644 index 00000000..fe5721e8 --- /dev/null +++ b/dist/nginx/arsse.conf @@ -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; diff --git a/dist/nginx/example.conf b/dist/nginx/example.conf new file mode 100644 index 00000000..571a6385 --- /dev/null +++ b/dist/nginx/example.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; +} diff --git a/dist/php-fpm.conf b/dist/php-fpm.conf new file mode 100644 index 00000000..f1edc41c --- /dev/null +++ b/dist/php-fpm.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 diff --git a/dist/systemd/arsse-fetch.service b/dist/systemd/arsse-fetch.service new file mode 100644 index 00000000..3ae35538 --- /dev/null +++ b/dist/systemd/arsse-fetch.service @@ -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 diff --git a/dist/systemd/arsse.service b/dist/systemd/arsse.service new file mode 100644 index 00000000..99da8585 --- /dev/null +++ b/dist/systemd/arsse.service @@ -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 diff --git a/dist/sysuser.conf b/dist/sysuser.conf new file mode 100644 index 00000000..cd708c3f --- /dev/null +++ b/dist/sysuser.conf @@ -0,0 +1 @@ +u arsse - "The Arsse" /var/lib/arsse - diff --git a/dist/tmpfiles.conf b/dist/tmpfiles.conf new file mode 100644 index 00000000..f5e6ed18 --- /dev/null +++ b/dist/tmpfiles.conf @@ -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 - - diff --git a/docs/en/010_About.md b/docs/en/010_About.md index 615185f4..3ffc49bb 100644 --- a/docs/en/010_About.md +++ b/docs/en/010_About.md @@ -1,5 +1,6 @@ The Advanced RSS Environment (affectionately called "The Arsse") is a news aggregator server which implements multiple synchronization protocols. Unlike most other aggregator servers, The Arsse does not include a Web front-end (though one is planned as a separate project), and it relies on [existing protocols](Supported_Protocols) to maximize compatibility with [existing clients](Compatible_Clients). Supported protocols are: +- Miniflux - Nextcloud News - Tiny Tiny RSS - Fever diff --git a/docs/en/020_Getting_Started/010_Requirements.md b/docs/en/020_Getting_Started/010_Requirements.md deleted file mode 100644 index 7b3b6ef1..00000000 --- a/docs/en/020_Getting_Started/010_Requirements.md +++ /dev/null @@ -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. diff --git a/docs/en/020_Getting_Started/020_Download_and_Installation.md b/docs/en/020_Getting_Started/020_Download_and_Installation.md deleted file mode 100644 index ed47a7d1..00000000 --- a/docs/en/020_Getting_Started/020_Download_and_Installation.md +++ /dev/null @@ -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. diff --git a/docs/en/020_Getting_Started/020_Download_and_Installation/010_On_Arch_Linux.md b/docs/en/020_Getting_Started/020_Download_and_Installation/010_On_Arch_Linux.md new file mode 100644 index 00000000..e075c1b2 --- /dev/null +++ b/docs/en/020_Getting_Started/020_Download_and_Installation/010_On_Arch_Linux.md @@ -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. diff --git a/docs/en/020_Getting_Started/020_Download_and_Installation/020_On_Debian_and_Derivatives.md b/docs/en/020_Getting_Started/020_Download_and_Installation/020_On_Debian_and_Derivatives.md new file mode 100644 index 00000000..891bdfbc --- /dev/null +++ b/docs/en/020_Getting_Started/020_Download_and_Installation/020_On_Debian_and_Derivatives.md @@ -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. diff --git a/docs/en/020_Getting_Started/020_Download_and_Installation/999_ On_Other_Systems.md b/docs/en/020_Getting_Started/020_Download_and_Installation/999_ On_Other_Systems.md new file mode 100644 index 00000000..a496aa04 --- /dev/null +++ b/docs/en/020_Getting_Started/020_Download_and_Installation/999_ On_Other_Systems.md @@ -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 diff --git a/docs/en/020_Getting_Started/020_Download_and_Installation/index.md b/docs/en/020_Getting_Started/020_Download_and_Installation/index.md new file mode 100644 index 00000000..4ad7b147 --- /dev/null +++ b/docs/en/020_Getting_Started/020_Download_and_Installation/index.md @@ -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. diff --git a/docs/en/020_Getting_Started/030_Web_Server_Configuration.md b/docs/en/020_Getting_Started/030_Web_Server_Configuration.md deleted file mode 100644 index 679b0395..00000000 --- a/docs/en/020_Getting_Started/030_Web_Server_Configuration.md +++ /dev/null @@ -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 - - - 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 - - ProxyPass "unix:/var/run/php/php7.2-fpm.sock|fcgi://localhost/usr/share/arsse" - - - # Nextcloud News API detection, Fever API - - # these locations should not be behind HTTP authentication - ProxyPass "unix:/var/run/php/php7.2-fpm.sock|fcgi://localhost/usr/share/arsse" - - -``` diff --git a/docs/en/020_Getting_Started/040_Database_Setup/000_SQLite.md b/docs/en/020_Getting_Started/040_Database_Setup/000_SQLite.md index 91971fac..10c505fc 100644 --- a/docs/en/020_Getting_Started/040_Database_Setup/000_SQLite.md +++ b/docs/en/020_Getting_Started/040_Database_Setup/000_SQLite.md @@ -8,9 +8,17 @@
Minimum version
3.8.3
Configuration
-
General, Specific
+
General, Specific
-SQLite requires very little set-up. By default the database will be created at the root of The Arsse's program directory (e.g. `/usr/share/arsse/arsse.db`), but this can be changed with the [`dbSQLite3File` setting](/en/Getting_Started/Configuration#page_dbSQLite3File). +SQLite requires very little set-up. By default the database will be created at one of the following locations depending on installation method: -Regardless of the location chosen, The Arsse **must** be able to both read from and write to the database file, as well as create files in its directory. This is because SQLite also creates a write-ahead log file and a shared-memory file during operation. +| Installation method | Default database path | +|---------------------|------------------------------------------------------| +| Arch Linux package | `/var/lib/arsse/arsse.db` | +| Debian package | `/var/lib/dbconfig-common/sqlite3/arsse/arsse` | +| Manual installation | `arsse.db` in the The Arsse's installation directory | + +This path can be changed with the [`dbSQLite3File` setting](/en/Getting_Started/Configuration#page_dbSQLite3File). + +Regardless of the location used, The Arsse **must** be able to both read from and write to the database file, as well as create files in its directory. This is because SQLite also creates a write-ahead log file and a shared-memory file during operation. diff --git a/docs/en/020_Getting_Started/040_Database_Setup/010_PostgreSQL.md b/docs/en/020_Getting_Started/040_Database_Setup/010_PostgreSQL.md index 51272426..135fd243 100644 --- a/docs/en/020_Getting_Started/040_Database_Setup/010_PostgreSQL.md +++ b/docs/en/020_Getting_Started/040_Database_Setup/010_PostgreSQL.md @@ -8,7 +8,7 @@
Minimum version
10
Configuration
-
General, Specific
+
General, Specific
If for whatever reason an SQLite database does not suit your configuration, PostgreSQL is the best alternative. It is functionally equivalent to SQLite in every way. diff --git a/docs/en/020_Getting_Started/040_Database_Setup/020_MySQL.md b/docs/en/020_Getting_Started/040_Database_Setup/020_MySQL.md index 4676e346..1eafe1ed 100644 --- a/docs/en/020_Getting_Started/040_Database_Setup/020_MySQL.md +++ b/docs/en/020_Getting_Started/040_Database_Setup/020_MySQL.md @@ -8,7 +8,7 @@
Minimum version
8.0.11
Configuration
-
General, Specific
+
General, Specific
While MySQL can be used as a database for The Arsse, this is **not recommended** due to MySQL's technical limitations. It is fully functional, but may fail with some newsfeeds where other database systems do not. Additionally, it is particularly important before upgrading from one version of The Arsse to the next to back up your database: a failure in a database upgrade can corrupt your database much more easily than when using other database systems. diff --git a/docs/en/020_Getting_Started/050_Configuration.md b/docs/en/020_Getting_Started/050_Configuration.md index a07442c8..cb5dc26f 100644 --- a/docs/en/020_Getting_Started/050_Configuration.md +++ b/docs/en/020_Getting_Started/050_Configuration.md @@ -1,6 +1,14 @@ # The configuration file -The Arsse looks for configuration in a file named `config.php` in the directory where it is installed. For example, if The Arsse is installed at `/usr/share/arsse`, it will look for configuration in the file `/usr/share/arsse/config.php`. It is not an error for this file not to exist or to be empty: The Arsse will function with no configuration whatsoever, provided other conditions allow. +Depending on how The Arsse was installed, it will look for configuration in the following places: + +| Installation method | Default configuration file path | +|---------------------|--------------------------------------------------------| +| Arch Linux package | `/etc/webapps/arsse/config.php` | +| Debian package | `/etc/arsse/config.php` | +| Manual installation | `config.php` in the The Arsse's installation directory | + +It is not an error for this file not to exist or to be empty: The Arsse will function with no configuration whatsoever, provided other conditions allow. The configuration file is a PHP script which returns an associative array with keys and values for one or more settings. Any settings which are not specified in the configuration file will be set to their defaults. Invalid values will cause an error on start-up, while unknown keys are ignored. A basic configuration file might look like this: @@ -12,10 +20,10 @@ The configuration file is a PHP script which returns an associative array with k ]; ``` -The `config.defaults.php` file included with copies of The Arsse contains an annotated listing of every configuration setting with its default value. The settings are also documented in more detail below. - # List of all settings +The `config.defaults.php` file included with copies of The Arsse contains an annotated listing of every configuration setting with its default value. The settings are also documented in more detail below. + ## General settings ### lang @@ -321,7 +329,7 @@ It is also possible to specify the fully-qualified name of a class which impleme The interval the newsfeed fetching service observes between checks for new articles. Note that requests to foreign servers are not necessarily made at this frequency: each newsfeed is assigned its own time at which to be next retrieved. This setting instead defines the length of time the fetching service will sleep between periods of activity. -Consult "[How Often Newsfeeds Are Fetched](/en/Using_The_Arsse/Keeping_Newsfeeds_Up_to_Date#page_Appendix-how-often-newsfeeds-are-fetched)" for details on how often newsfeeds are fetched. +Consult "[How Often Newsfeeds Are Fetched](/en/Using_The_Arsse/Other_Topics#page_How_often_newsfeeds_are_fetched)" for details on newsfeed update frequency. ### serviceQueueWidth diff --git a/docs/en/020_Getting_Started/index.md b/docs/en/020_Getting_Started/index.md deleted file mode 100644 index fa592565..00000000 --- a/docs/en/020_Getting_Started/index.md +++ /dev/null @@ -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. diff --git a/docs/en/025_Using_The_Arsse/010_Managing_Users.md b/docs/en/025_Using_The_Arsse/010_Managing_Users.md index 1562768c..b5d529f3 100644 --- a/docs/en/025_Using_The_Arsse/010_Managing_Users.md +++ b/docs/en/025_Using_The_Arsse/010_Managing_Users.md @@ -9,28 +9,28 @@ This section describes in brief some CLI commands. Please read [the general note When first installed, The Arsse has no users configured. You may add users by executing the following command: ```sh -sudo -u www-data php arsse.php user add "user@example.com" "example password" +sudo arsse user add "user@example.com" "example password" ``` The password argument is optional: if no password is provided, a random one is generated and printed out: ```console -$ sudo -u www-data php arsse.php user add "jane.doe" +$ sudo arsse user add "jane.doe" Ji0ivMYqi6gKxQK1MHuE ``` # Setting and changing passwords -Setting's a user's password is practically identical to adding a password: +Setting a user's password is nearly identical to adding a user: ```sh -sudo -u www-data php arsse.php user set-pass "user@example.com" "new password" +sudo arsse user set-pass "user@example.com" "new password" ``` As when adding a user, the password argument is optional: if no password is provided, a random one is generated and printed out: ```console -$ sudo -u www-data php arsse.php user set-pass "jane.doe" +$ sudo arsse user set-pass "jane.doe" Ummn173XjbJT4J3Gnx0a ``` @@ -39,17 +39,50 @@ Ummn173XjbJT4J3Gnx0a Before a user can make use of [the Fever protocol](/en/Supported_Protocols/Fever), a Fever-specific password for that user must be set. It is _highly recommended_ that this not be the samer as the user's main password. The password can be set by adding the `--fever` option to the normal password-changing command: ```sh -sudo -u www-data php arsse.php user set-pass --fever "user@example.com" "fever password" +sudo arsse user set-pass --fever "user@example.com" "fever password" ``` As when setting a main password, the password argument is optional: if no password is provided, a random one is generated and printed out: ```console -$ sudo -u www-data php arsse.php user set-pass --fever "jane.doe" +$ sudo arsse user set-pass --fever "jane.doe" YfZJHq4fNTRUKDYhzQdR ``` +## Managing login tokens for Miniflux +[Miniflux](/en/Supported_Protocols/Miniflux) clients may optionally log in using tokens: randomly-generated strings which act as persistent passwords. For now these must be generated using the command-line interface: - +```console +$ sudo arsse token create "jane.doe" +xRK0huUE9KHNHf_x_H8JG0oRDo4t_WV44whBtr8Ckf0= +``` +Multiple tokens may be generated for use with different clients, and descriptive labels can be assigned for later identification: + +```console +$ sudo arsse token create "jane.doe" Newsflash +xRK0huUE9KHNHf_x_H8JG0oRDo4t_WV44whBtr8Ckf0= +$ sudo arsse token create "jane.doe" Reminiflux +L7asI2X_d-krinGJd1GsiRdFm2o06ZUlgD22H913hK4= +``` + +There are also commands for listing and revoking tokens. Please consult the integrated help for more details. + +# Setting and changing user metadata + +Users may also have various metadata properties set. These largely exist for compatibility with [the Miniflux protocol](/en/Supported_Protocols/Miniflux) and have no significant effect. One exception to this, however, is the `admin` flag, which signals whether the user may perform privileged operations where they exist in the supported protocols. + +The flag may be changed using the following command: + +```sh +sudo arsse user set "jane.doe" admin true +``` + +As a shortcut it is also possible to create administrators directly: + +```sh +sudo arsse user add "user@example.com" "example password" --admin +``` + +Please consult the integrated help for more details on metadata and their effects. diff --git a/docs/en/025_Using_The_Arsse/020_Importing_and_Exporting.md b/docs/en/025_Using_The_Arsse/020_Importing_and_Exporting.md index f1afb7d6..482c477f 100644 --- a/docs/en/025_Using_The_Arsse/020_Importing_and_Exporting.md +++ b/docs/en/025_Using_The_Arsse/020_Importing_and_Exporting.md @@ -9,7 +9,7 @@ This section describes in brief some CLI commands. Please read [the general note It's possible to import not only newsfeeds but also folders and Fever groups using OPML files. The process is simple: ```sh -sudo -u www-data php arsse.php import "user@example.com" "subscriptions.opml" +sudo arsse import "user@example.com" "subscriptions.opml" ``` The importer is forgiving, but some OPML files may fail, with the reason printed out. Files are either imported in total, or not at all. @@ -19,7 +19,7 @@ The importer is forgiving, but some OPML files may fail, with the reason printed It's possible to export not only newsfeeds but also folders and Fever groups to OPML files. The process is simple: ```sh -sudo -u www-data php arsse.php export "user@example.com" "subscriptions.opml" +sudo arsse export "user@example.com" "subscriptions.opml" ``` The output might look like this: @@ -46,9 +46,9 @@ Not all protocols supported by The Arsse allow modifying newsfeeds or folders, e ```sh # export your newsfeeds -sudo -u www-data php arsse.php export "user@example.com" "subscriptions.opml" +sudo arsse export "user@example.com" "subscriptions.opml" # make any changes you want in your editor of choice nano "subscriptions.opml" # re-import the modified information -sudo -u www-data php arsse.php import "user@example.com" "subscriptions.opml" --replace +sudo arsse import "user@example.com" "subscriptions.opml" --replace ``` diff --git a/docs/en/025_Using_The_Arsse/030_Keeping_Newsfeeds_Up_to_Date.md b/docs/en/025_Using_The_Arsse/030_Keeping_Newsfeeds_Up_to_Date.md deleted file mode 100644 index 837de686..00000000 --- a/docs/en/025_Using_The_Arsse/030_Keeping_Newsfeeds_Up_to_Date.md +++ /dev/null @@ -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. diff --git a/docs/en/025_Using_The_Arsse/030_Other_Topics.md b/docs/en/025_Using_The_Arsse/030_Other_Topics.md new file mode 100644 index 00000000..fcebbee9 --- /dev/null +++ b/docs/en/025_Using_The_Arsse/030_Other_Topics.md @@ -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. diff --git a/docs/en/025_Using_The_Arsse/040_Upgrading_to_a_New_Version.md b/docs/en/025_Using_The_Arsse/040_Upgrading_to_a_New_Version.md deleted file mode 100644 index 2b1afa14..00000000 --- a/docs/en/025_Using_The_Arsse/040_Upgrading_to_a_New_Version.md +++ /dev/null @@ -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 diff --git a/docs/en/025_Using_The_Arsse/index.md b/docs/en/025_Using_The_Arsse/index.md index 923d6666..475fdce8 100644 --- a/docs/en/025_Using_The_Arsse/index.md +++ b/docs/en/025_Using_The_Arsse/index.md @@ -2,19 +2,8 @@ This section details a few administrative tasks which may need to be performed after installing The Arsse. As no Web-based administrative interface is included, these tasks are generally performed via command line interface. -Though this section describes some commands briefly, complete documentation of The Arsse's command line interface is not included in this manual. Documentation for CLI commands can instead be viewed with the CLI itself by executing `php arsse.php --help`. +Though this section describes some commands briefly, complete documentation of The Arsse's command line interface is not included in this manual. Documentation for CLI commands can instead be viewed using the system manual service by executing `man arsse`. # A Note on Command Invocation -Particularly if using an SQLite database, it's important that administrative commands be executed as the same user who owns The Arsse's files. To that end the examples in this section all use the verbose formulation `sudo -u www-data php arsse.php` (with `www-data` being the user under which Web servers run in Debian), but it is possible to simplify invocation to `sudo arsse` if an executable file named `arsse` is created somewhere in the sudo path with the following content: - -```php -#! /usr/bin/env php - +
Supported since
+
0.9.0
+
Base URL
+
/
+
API endpoint
+
/v1/
+
Specifications
+
API Reference, Filtering Rules
+ + +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. diff --git a/docs/en/030_Supported_Protocols/010_Nextcloud_News.md b/docs/en/030_Supported_Protocols/010_Nextcloud_News.md index a2c34d04..17f5d2df 100644 --- a/docs/en/030_Supported_Protocols/010_Nextcloud_News.md +++ b/docs/en/030_Supported_Protocols/010_Nextcloud_News.md @@ -24,7 +24,6 @@ It allows organizing newsfeeds into single-level folders, and supports a wide ra - When marking articles as starred the feed ID is ignored, as they are not needed to establish uniqueness - The feed updater ignores the `userId` parameter: feeds in The Arsse are deduplicated, and have no owner - The `/feeds/all` route lists only feeds which should be checked for updates, and it also returns all `userId` attributes as empty strings: feeds in The Arsse are deduplicated, and have no owner -- The API's "updater" routes do not require administrator priviledges as The Arsse has no concept of user classes - The "updater" console commands mentioned in the protocol specification are not implemented, as The Arsse does not implement the required Nextcloud subsystems - The `lastLoginTimestamp` attribute of the user metadata is always the current time: The Arsse's implementation of the protocol is fully stateless - Syntactically invalid JSON input will yield a `400 Bad Request` response instead of falling back to GET parameters diff --git a/docs/en/030_Supported_Protocols/030_Fever.md b/docs/en/030_Supported_Protocols/030_Fever.md index 094a909f..438fe399 100644 --- a/docs/en/030_Supported_Protocols/030_Fever.md +++ b/docs/en/030_Supported_Protocols/030_Fever.md @@ -23,7 +23,6 @@ The Fever protocol is incomplete, unusual, _and_ a product of proprietary softwa - All feeds are considered "Kindling" - The "Hot Links" feature is not implemented; when requested, an empty array will be returned. As there is no way to classify a feed as a "Spark" in the protocol itself and no documentation exists on how link temperature was calculated, an implementation is unlikely to appear in the future -- Favicons are not currently supported; all feeds have a simple blank image as their favicon unless the client finds the icons itself # Special considerations @@ -38,7 +37,7 @@ The Fever protocol is incomplete, unusual, _and_ a product of proprietary softwa # Interaction with HTTP Authentication -We are not aware of any Fever clients which respond to HTTP authentication challenges. If the Web server or The Arsse is configured to require successful HTTP authentication, Fever clients are not likely to be able to connect properly. +Fever was not designed with HTTP authentication in mind, and few clients respond to challenges. If the Web server or The Arsse is configured to require successful HTTP authentication, most Fever clients are not likely to be able to connect properly. # Interaction with Folders diff --git a/docs/en/030_Supported_Protocols/index.md b/docs/en/030_Supported_Protocols/index.md index 7e58df6e..b9a9e47a 100644 --- a/docs/en/030_Supported_Protocols/index.md +++ b/docs/en/030_Supported_Protocols/index.md @@ -1,5 +1,6 @@ The Arsse was designed from the start as a server for multiple synchronization protocols which clients can make use of. Currently the following protocols are supported: +- [Miniflux](Miniflux) - [Nextcloud News](Nextcloud_News) - [Tiny Tiny RSS](Tiny_Tiny_RSS) - [Fever](Fever) diff --git a/docs/en/040_Compatible_Clients.md b/docs/en/040_Compatible_Clients.md index 9122387f..dcdc33c7 100644 --- a/docs/en/040_Compatible_Clients.md +++ b/docs/en/040_Compatible_Clients.md @@ -1,31 +1,89 @@ -The Arsse does not at this time have any first party clients. However, because The Arsse [supports existing protocols](/en/Supported_Protocols), most clients built for these protocols are compatible with The Arsse. Below are those that we personally know of and have tested with The Arsse. +The Arsse does not at this time have any first party clients. However, because The Arsse [supports existing protocols](/en/Supported_Protocols), most clients built for these protocols are compatible with The Arsse. Below are those that we personally know of and have tested with The Arsse, presented in alphabetical order. - + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -33,6 +91,7 @@ The Arsse does not at this time have any first party clients. However, because T + + + @@ -64,6 +125,7 @@ The Arsse does not at this time have any first party clients. However, because T + + - + + - + + @@ -109,6 +174,7 @@ The Arsse does not at this time have any first party clients. However, because T + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -139,6 +237,7 @@ The Arsse does not at this time have any first party clients. However, because T + @@ -149,6 +248,7 @@ The Arsse does not at this time have any first party clients. However, because T + @@ -159,16 +259,38 @@ The Arsse does not at this time have any first party clients. However, because T + + + + + + + + + + + + + + + + + + + + + + + - + + @@ -228,6 +354,7 @@ The Arsse does not at this time have any first party clients. However, because T + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -249,6 +429,7 @@ The Arsse does not at this time have any first party clients. However, because T + + + + + + + + + + + +
Name OSProtocolProtocol Notes
Miniflux Nextcloud News Tiny Tiny RSS Fever
Web
Desktop
Miniflux Reader✔✘✘✘Functional, but has some display glitches.
NX News✘✔✘✘Extremely basic client.
reminiflux✔✘✘✘ +

Three-pane alternative front-end for Minflux. Does not include functionality for managing feeds. Requires token authentication.

+
Tiny Tiny RSS Reader✘✘✔✘ +

+
Tiny Tiny RSS Progressive Web App✘✘✔✘ +

Does not (yet) support HTTP authentication. Does not include functionality for managing feeds.

+
Desktop
FeedReader Linux✘ ✔ ✔ ✘ -

Excellent reader; one of the best on any platform.

+

Excellent reader; discontinued in favour of NewsFlash.

Not compatible with HTTP authentication when using TT-RSS.
Liferea Linux ✘✘ ✔ ✘ @@ -44,6 +103,7 @@ The Arsse does not at this time have any first party clients. However, because T Linux, macOS ✔ ✔✔ ✘

Terminal-based client.

@@ -52,11 +112,12 @@ The Arsse does not at this time have any first party clients. However, because T
NewsFlash Linux✔ ✘ ✘ ✔ -

Successor to FeedReader.

+

Successor to FeedReader. One of the best on any platform
macOS ✘ ✘✘ ✔

Also available for iOS.

@@ -72,18 +134,20 @@ The Arsse does not at this time have any first party clients. However, because T
RSS Guard Windows, macOS, Linux✘ ✔ ✔ ✘ -

Very basic client; now discontinued.

+

Very basic client.
Tiny Tiny RSS ReaderTiny Tiny RSS Reader Windows ✘✘ ✔ ✘ @@ -93,11 +157,12 @@ The Arsse does not at this time have any first party clients. However, because T
MobileMobile
CloudNews iOS✘ ✔ ✘ ✘FeedMe Android ✘✘ ✔ ✘ @@ -119,16 +185,48 @@ The Arsse does not at this time have any first party clients. However, because T Fiery Feeds iOS ✘✘ ✔ ✔

Rentalware - For the software to be usable (you can't even add feeds otherwise) a subscription fee must be paid.

+

Support HTTP authentication with Fever.

Currently keeps showing items in the unread badge which have already been read.
GeekttrssAndroid✘✘✔✘ +

+
Microflux for MinifluxAndroid✔✘✘✘
NewsJet RSSAndroid✘✘✔✘
Newsout Android, iOS✘ ✔ ✘ ✘
Nextcloud News Android✘ ✔ ✘ ✘
OCReader Android✘ ✔ ✘ ✘Android ✘ ✘✘ ✔

Fetches favicons independently.
ReadropsAndroid✘✔✘✘
ReedAndroid✔✘✘✘ +

Binaries only available from GitHub.

+
Reeder iOS ✘ ✘✘ ✔

Also available for macOS.

@@ -178,6 +300,7 @@ The Arsse does not at this time have any first party clients. However, because T 		Tiny Tiny RSS Android ✘✘ ✔ ✘ @@ -188,6 +311,7 @@ The Arsse does not at this time have any first party clients. However, because T TTRSS-Reader Android ✘✘ ✔ ✘ @@ -199,6 +323,7 @@ The Arsse does not at this time have any first party clients. However, because T iOS ✘ ✘✘ ✔

Trialware with one-time purchase.

@@ -214,10 +339,11 @@ The Arsse does not at this time have any first party clients. However, because T
Name OSProtocolProtocol Notes
Miniflux Nextcloud News Tiny Tiny RSS FeverFeedTheMonkey Linux ✘✘ ✔ ✘ @@ -235,13 +362,66 @@ The Arsse does not at this time have any first party clients. However, because T
NewsieUbuntu TouchFuotenSailfish✘✔✘✘ +

+
KaktusSailfish, BlackBerry✘✘✔✘ +

+
MinifluttAndroid✔✘✘✘Does not display articles (see bug)
NewsieUbuntu Touch✘ ✔ ✘ ✘ -

Does not support HTTP authentication.
macOS ✘ ✘✘ ✔

Requires purchase. Presumed to work.

@@ -259,6 +440,7 @@ The Arsse does not at this time have any first party clients. However, because T 		Windows ✘ ✘✘ ✔

Requires manual configuration.

@@ -268,11 +450,23 @@ The Arsse does not at this time have any first party clients. However, because T 		tiny Reader RSS iOS ✘✘ ✔ ✘

Does not support HTTP authentication.
ttrssSailfish✘✘✔✘ +

+
diff --git a/docs/theme/arsse/arsse.css b/docs/theme/arsse/arsse.css index 94b17ab9..9971fbaa 100644 --- a/docs/theme/arsse/arsse.css +++ b/docs/theme/arsse/arsse.css @@ -1,2 +1,2 @@ /*! normalize.css v4.1.1 | MIT License | github.com/necolas/normalize.css */ -html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%;font-size:14px}body{margin:0;padding:0}article,aside,details,figcaption,figure,footer,header,main,menu,nav,section,summary{display:block}audio,canvas,progress,video{display:inline-block}audio:not([controls]){display:none;height:0}progress,sub,sup{vertical-align:baseline}.s-content pre code:after,.s-content pre code:before,[hidden],template{display:none}a{background-color:transparent;-webkit-text-decoration-skip:objects;text-decoration:none;color:#e63c2f}a:active,a:hover{outline-width:0}abbr[title]{border-bottom:none;-webkit-text-decoration:underline dotted;text-decoration:underline dotted}b,strong{font-weight:bolder}.s-content blockquote cite,dfn{font-style:italic}h1{font-size:2em;margin:.67em 0}mark{background-color:#ff0;color:#000}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative}sub{bottom:-.25em}sup{top:-.5em}img{border-style:none}svg:not(:root){overflow:hidden}code,kbd,pre,samp{font-family:monospace,monospace;font-size:1em}figure{margin:1em 40px}hr{box-sizing:content-box;height:0;clear:both;margin:1em 0;border:0;border-top:1px solid #ddd}button,input,select,textarea{font:inherit;margin:0}optgroup{font-weight:700}button,hr,input{overflow:visible}button,select{text-transform:none}[type=reset],[type=submit],button,html [type=button]{-webkit-appearance:button}[type=button]::-moz-focus-inner,[type=reset]::-moz-focus-inner,[type=submit]::-moz-focus-inner,button::-moz-focus-inner{border-style:none;padding:0}[type=button]:-moz-focusring,[type=reset]:-moz-focusring,[type=submit]:-moz-focusring,button:-moz-focusring{outline:1px dotted ButtonText}fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}legend{color:inherit;display:table;max-width:100%;white-space:normal}textarea{overflow:auto}[type=checkbox],[type=radio],legend{box-sizing:border-box;padding:0}[type=number]::-webkit-inner-spin-button,[type=number]::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}[type=search]::-webkit-search-cancel-button,[type=search]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-input-placeholder{color:inherit;opacity:.54}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}*,:after,:before{box-sizing:border-box}@media (min-width:850px){html{font-size:16px}}body,html{height:100%;background-color:#fff;color:#15284b}.Columns__left{background-color:#e8d5d3}.Columns__right__content{padding:10px;background-color:#fff}@media (max-width:768px){html:not(.no-js) .Collapsible__content{height:0;overflow:hidden;transition:height 400ms ease-in-out}}.Collapsible__trigger{margin:12px;padding:7px 10px;background-color:transparent;border:0;float:right;background-image:none;-webkit-filter:none;filter:none;box-shadow:none}.Collapsible__trigger__bar{display:block;width:18px;height:2px;margin-top:2px;margin-bottom:3px;background-color:#e8d5d3}.Collapsible__trigger:hover{background-color:#93b7bb;box-shadow:none}.Collapsible__trigger:hover .Collapsible__trigger__bar{background-color:#15284b}@media screen and (min-width:769px){body{background-color:#15284b}.Navbar{position:fixed;z-index:1030;width:100%}.Collapsible__trigger{display:none!important}.Collapsible__content{display:block!important}.Columns{height:100%}.Columns:after,.Columns:before{content:" ";display:table}.Columns:after{clear:both}.Columns__left,.Columns__right{position:relative;min-height:1px;float:left;overflow:auto;height:100%}.Columns__left{width:25%;border-right:1px solid #e7e7e9;overflow-x:hidden}.Columns__right{width:75%}.Columns__right__content{padding:0 20px 20px;min-height:100%}}.Page{max-width:860px}body{font-family:"Cabin","Trebuchet MS",-apple-system,".SFNSText-Regular","San Francisco","Roboto","Segoe UI","Helvetica Neue","Lucida Grande",Arial,sans-serif;font-feature-settings:"kern" 1;-webkit-font-kerning:normal;font-kerning:normal;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;line-height:1.618}h1,h2,h3,h4,h5,h6{font-family:"League Gothic",-apple-system,".SFNSText-Regular","San Francisco","Roboto","Segoe UI","Helvetica Neue","Lucida Grande",Arial,sans-serif}.s-content h1,.s-content h2,.s-content h3,.s-content h4,.s-content h5,.s-content h6{cursor:text;line-height:1.4em;margin:2em 0 .5em}.s-content h1 code,.s-content h1 tt,.s-content h2 code,.s-content h2 tt,.s-content h3 code,.s-content h3 tt,.s-content h4 code,.s-content h4 tt,.s-content h5 code,.s-content h5 tt,.s-content h6 code,.s-content h6 tt{font-size:inherit}.s-content h1 i,.s-content h2 i,.s-content h3 i,.s-content h4 i,.s-content h5 i,.s-content h6 i{font-size:.7em}.s-content h1 p,.s-content h2 p,.s-content h3 p,.s-content h4 p,.s-content h5 p,.s-content h6 p{margin-top:0}.s-content h1{margin-top:0;font-size:2.618rem}.s-content h2{font-size:2rem}.s-content h3{font-size:1.618rem}.s-content h4,.s-content h5,.s-content h6,.s-content small{font-size:1.309rem}.s-content a{text-decoration:underline}.s-content p{margin-bottom:1.3em}.s-content ol,.s-content ul{padding-left:2em}.s-content ul p,.s-content ul ul{margin:0}.s-content dl{padding:0}.s-content dl dt{font-weight:700;font-style:italic;padding:0;margin:15px 0 5px}.s-content dl dt:first-child{padding:0}.s-content dl dd{margin:0 0 15px;padding:0 15px}.s-content blockquote{margin:.75em 2em;padding:.5em 1em;font-style:italic;border-left:.25em solid #15284b}.s-content blockquote cite:before{content:"\2014";padding-right:.5em}.s-content table{width:100%;padding:0;margin-bottom:1em;border-collapse:separate;border-spacing:2px;border:2px solid #b3aab1}.s-content table+table{margin-top:1em}.s-content table tr{background-color:#fff;margin:0;padding:0;border-top:0}.s-content table tr:nth-child(2n){background-color:transparent}.s-content table th{font-weight:700;background:#e8d5d3}.s-content table td,.s-content table th{margin:0;padding:.5em}.s-content blockquote>:first-child,.s-content dl dd>:first-child,.s-content dl dt>:first-child,.s-content ol>:first-child,.s-content table td>:first-child,.s-content table th>:first-child,.s-content ul>:first-child{margin-top:0}.s-content blockquote>:last-child,.s-content dl dd>:last-child,.s-content dl dt>:last-child,.s-content ol>:last-child,.s-content table td>:last-child,.s-content table th>:last-child,.s-content ul>:last-child{margin-bottom:0}.s-content img{max-width:100%;display:block;margin:0 auto}.s-content code{font-family:Monaco,Menlo,Consolas,"Lucida Console","Courier New",monospace;padding-top:.1rem;padding-bottom:.1rem;background:#f9f5f4;border-radius:0;box-shadow:none;display:inline-block;padding:.5ch;border:0}.s-content code:after,.s-content code:before{letter-spacing:-.2em;content:"\00a0"}.s-content pre{background:#f5f2f0;line-height:1.5em;overflow:auto;border:0;border-radius:0;padding:.75em 20px;margin:0 -20px 20px}.s-content pre code{margin:0;padding:0;white-space:pre;box-shadow:none}.s-content pre code,.s-content pre tt{background-color:transparent;border:0}.s-content ins,.s-content u{text-decoration:none;border-bottom:1px solid #15284b}.s-content del a,.s-content ins a,.s-content u a{color:inherit}a.Link--external:after{content:" " url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAVklEQVR4Xn3PgQkAMQhDUXfqTu7kTtkpd5RA8AInfArtQ2iRXFWT2QedAfttj2FsPIOE1eCOlEuoWWjgzYaB/IkeGOrxXhqB+uA9Bfcm0lAZuh+YIeAD+cAqSz4kCMUAAAAASUVORK5CYII=)}a.Link--broken{color:red}p{margin:0 0 1em}.Button{display:inline-block;text-align:center;vertical-align:middle;touch-action:manipulation;cursor:pointer;background-image:none;border:1px solid transparent;white-space:nowrap;margin-bottom:0}.Button--small{font-size:12px;line-height:1.5;border-radius:3px}.Button--default{color:#333;background-color:#fff;border-color:#ccc}.Button--default.Button--active{color:#333;background-color:#e6e6e6;border-color:#adadad}.Brand,.Nav__item a:hover{color:#15284b;text-shadow:none}.Brand,.Navbar{background-color:#e63c2f}.Brand{display:block;padding:.75em .6em;font-size:2rem;font-family:"League Gothic",-apple-system,".SFNSText-Regular","San Francisco","Roboto","Segoe UI","Helvetica Neue","Lucida Grande",Arial,sans-serif}.Navbar{box-shadow:0 1px 5px rgba(0,0,0,.25);margin-bottom:0}.CodeToggler{padding:0 20px}.CodeToggler__text{font-size:12px;line-height:1.5;padding:6px 10px 6px 0;display:inline-block;vertical-align:middle}.no-js .CodeToggler{display:none}.Nav{margin:0;padding:0}.Nav__arrow{display:inline-block;position:relative;width:16px;margin-left:-16px}.Nav__arrow:before{position:absolute;display:block;content:"";margin:-.25em 0 0 -.4em;left:50%;top:50%;border-right:.15em solid #15284b;border-top:.15em solid #15284b;transform:rotate(45deg);transition-duration:.3s}.Nav__item,.Nav__item a{display:block}.Nav__item a{margin:0;padding:6px 15px 6px 20px;font-family:"League Gothic",-apple-system,".SFNSText-Regular","San Francisco","Roboto","Segoe UI","Helvetica Neue","Lucida Grande",Arial,sans-serif;font-weight:400;color:#15284b;text-shadow:none}.Nav__item a:hover{background-color:#93b7bb}.Nav .Nav{margin-left:15px}html:not(.no-js) .Nav .Nav{height:0;transition:height 400ms ease-in-out;overflow:hidden}.Nav .Nav .Nav__item a{margin:0 0 0 -15px;padding:3px 30px;font-family:"Cabin","Trebuchet MS",-apple-system,".SFNSText-Regular","San Francisco","Roboto","Segoe UI","Helvetica Neue","Lucida Grande",Arial,sans-serif;color:#15284b;opacity:.7}.HomepageButtons .Button--hero:hover,.Nav .Nav .Nav__item a:hover{opacity:1}.Nav .Nav .Nav__item--active a{color:#15284b}.Nav__item--active>a,.Nav__item--open>a{background-color:#93b7bb}.Nav__item--open>a>.Nav__arrow:before{margin-left:-.25em;transform:rotate(135deg)}.Page__header{margin:0 0 10px;padding:0}.Page__header:after,.Page__header:before{content:" ";display:table}.Page__header:after{clear:both}.Page__header h1{margin:0;padding:0;line-height:57px}.Page__header--separator{height:.6em}.Page__header a{text-decoration:none}.Page__header .EditOn,.Page__header .ModifiedDate{float:left;font-size:10px;color:gray}.Page__header .EditOn{float:right}.Links,.Twitter{padding:0 20px}.Links a{font-family:"League Gothic",-apple-system,".SFNSText-Regular","San Francisco","Roboto","Segoe UI","Helvetica Neue","Lucida Grande",Arial,sans-serif;font-weight:400;color:#15284b;line-height:2em}.Twitter{font:11px/18px "Helvetica Neue",Arial,sans-serif}.Twitter__button{text-decoration:none;display:inline-block;vertical-align:top;zoom:1;position:relative;height:20px;box-sizing:border-box;padding:1px 8px 1px 6px;background-color:#1b95e0;color:#fff;border-radius:3px;font-weight:500;cursor:pointer}.Twitter__button .Twitter__button__label{display:inline-block;vertical-align:top;zoom:1;margin-left:3px;white-space:nowrap}.Twitter__button svg{position:relative;top:2px;display:inline-block;width:14px;height:14px}.PoweredBy{padding:0 20px 1rem;font-size:1.309rem}.Search{position:relative}.Search__field{display:block;width:100%;height:34px;padding:6px 30px 6px 20px;color:#555;border-width:0 0 1px;border-bottom:1px solid #ccc;background:#fff;transition:border-color ease-in-out .15s}.Search__field:focus{border-color:#93b7bb;outline:0}.Search__icon{position:absolute;right:9px;top:9px;width:16px;height:16px}.Navbar .Search{float:right;margin:8px 20px}.Navbar .Search__field{box-shadow:inset 0 1px 1px rgba(0,0,0,.075);border-width:0;border-radius:4px;padding-left:10px}.TableOfContentsContainer{float:right;min-width:300px;max-width:25%;padding-left:1em}.TableOfContentsContainer__title{margin-bottom:0!important}.TableOfContentsContainer__content{border:1px solid #efefef;border-width:4px 2px 2px 6px}.TableOfContentsContainer__content>.TableOfContents>li+li{border-top:1px solid #ddd}ul.TableOfContents{font-size:1rem;padding-left:0;margin:0;list-style-type:none;border-left:6px solid #e8d5d3}ul.TableOfContents p{margin-bottom:0}ul.TableOfContents a{text-decoration:none;display:block;padding:.2em 0 .2em .75em}ul.TableOfContents .TableOfContents{padding-left:.75em}.Pager{padding-left:0;margin:1em 0;list-style:none;text-align:center}.Pager:after,.Pager:before{content:" ";display:table}.Pager,.Pager:after{clear:both}.Pager li{display:inline}.Pager li>a{display:inline-block;padding:5px 14px;background-color:#fff}.Pager li>a:focus,.Pager li>a:hover{text-decoration:none}.Pager--next>a{float:right}.Pager--prev>a{float:left}.Checkbox{position:relative;display:block;padding-left:30px;cursor:pointer}.Checkbox input{position:absolute;z-index:-1;opacity:0}.Checkbox__indicator{position:absolute;top:50%;left:0;width:20px;height:20px;margin-top:-10px;background:#e6e6e6}.Checkbox__indicator:after{position:absolute;display:none;content:""}.Checkbox input:focus~.Checkbox__indicator,.Checkbox:hover input~.Checkbox__indicator{background:#ccc}.Checkbox input:checked~.Checkbox__indicator{background:#15284b}.Checkbox input:checked~.Checkbox__indicator:after{display:block}.Checkbox input:checked:focus~.Checkbox__indicator,.Checkbox:hover input:not([disabled]):checked~.Checkbox__indicator{background:#93b7bb}.Checkbox input:disabled~.Checkbox__indicator{pointer-events:none;opacity:.6;background:#e6e6e6}.Checkbox .Checkbox__indicator:after{top:4px;left:8px;width:5px;height:10px;transform:rotate(45deg);border:solid #fff;border-width:0 2px 2px 0}.Checkbox input:disabled~.Checkbox__indicator:after{border-color:#7b7b7b}.Hidden{display:none}.Container{margin-right:auto;margin-left:auto}.Container--inner{width:80%;margin:0 auto}@media (min-width:1200px){.Container{width:1170px}}@media (min-width:992px){.Container{width:970px}}@media (min-width:769px){.Container{width:750px}}.Homepage{background-color:#fff;border-radius:0;border:0;color:#15284b;overflow:hidden;padding-bottom:0;margin-bottom:0;box-shadow:none}.HomepageTitle h2{width:80%;font-size:30px;margin:20px auto;text-align:center}.HomepageImage img{display:block;max-width:80%;margin:0 auto;height:auto}.HomepageButtons{padding:20px 0;background-color:#e8d5d3;text-align:center}.HomepageButtons:after,.HomepageButtons:before{content:" ";display:table}.HomepageButtons:after{clear:both}.HomepageButtons .Button--hero{padding:20px 30px;border-radius:0;text-shadow:none;opacity:.8;margin:0 10px;text-transform:uppercase;border:5px solid #15284b;font-family:"League Gothic",-apple-system,".SFNSText-Regular","San Francisco","Roboto","Segoe UI","Helvetica Neue","Lucida Grande",Arial,sans-serif;background-image:none;-webkit-filter:none;filter:none;box-shadow:none}@media (max-width:768px){.HomepageButtons .Button--hero{display:block;margin-bottom:10px}}.HomepageButtons .Button--hero.Button--secondary{background-color:#93b7bb;color:#15284b}.HomepageButtons .Button--hero.Button--primary{background-color:#15284b;color:#e8d5d3}.HomepageContent{background-color:#fff;padding:40px 0}.HomepageContent ol li,.HomepageContent ul li{list-style:none;margin-bottom:.5em;position:relative}.HomepageContent ol li:before,.HomepageContent ul li:before{position:absolute;top:50%;left:-1.5em;content:"";width:0;height:0;border:.5em solid transparent;border-left:.5em solid #93b7bb;float:left;display:block;margin-top:-.5em}.HomepageContent .HeroText,.HomepageFooter__links li a{font-size:16px;font-family:"League Gothic",-apple-system,".SFNSText-Regular","San Francisco","Roboto","Segoe UI","Helvetica Neue","Lucida Grande",Arial,sans-serif}.HomepageContent .HeroText{font-weight:300;margin-bottom:20px;line-height:1.4}@media (min-width:769px){.HomepageContent{padding:40px 20px}.HomepageContent .HeroText{font-size:21px}.HomepageContent .Row{margin:0 -15px}.HomepageContent .Row__half,.HomepageContent .Row__quarter,.HomepageContent .Row__third{float:left;position:relative;min-height:1px;padding-left:15px;padding-right:15px}.HomepageContent .Row__third{width:33.333333%}.HomepageContent .Row__half{width:50%}.HomepageContent .Row__quarter{width:25%}}.HomepageFooter{background-color:#15284b;color:#93b7bb;border:0;box-shadow:none}.HomepageFooter:after,.HomepageFooter:before{content:" ";display:table}.HomepageFooter:after{clear:both}@media (max-width:768px){.HomepageFooter{padding:0 20px;text-align:center}.HomepageFooter .HomepageFooter__links{padding-left:0;list-style-type:none}}@media (min-width:769px){.HomepageFooter .HomepageFooter__links{float:left}.HomepageFooter .HomepageFooter__twitter{float:right}}.HomepageFooter__links,.HomepageFooter__twitter{margin:40px 0}.HomepageFooter__links li a{line-height:32px;font-weight:700}.HomepageFooter__links li a:hover{text-decoration:underline}.HomepageFooter .Twitter__button{margin-bottom:20px}@media print{*{text-shadow:none!important;color:#000!important;background:0 0!important;box-shadow:none!important}h1,h2,h3,h4,h5,h6{page-break-after:avoid;page-break-before:auto}blockquote,img,pre{page-break-inside:avoid}blockquote,pre{border:1px solid #999;font-style:italic}img{border:0}a,a:visited{text-decoration:underline}abbr[title]:after{content:" (" attr(title) ")"}q{quotes:none}.s-content a[href^="#"]:after,q:before{content:""}q:after{content:" (" attr(cite) ")"}.PageBreak{display:block;page-break-before:always}.NoPrint,.Pager,aside{display:none}.Columns__right{width:100%!important}.s-content a:after{content:" (" attr(href) ")";font-size:80%;word-wrap:break-word}h1 a[href]:after{font-size:50%}}@font-face{font-family:'League Gothic';src:url(fonts/leaguegothic.woff2) format('woff2'),url(fonts/leaguegothic.woff) format('woff');font-style:normal;font-display:swap}@font-face{font-family:'Cabin';src:url(fonts/cabin-regular.woff2) format('woff2'),url(fonts/cabin-regular.woff) format('woff');font-weight:400;font-style:normal;font-display:swap}@font-face{font-family:'Cabin';src:url(fonts/cabin-italic.woff2) format('woff2'),url(fonts/cabin-italic.woff) format('woff');font-style:italic;font-display:swap}@font-face{font-family:'Cabin';src:url(fonts/cabin-bold.woff2) format('woff2'),url(fonts/cabin-bold.woff) format('woff');font-weight:700;font-style:normal;font-display:swap}.s-content code::after,.s-content code::before,a.Link--external::after{content:''}pre .s-content code{display:inline}.s-content table tbody,.s-content table thead{background-color:#fff}.s-content table tr:nth-child(2n) td{background-color:#f9f5f4}.s-content table td,.s-content table th{border:0}.Nav__item .Nav__item,.s-content table{font-size:1rem}.Brand,h1,h2,h3,h4,h5,h6{font-weight:400}.Button,.Pager li>a{border-radius:0}.HomepageButtons .Button--hero{font-weight:400;font-size:1.309rem}.Page__header{border-bottom:2px solid #e8d5d3}.Pager li>a{border:2px solid #e8d5d3}.Pager li>a:focus,.Pager li>a:hover{background-color:#e8d5d3}.Pager--prev a::before{content:"\2190\00a0"}.Pager--next a::after{content:"\00a0\2192"}.Navbar{height:auto;box-shadow:none}.Navbar .Brand{float:none;line-height:inherit;height:auto}.Homepage{padding-top:10px!important}.Nav__item{font-size:1.309rem}.Nav .Nav .Nav__item a .Nav__arrow:before,.Nav__arrow:before{font-family:"League Gothic",-apple-system,".SFNSText-Regular","San Francisco","Roboto","Segoe UI","Helvetica Neue","Lucida Grande",Arial,sans-serif;width:1ch;height:1ch}.TableOfContentsContainer__title{border-bottom:4px solid #e8d5d3}.Columns__right--full .TableOfContentsContainer .TableOfContentsContainer__content>.TableOfContents{border-right:2px solid #e8d5d3}.Columns__right--full .TableOfContentsContainer a{border-bottom:1px solid #e8d5d3}.clients thead tr:first-child th{text-align:left}.clients thead tr:first-child th:first-child{width:15%}.clients thead tr:first-child th:nth-child(3){width:50%;text-align:center}.clients thead tr+tr th{width:16.66%;text-align:center}.clients tbody td:nth-child(3),.clients tbody td:nth-child(4),.clients tbody td:nth-child(5){text-align:center}.clients tbody td.Y{color:#2c9a42}.clients tbody td.N{color:#e63c2f}.hljs,.s-content pre{background:#15284b;color:#e8d5d3}.hljs{display:block;overflow-x:auto;padding:.5em}.hljs-emphasis{font-style:italic}.hljs-strong{font-weight:700}.hljs-comment,.hljs-quote{color:#978e9c}.hljs-addition,.hljs-keyword,.hljs-selector-tag{color:#acb39a}.hljs-doctag,.hljs-literal,.hljs-meta .hljs-meta-string,.hljs-number,.hljs-regexp,.hljs-string{color:#93b7bb}.hljs-name,.hljs-section,.hljs-selector-class,.hljs-selector-id,.hljs-title{color:#82b7e5}.hljs-attr,.hljs-attribute,.hljs-class .hljs-title,.hljs-template-variable,.hljs-type,.hljs-variable{color:#c5b031}.hljs-bullet,.hljs-link,.hljs-meta,.hljs-meta .hljs-keyword,.hljs-selector-attr,.hljs-selector-pseudo,.hljs-subst,.hljs-symbol{color:#ea8031}.hljs-built_in,.hljs-deletion{color:#e63c2f}.hljs-formula{background:#686986}@media (min-width:850px){.Columns__left{border:0}} \ No newline at end of file +html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%;font-size:14px}body{margin:0;padding:0}article,aside,details,figcaption,figure,footer,header,main,menu,nav,section,summary{display:block}audio,canvas,progress,video{display:inline-block}audio:not([controls]){display:none;height:0}progress,sub,sup{vertical-align:baseline}.s-content pre code:after,.s-content pre code:before,[hidden],template{display:none}a{background-color:transparent;-webkit-text-decoration-skip:objects;text-decoration:none;color:#e63c2f}a:active,a:hover{outline-width:0}abbr[title]{border-bottom:none;-webkit-text-decoration:underline dotted;text-decoration:underline dotted}b,strong{font-weight:bolder}.s-content blockquote cite,dfn{font-style:italic}h1{font-size:2em;margin:.67em 0}mark{background-color:#ff0;color:#000}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative}sub{bottom:-.25em}sup{top:-.5em}img{border-style:none}svg:not(:root){overflow:hidden}code,kbd,pre,samp{font-family:monospace,monospace;font-size:1em}figure{margin:1em 40px}hr{box-sizing:content-box;height:0;clear:both;margin:1em 0;border:0;border-top:1px solid #ddd}button,input,select,textarea{font:inherit;margin:0}optgroup{font-weight:700}button,hr,input{overflow:visible}button,select{text-transform:none}[type=reset],[type=submit],button,html [type=button]{-webkit-appearance:button}[type=button]::-moz-focus-inner,[type=reset]::-moz-focus-inner,[type=submit]::-moz-focus-inner,button::-moz-focus-inner{border-style:none;padding:0}[type=button]:-moz-focusring,[type=reset]:-moz-focusring,[type=submit]:-moz-focusring,button:-moz-focusring{outline:1px dotted ButtonText}fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}legend{color:inherit;display:table;max-width:100%;white-space:normal}textarea{overflow:auto}[type=checkbox],[type=radio],legend{box-sizing:border-box;padding:0}[type=number]::-webkit-inner-spin-button,[type=number]::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}[type=search]::-webkit-search-cancel-button,[type=search]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-input-placeholder{color:inherit;opacity:.54}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}*,:after,:before{box-sizing:border-box}@media (min-width:850px){html{font-size:16px}}body,html{height:100%;background-color:#fff;color:#15284b}.Columns__left{background-color:#e8d5d3}.Columns__right__content{padding:10px;background-color:#fff}@media (max-width:768px){html:not(.no-js) .Collapsible__content{height:0;overflow:hidden;transition:height 400ms ease-in-out}}.Collapsible__trigger{margin:12px;padding:7px 10px;background-color:transparent;border:0;float:right;background-image:none;filter:none;box-shadow:none}.Collapsible__trigger__bar{display:block;width:18px;height:2px;margin-top:2px;margin-bottom:3px;background-color:#e8d5d3}.Collapsible__trigger:hover{background-color:#93b7bb;box-shadow:none}.Collapsible__trigger:hover .Collapsible__trigger__bar{background-color:#15284b}@media screen and (min-width:769px){body{background-color:#15284b}.Navbar{position:fixed;z-index:1030;width:100%}.Collapsible__trigger{display:none!important}.Collapsible__content{display:block!important}.Columns{height:100%}.Columns:after,.Columns:before{content:" ";display:table}.Columns:after{clear:both}.Columns__left,.Columns__right{position:relative;min-height:1px;float:left;overflow:auto;height:100%}.Columns__left{width:25%;border-right:1px solid #e7e7e9;overflow-x:hidden}.Columns__right{width:75%}.Columns__right__content{padding:0 20px 20px;min-height:100%}}.Page{max-width:860px}body{font-family:"Cabin","Trebuchet MS",-apple-system,".SFNSText-Regular","San Francisco","Roboto","Segoe UI","Helvetica Neue","Lucida Grande",Arial,sans-serif;font-feature-settings:"kern" 1;-webkit-font-kerning:normal;font-kerning:normal;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;line-height:1.618}h1,h2,h3,h4,h5,h6{font-family:"League Gothic",-apple-system,".SFNSText-Regular","San Francisco","Roboto","Segoe UI","Helvetica Neue","Lucida Grande",Arial,sans-serif}.s-content h1,.s-content h2,.s-content h3,.s-content h4,.s-content h5,.s-content h6{cursor:text;line-height:1.4em;margin:2em 0 .5em}.s-content h1 code,.s-content h1 tt,.s-content h2 code,.s-content h2 tt,.s-content h3 code,.s-content h3 tt,.s-content h4 code,.s-content h4 tt,.s-content h5 code,.s-content h5 tt,.s-content h6 code,.s-content h6 tt{font-size:inherit}.s-content h1 i,.s-content h2 i,.s-content h3 i,.s-content h4 i,.s-content h5 i,.s-content h6 i{font-size:.7em}.s-content h1 p,.s-content h2 p,.s-content h3 p,.s-content h4 p,.s-content h5 p,.s-content h6 p{margin-top:0}.s-content h1{margin-top:0;font-size:2.618rem}.s-content h2{font-size:2rem}.s-content h3{font-size:1.618rem}.s-content h4,.s-content h5,.s-content h6,.s-content small{font-size:1.309rem}.s-content a{text-decoration:underline}.s-content p{margin-bottom:1.3em}.s-content ol,.s-content ul{padding-left:2em}.s-content ul p,.s-content ul ul{margin:0}.s-content dl{padding:0}.s-content dl dt{font-weight:700;font-style:italic;padding:0;margin:15px 0 5px}.s-content dl dt:first-child{padding:0}.s-content dl dd{margin:0 0 15px;padding:0 15px}.s-content blockquote{margin:.75em 2em;padding:.5em 1em;font-style:italic;border-left:.25em solid #15284b}.s-content blockquote cite:before{content:"\2014";padding-right:.5em}.s-content table{width:100%;padding:0;margin-bottom:1em;border-collapse:separate;border-spacing:2px;border:2px solid #b3aab1}.s-content table+table{margin-top:1em}.s-content table tr{background-color:#fff;margin:0;padding:0;border-top:0}.s-content table tr:nth-child(2n){background-color:transparent}.s-content table th{font-weight:700;background:#e8d5d3}.s-content table td,.s-content table th{margin:0;padding:.5em}.s-content blockquote>:first-child,.s-content dl dd>:first-child,.s-content dl dt>:first-child,.s-content ol>:first-child,.s-content table td>:first-child,.s-content table th>:first-child,.s-content ul>:first-child{margin-top:0}.s-content blockquote>:last-child,.s-content dl dd>:last-child,.s-content dl dt>:last-child,.s-content ol>:last-child,.s-content table td>:last-child,.s-content table th>:last-child,.s-content ul>:last-child{margin-bottom:0}.s-content img{max-width:100%;display:block;margin:0 auto}.s-content code{font-family:Monaco,Menlo,Consolas,"Lucida Console","Courier New",monospace;padding-top:.1rem;padding-bottom:.1rem;background:#f9f5f4;border-radius:0;box-shadow:none;display:inline-block;padding:.5ch;border:0}.s-content code:after,.s-content code:before{letter-spacing:-.2em;content:"\00a0"}.s-content pre{background:#f5f2f0;line-height:1.5em;overflow:auto;border:0;border-radius:0;padding:.75em 20px;margin:0 -20px 20px}.s-content pre code{margin:0;padding:0;white-space:pre;box-shadow:none}.s-content pre code,.s-content pre tt{background-color:transparent;border:0}.s-content ins,.s-content u{text-decoration:none;border-bottom:1px solid #15284b}.s-content del a,.s-content ins a,.s-content u a{color:inherit}a.Link--external:after{content:" " url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAVklEQVR4Xn3PgQkAMQhDUXfqTu7kTtkpd5RA8AInfArtQ2iRXFWT2QedAfttj2FsPIOE1eCOlEuoWWjgzYaB/IkeGOrxXhqB+uA9Bfcm0lAZuh+YIeAD+cAqSz4kCMUAAAAASUVORK5CYII=)}a.Link--broken{color:red}p{margin:0 0 1em}.Button{display:inline-block;text-align:center;vertical-align:middle;touch-action:manipulation;cursor:pointer;background-image:none;border:1px solid transparent;white-space:nowrap;margin-bottom:0}.Button--small{font-size:12px;line-height:1.5;border-radius:3px}.Button--default{color:#333;background-color:#fff;border-color:#ccc}.Button--default.Button--active{color:#333;background-color:#e6e6e6;border-color:#adadad}.Brand,.Nav__item a:hover{color:#15284b;text-shadow:none}.Brand,.Navbar{background-color:#e63c2f}.Brand{display:block;padding:.75em .6em;font-size:2rem;font-family:"League Gothic",-apple-system,".SFNSText-Regular","San Francisco","Roboto","Segoe UI","Helvetica Neue","Lucida Grande",Arial,sans-serif}.Navbar{box-shadow:0 1px 5px rgba(0,0,0,.25);margin-bottom:0}.CodeToggler{padding:0 20px}.CodeToggler__text{font-size:12px;line-height:1.5;padding:6px 10px 6px 0;display:inline-block;vertical-align:middle}.no-js .CodeToggler{display:none}.Nav{margin:0;padding:0}.Nav__arrow{display:inline-block;position:relative;width:16px;margin-left:-16px}.Nav__arrow:before{position:absolute;display:block;content:"";margin:-.25em 0 0 -.4em;left:50%;top:50%;border-right:.15em solid #15284b;border-top:.15em solid #15284b;transform:rotate(45deg);transition-duration:.3s}.Nav__item,.Nav__item a{display:block}.Nav__item a{margin:0;padding:6px 15px 6px 20px;font-family:"League Gothic",-apple-system,".SFNSText-Regular","San Francisco","Roboto","Segoe UI","Helvetica Neue","Lucida Grande",Arial,sans-serif;font-weight:400;color:#15284b;text-shadow:none}.Nav__item a:hover{background-color:#93b7bb}.Nav .Nav{margin-left:15px}html:not(.no-js) .Nav .Nav{height:0;transition:height 400ms ease-in-out;overflow:hidden}.Nav .Nav .Nav__item a{margin:0 0 0 -15px;padding:3px 30px;font-family:"Cabin","Trebuchet MS",-apple-system,".SFNSText-Regular","San Francisco","Roboto","Segoe UI","Helvetica Neue","Lucida Grande",Arial,sans-serif;color:#15284b;opacity:.7}.HomepageButtons .Button--hero:hover,.Nav .Nav .Nav__item a:hover{opacity:1}.Nav .Nav .Nav__item--active a{color:#15284b}.Nav__item--active>a,.Nav__item--open>a{background-color:#93b7bb}.Nav__item--open>a>.Nav__arrow:before{margin-left:-.25em;transform:rotate(135deg)}.Page__header{margin:0 0 10px;padding:0}.Page__header:after,.Page__header:before{content:" ";display:table}.Page__header:after{clear:both}.Page__header h1{margin:0;padding:0;line-height:57px}.Page__header--separator{height:.6em}.Page__header a{text-decoration:none}.Page__header .EditOn,.Page__header .ModifiedDate{float:left;font-size:10px;color:gray}.Page__header .EditOn{float:right}.Links,.Twitter{padding:0 20px}.Links a{font-family:"League Gothic",-apple-system,".SFNSText-Regular","San Francisco","Roboto","Segoe UI","Helvetica Neue","Lucida Grande",Arial,sans-serif;font-weight:400;color:#15284b;line-height:2em}.Twitter{font:11px/18px "Helvetica Neue",Arial,sans-serif}.Twitter__button{text-decoration:none;display:inline-block;vertical-align:top;zoom:1;position:relative;height:20px;box-sizing:border-box;padding:1px 8px 1px 6px;background-color:#1b95e0;color:#fff;border-radius:3px;font-weight:500;cursor:pointer}.Twitter__button .Twitter__button__label{display:inline-block;vertical-align:top;zoom:1;margin-left:3px;white-space:nowrap}.Twitter__button svg{position:relative;top:2px;display:inline-block;width:14px;height:14px}.PoweredBy{padding:0 20px 1rem;font-size:1.309rem}.Search{position:relative}.Search__field{display:block;width:100%;height:34px;padding:6px 30px 6px 20px;color:#555;border-width:0 0 1px;border-bottom:1px solid #ccc;background:#fff;transition:border-color ease-in-out .15s}.Search__field:focus{border-color:#93b7bb;outline:0}.Search__icon{position:absolute;right:9px;top:9px;width:16px;height:16px}.Navbar .Search{float:right;margin:8px 20px}.Navbar .Search__field{box-shadow:inset 0 1px 1px rgba(0,0,0,.075);border-width:0;border-radius:4px;padding-left:10px}.TableOfContentsContainer{float:right;min-width:300px;max-width:25%;padding-left:1em}.TableOfContentsContainer__title{margin-bottom:0!important}.TableOfContentsContainer__content{border:1px solid #efefef;border-width:4px 2px 2px 6px}.TableOfContentsContainer__content>.TableOfContents>li+li{border-top:1px solid #ddd}ul.TableOfContents{font-size:1rem;padding-left:0;margin:0;list-style-type:none;border-left:6px solid #e8d5d3}ul.TableOfContents p{margin-bottom:0}ul.TableOfContents a{text-decoration:none;display:block;padding:.2em 0 .2em .75em}ul.TableOfContents .TableOfContents{padding-left:.75em}.Pager{padding-left:0;margin:1em 0;list-style:none;text-align:center}.Pager:after,.Pager:before{content:" ";display:table}.Pager,.Pager:after{clear:both}.Pager li{display:inline}.Pager li>a{display:inline-block;padding:5px 14px;background-color:#fff}.Pager li>a:focus,.Pager li>a:hover{text-decoration:none}.Pager--next>a{float:right}.Pager--prev>a{float:left}.Checkbox{position:relative;display:block;padding-left:30px;cursor:pointer}.Checkbox input{position:absolute;z-index:-1;opacity:0}.Checkbox__indicator{position:absolute;top:50%;left:0;width:20px;height:20px;margin-top:-10px;background:#e6e6e6}.Checkbox__indicator:after{position:absolute;display:none;content:""}.Checkbox input:focus~.Checkbox__indicator,.Checkbox:hover input~.Checkbox__indicator{background:#ccc}.Checkbox input:checked~.Checkbox__indicator{background:#15284b}.Checkbox input:checked~.Checkbox__indicator:after{display:block}.Checkbox input:checked:focus~.Checkbox__indicator,.Checkbox:hover input:not([disabled]):checked~.Checkbox__indicator{background:#93b7bb}.Checkbox input:disabled~.Checkbox__indicator{pointer-events:none;opacity:.6;background:#e6e6e6}.Checkbox .Checkbox__indicator:after{top:4px;left:8px;width:5px;height:10px;transform:rotate(45deg);border:solid #fff;border-width:0 2px 2px 0}.Checkbox input:disabled~.Checkbox__indicator:after{border-color:#7b7b7b}.Hidden{display:none}.Container{margin-right:auto;margin-left:auto}.Container--inner{width:80%;margin:0 auto}@media (min-width:1200px){.Container{width:1170px}}@media (min-width:992px){.Container{width:970px}}@media (min-width:769px){.Container{width:750px}}.Homepage{background-color:#fff;border-radius:0;border:0;color:#15284b;overflow:hidden;padding-bottom:0;margin-bottom:0;box-shadow:none}.HomepageTitle h2{width:80%;font-size:30px;margin:20px auto;text-align:center}.HomepageImage img{display:block;max-width:80%;margin:0 auto;height:auto}.HomepageButtons{padding:20px 0;background-color:#e8d5d3;text-align:center}.HomepageButtons:after,.HomepageButtons:before{content:" ";display:table}.HomepageButtons:after{clear:both}.HomepageButtons .Button--hero{padding:20px 30px;border-radius:0;text-shadow:none;opacity:.8;margin:0 10px;text-transform:uppercase;border:5px solid #15284b;font-family:"League Gothic",-apple-system,".SFNSText-Regular","San Francisco","Roboto","Segoe UI","Helvetica Neue","Lucida Grande",Arial,sans-serif;background-image:none;filter:none;box-shadow:none}@media (max-width:768px){.HomepageButtons .Button--hero{display:block;margin-bottom:10px}}.HomepageButtons .Button--hero.Button--secondary{background-color:#93b7bb;color:#15284b}.HomepageButtons .Button--hero.Button--primary{background-color:#15284b;color:#e8d5d3}.HomepageContent{background-color:#fff;padding:40px 0}.HomepageContent ol li,.HomepageContent ul li{list-style:none;margin-bottom:.5em;position:relative}.HomepageContent ol li:before,.HomepageContent ul li:before{position:absolute;top:50%;left:-1.5em;content:"";width:0;height:0;border:.5em solid transparent;border-left:.5em solid #93b7bb;float:left;display:block;margin-top:-.5em}.HomepageContent .HeroText,.HomepageFooter__links li a{font-size:16px;font-family:"League Gothic",-apple-system,".SFNSText-Regular","San Francisco","Roboto","Segoe UI","Helvetica Neue","Lucida Grande",Arial,sans-serif}.HomepageContent .HeroText{font-weight:300;margin-bottom:20px;line-height:1.4}@media (min-width:769px){.HomepageContent{padding:40px 20px}.HomepageContent .HeroText{font-size:21px}.HomepageContent .Row{margin:0 -15px}.HomepageContent .Row__half,.HomepageContent .Row__quarter,.HomepageContent .Row__third{float:left;position:relative;min-height:1px;padding-left:15px;padding-right:15px}.HomepageContent .Row__third{width:33.333333%}.HomepageContent .Row__half{width:50%}.HomepageContent .Row__quarter{width:25%}}.HomepageFooter{background-color:#15284b;color:#93b7bb;border:0;box-shadow:none}.HomepageFooter:after,.HomepageFooter:before{content:" ";display:table}.HomepageFooter:after{clear:both}@media (max-width:768px){.HomepageFooter{padding:0 20px;text-align:center}.HomepageFooter .HomepageFooter__links{padding-left:0;list-style-type:none}}@media (min-width:769px){.HomepageFooter .HomepageFooter__links{float:left}.HomepageFooter .HomepageFooter__twitter{float:right}}.HomepageFooter__links,.HomepageFooter__twitter{margin:40px 0}.HomepageFooter__links li a{line-height:32px;font-weight:700}.HomepageFooter__links li a:hover{text-decoration:underline}.HomepageFooter .Twitter__button{margin-bottom:20px}@media print{*{text-shadow:none!important;color:#000!important;background:0 0!important;box-shadow:none!important}h1,h2,h3,h4,h5,h6{page-break-after:avoid;page-break-before:auto}blockquote,img,pre{page-break-inside:avoid}blockquote,pre{border:1px solid #999;font-style:italic}img{border:0}a,a:visited{text-decoration:underline}abbr[title]:after{content:" (" attr(title) ")"}q{quotes:none}.s-content a[href^="#"]:after,q:before{content:""}q:after{content:" (" attr(cite) ")"}.PageBreak{display:block;page-break-before:always}.NoPrint,.Pager,aside{display:none}.Columns__right{width:100%!important}.s-content a:after{content:" (" attr(href) ")";font-size:80%;word-wrap:break-word}h1 a[href]:after{font-size:50%}}@font-face{font-family:'League Gothic';src:url(fonts/leaguegothic.woff2) format('woff2'),url(fonts/leaguegothic.woff) format('woff');font-style:normal;font-display:swap}@font-face{font-family:'Cabin';src:url(fonts/cabin-regular.woff2) format('woff2'),url(fonts/cabin-regular.woff) format('woff');font-weight:400;font-style:normal;font-display:swap}@font-face{font-family:'Cabin';src:url(fonts/cabin-italic.woff2) format('woff2'),url(fonts/cabin-italic.woff) format('woff');font-style:italic;font-display:swap}@font-face{font-family:'Cabin';src:url(fonts/cabin-bold.woff2) format('woff2'),url(fonts/cabin-bold.woff) format('woff');font-weight:700;font-style:normal;font-display:swap}.s-content code::after,.s-content code::before,a.Link--external::after{content:''}pre .s-content code{display:inline}.s-content table tbody,.s-content table thead{background-color:#fff}.s-content table tr:nth-child(2n) td{background-color:#f9f5f4}.s-content table td,.s-content table th{border:0}.Nav__item .Nav__item,.s-content table{font-size:1rem}.Brand,h1,h2,h3,h4,h5,h6{font-weight:400}.Button,.Pager li>a{border-radius:0}.HomepageButtons .Button--hero{font-weight:400;font-size:1.309rem}.Page__header{border-bottom:2px solid #e8d5d3}.Pager li>a{border:2px solid #e8d5d3}.Pager li>a:focus,.Pager li>a:hover{background-color:#e8d5d3}.Pager--prev a::before{content:"\2190\00a0"}.Pager--next a::after{content:"\00a0\2192"}.Navbar{height:auto;box-shadow:none}.Navbar .Brand{float:none;line-height:inherit;height:auto}.Homepage{padding-top:10px!important}.Nav__item{font-size:1.309rem}.Nav .Nav .Nav__item a .Nav__arrow:before,.Nav__arrow:before{font-family:"League Gothic",-apple-system,".SFNSText-Regular","San Francisco","Roboto","Segoe UI","Helvetica Neue","Lucida Grande",Arial,sans-serif;width:1ch;height:1ch}.TableOfContentsContainer__title{border-bottom:4px solid #e8d5d3}.Columns__right--full .TableOfContentsContainer .TableOfContentsContainer__content>.TableOfContents{border-right:2px solid #e8d5d3}.Columns__right--full .TableOfContentsContainer a{border-bottom:1px solid #e8d5d3}.clients thead tr:first-child th{text-align:left}.clients thead tr:first-child th:first-child{width:15%}.clients thead tr:first-child th:nth-child(3){width:50%;text-align:center}.clients thead tr+tr th{width:12%;text-align:center}.clients tbody td:nth-child(3),.clients tbody td:nth-child(4),.clients tbody td:nth-child(5),.clients tbody td:nth-child(6){text-align:center}.clients tbody td.Y{color:#2c9a42}.clients tbody td.N{color:#e63c2f}.hljs,.s-content pre{background:#15284b;color:#e8d5d3}.hljs{display:block;overflow-x:auto;padding:.5em}.hljs-emphasis{font-style:italic}.hljs-strong{font-weight:700}.hljs-comment,.hljs-quote{color:#978e9c}.hljs-addition,.hljs-keyword,.hljs-selector-tag{color:#acb39a}.hljs-doctag,.hljs-literal,.hljs-meta .hljs-meta-string,.hljs-number,.hljs-regexp,.hljs-string{color:#93b7bb}.hljs-name,.hljs-section,.hljs-selector-class,.hljs-selector-id,.hljs-title{color:#82b7e5}.hljs-attr,.hljs-attribute,.hljs-class .hljs-title,.hljs-template-variable,.hljs-type,.hljs-variable{color:#c5b031}.hljs-bullet,.hljs-link,.hljs-meta,.hljs-meta .hljs-keyword,.hljs-selector-attr,.hljs-selector-pseudo,.hljs-subst,.hljs-symbol{color:#ea8031}.hljs-built_in,.hljs-deletion{color:#e63c2f}.hljs-formula{background:#686986}@media (min-width:850px){.Columns__left{border:0}} \ No newline at end of file diff --git a/docs/theme/src/arsse.scss b/docs/theme/src/arsse.scss index 43a26c19..6f5d9d83 100644 --- a/docs/theme/src/arsse.scss +++ b/docs/theme/src/arsse.scss @@ -245,12 +245,12 @@ ul.TableOfContents { } thead tr + tr th { - width: 16.66%; + width: 12%; text-align: center; } tbody td { - &:nth-child(3), &:nth-child(4), &:nth-child(5) { + &:nth-child(3), &:nth-child(4), &:nth-child(5), &:nth-child(6) { text-align: center; } diff --git a/lib/AbstractException.php b/lib/AbstractException.php index 706465e0..cde92dca 100644 --- a/lib/AbstractException.php +++ b/lib/AbstractException.php @@ -14,6 +14,7 @@ abstract class AbstractException extends \Exception { "Exception.arrayEmpty" => 10002, "ExceptionType.strictFailure" => 10011, "ExceptionType.typeUnknown" => 10012, + "Exception.extMissing" => 10021, "Lang/Exception.defaultFileMissing" => 10101, "Lang/Exception.fileMissing" => 10102, "Lang/Exception.fileUnreadable" => 10103, @@ -46,6 +47,7 @@ abstract class AbstractException extends \Exception { "Db/Exception.savepointStale" => 10227, "Db/Exception.resultReused" => 10228, "Db/ExceptionRetry.schemaChange" => 10229, + "Db/ExceptionInput.invalidValue" => 10230, "Db/ExceptionInput.missing" => 10231, "Db/ExceptionInput.whitespace" => 10232, "Db/ExceptionInput.tooLong" => 10233, @@ -68,13 +70,15 @@ abstract class AbstractException extends \Exception { "Conf/Exception.typeMismatch" => 10311, "Conf/Exception.semanticMismatch" => 10312, "Conf/Exception.ambiguousDefault" => 10313, - "User/Exception.functionNotImplemented" => 10401, - "User/Exception.doesNotExist" => 10402, - "User/Exception.alreadyExists" => 10403, "User/Exception.authMissing" => 10411, "User/Exception.authFailed" => 10412, - "User/ExceptionAuthz.notAuthorized" => 10421, + "User/ExceptionConflict.doesNotExist" => 10402, + "User/ExceptionConflict.alreadyExists" => 10403, "User/ExceptionSession.invalid" => 10431, + "User/ExceptionInput.invalidTimezone" => 10441, + "User/ExceptionInput.invalidValue" => 10442, + "User/ExceptionInput.invalidNonZeroInteger" => 10443, + "User/ExceptionInput.invalidUsername" => 10444, "Feed/Exception.internalError" => 10500, "Feed/Exception.invalidCertificate" => 10501, "Feed/Exception.invalidUrl" => 10502, @@ -98,9 +102,27 @@ abstract class AbstractException extends \Exception { "ImportExport/Exception.invalidFolderName" => 10613, "ImportExport/Exception.invalidFolderCopy" => 10614, "ImportExport/Exception.invalidTagName" => 10615, + "Rule/Exception.invalidPattern" => 10701, + "Service/Exception.pidNotFile" => 10801, + "Service/Exception.pidDirMissing" => 10802, + "Service/Exception.pidDirUnresolvable" => 10803, + "Service/Exception.pidUnusable" => 10804, + "Service/Exception.pidUnreadable" => 10805, + "Service/Exception.pidUnwritable" => 10806, + "Service/Exception.pidUncreatable" => 10807, + "Service/Exception.pidCorrupt" => 10808, + "Service/Exception.pidDuplicate" => 10809, + "Service/Exception.pidLocked" => 10810, + "Service/Exception.pidInaccessible" => 10811, + "Service/Exception.forkFailed" => 10812, ]; + protected $symbol; + protected $params; + public function __construct(string $msgID = "", $vars = null, \Throwable $e = null) { + $this->symbol = $msgID; + $this->params = $vars ?? []; if ($msgID === "") { $msg = "Exception.unknown"; $code = 10000; @@ -117,4 +139,12 @@ abstract class AbstractException extends \Exception { } parent::__construct($msg, $code, $e); } + + public function getSymbol(): string { + return $this->symbol; + } + + public function getParams(): array { + return $this->params; + } } diff --git a/lib/Arsse.php b/lib/Arsse.php index 7d53a427..9f826d0f 100644 --- a/lib/Arsse.php +++ b/lib/Arsse.php @@ -7,8 +7,19 @@ declare(strict_types=1); namespace JKingWeb\Arsse; class Arsse { - public const VERSION = "0.8.5"; + public const VERSION = "0.10.0"; + public const REQUIRED_EXTENSIONS = [ + "intl", // as this extension is required to prepare formatted messages, its absence will throw a distinct English-only exception + "dom", + "filter", + "json", // part of the PHP core since version 8.0 + "hash", // part of the PHP core since version 7.4 + "simplexml", // required by PicoFeed only + "iconv", // required by PicoFeed only + ]; + /** @var Factory */ + public static $obj; /** @var Lang */ public static $lang; /** @var Conf */ @@ -18,11 +29,33 @@ class Arsse { /** @var User */ public static $user; + /** @codeCoverageIgnore */ + public static function bootstrap(): void { + $conf = file_exists(BASE."config.php") ? new Conf(BASE."config.php") : new Conf; + static::load($conf); + } + public static function load(Conf $conf): void { + static::$obj = static::$obj ?? new Factory; static::$lang = static::$lang ?? new Lang; static::$conf = $conf; static::$lang->set($conf->lang); static::$db = static::$db ?? new Database; static::$user = static::$user ?? new User; } + + /** Checks whether the specified extensions are loaded and throws an exception if any are not */ + public static function checkExtensions(string ...$ext): void { + $missing = []; + foreach ($ext as $e) { + if (!extension_loaded($e)) { + $missing[] = $e; + } + } + if ($missing) { + $total = sizeof($missing); + $first = $missing[0]; + throw new Exception("extMissing", ['first' => $first, 'total' => $total]); + } + } } diff --git a/lib/CLI.php b/lib/CLI.php index c9a59673..9e9993e3 100644 --- a/lib/CLI.php +++ b/lib/CLI.php @@ -8,126 +8,40 @@ namespace JKingWeb\Arsse; use JKingWeb\Arsse\REST\Fever\User as Fever; use JKingWeb\Arsse\ImportExport\OPML; +use JKingWeb\Arsse\REST\Miniflux\Token as Miniflux; +use JKingWeb\Arsse\Service\Daemon; class CLI { public const USAGE = << [] [--admin] + arsse.php user remove + arsse.php user show + arsse.php user set + arsse.php user unset + arsse.php user set-pass [] [--fever] + arsse.php user unset-pass [--fever] + arsse.php user auth [--fever] + arsse.php token list + arsse.php token create [