Version 1.21.0

CHANGELOG.md

@@ -248,3 +248,68 @@
 * Update Cloudron base image to 4.0.0
 * [Full Changelog](https://github.com/FreshRSS/FreshRSS/releases/tag/1.20.2)
 * Fix security vulnerability in ext.php #4928 reported by @c3l3si4n
+
+[1.15.3]
+* Update FreshRSS extensions repo to f66efcf5f
+
+[1.16.0]
+* Update FreshRSS to 1.21.1
+* [Full Changelog](https://github.com/FreshRSS/FreshRSS/releases/tag/1.21.0)
+* New XML+XPath mode for fetching XML documents when there is no RSS/ATOM feed #5076
+* Better support of feed enclosures (image / audio / video attachments) #4944
+* User-defined time-zone #4906
+* New CLI script cli/sensitive-log.sh to help e.g. Apache clear logs for sensitive information such as credentials #5001
+* Mark some themes as tentatively deprecated: BlueLagoon, Flat, Screwdriver #4807
+* Many UI improvements
+
+[1.17.0]
+* Update base image to 4.2.0
+
+[1.18.0]
+* Update FreshRSS to 1.22.0
+* [Full Changelog](https://github.com/FreshRSS/FreshRSS/releases/tag/1.22.0)
+* Rework trusted proxies
+* Improve scaling with many feeds and long processes, reduce database locks
+* Fix many bugs and regressions
+* Improve themes Origine (also with automatic dark mode), Nord, etc.
+* Several UI / UX improvements
+* New languages Hungarian, Latvian, Persian
+
+[1.19.0]
+* Implement OIDC login
+
+[1.19.1]
+* Update FreshRSS to 1.22.1
+* [Full Changelog](https://github.com/FreshRSS/FreshRSS/releases/tag/1.22.1)
+* Fix regression in extensions translations (i18n)
+* Better identification of proxied client IP
+
+[1.20.0]
+* Update FreshRSS to 1.23.0
+* [Full Changelog](https://github.com/FreshRSS/FreshRSS/releases/tag/1.23.0)
+* New Important feeds group in the main view, with corresponding new priority level for feeds #5782
+* Entries from important feeds are not marked as read during scroll, during focus, nor during Mark all as read
+* Add filter actions (auto mark as read) at category level and at global levels #5942
+* Increase SQL fields length to maximum possible #5788, #5570
+* Many bug fixes
+* Soft require Apache 2.4+ (but repair minimal compatibility with Apache 2.2)
+* Upgraded extensions require FreshRSS 1.23.0+ Extensions#181
+
+[1.20.1]
+* Update FreshRSS to 1.23.1
+* [Full Changelog](https://github.com/FreshRSS/FreshRSS/releases/tag/1.23.0)
+* Fix crash regression with the option Max number of tags shown #5978
+* Fix crash regression when enabling extensions defined by old FreshRSS installations #5979
+* Fix crash regression during export when using MySQL #5988
+* More robust assignment of categories to feeds #5986
+
+[1.21.0]
+* Update FreshRSS to 1.24.0
+* [Full Changelog](https://github.com/FreshRSS/FreshRSS/releases/tag/1.24.0)
+* New shareable user query mechanism to share lists of articles by HTML, RSS, OPML
+* New CLI for database backup & restore
+* New JSON scraping mode to consume JSON data and JSON Feeds
+* New support for HTTP POST
+* New option to automatically add labels to incoming articles
+* New button to download a feed configuration as OPML
+

CloudronManifest.json

@@ -5,13 +5,14 @@
   "description": "file://DESCRIPTION.md",
   "changelog": "file://CHANGELOG.md",
   "tagline": "RSS feed reader",
-  "version": "1.15.2",
-  "upstreamVersion": "1.20.2",
+  "version": "1.21.0",
+  "upstreamVersion": "1.24.0",
   "healthCheckPath": "/",
   "httpPort": 8000,
   "addons": {
     "localstorage": {},
     "mysql": {},
+    "oidc": { "loginRedirectUri": "/i/oidc/" },
     "scheduler": {
       "update_feeds": {
         "schedule": "*/1 * * * *",
@@ -28,7 +29,8 @@
     "https://screenshots.cloudron.io/org.freshrss.cloudronapp/1.png"
   ],
   "postInstallMessage": "file://POSTINSTALL.md",
-  "minBoxVersion": "7.1.0",
+  "minBoxVersion": "7.5.1",
   "forumUrl": "https://forum.cloudron.io/category/27/freshrss",
-  "documentationUrl": "https://cloudron.io/documentation/apps/freshrss/"
+  "documentationUrl": "https://cloudron.io/documentation/apps/freshrss/",
+  "optionalSso": true
 }

DESCRIPTION.md

@@ -1,5 +1,3 @@
-This app packages FreshRSS <upstream>1.19.2</upstream>.
-
 ## About
 
 FreshRSS is a self-hosted RSS feed aggregator such as Leed or Kriss Feed.

Dockerfile

@@ -1,15 +1,16 @@
-FROM cloudron/base:4.0.0@sha256:31b195ed0662bdb06a6e8a5ddbedb6f191ce92e8bee04c03fb02dd4e9d0286df
+FROM cloudron/base:4.2.0@sha256:46da2fffb36353ef714f97ae8e962bd2c212ca091108d768ba473078319a47f4
+
+RUN apt-get update && apt-get install --no-install-recommends -y libapache2-mod-auth-openidc && rm -rf /var/cache/apt /var/lib/apt/lists
 
 RUN mkdir -p /app/code
 WORKDIR /app/code
 
-ARG VERSION=1.20.2
-RUN curl -L https://github.com/FreshRSS/FreshRSS/archive/${VERSION}.tar.gz | tar -zxvf - --strip-components=1
+ARG VERSION=1.24.0
+RUN curl -L https://github.com/FreshRSS/FreshRSS/archive/${VERSION}.tar.gz | tar -zxvf - --strip-components=1 && \
+    mv data data-orig && ln -s /app/data data
 
-RUN mv data data-orig && ln -s /app/data data
-
-# official extensions
-RUN wget https://github.com/FreshRSS/Extensions/archive/1784092164139dc6961ba5cc5b920331b586acbc.tar.gz -O - | tar -xz --strip-components=1 -C /app/code/extensions && \
+# official extensions (https://github.com/FreshRSS/Extensions/commits/master)
+RUN wget https://github.com/FreshRSS/Extensions/archive/a82e080a1e68eb34539959a852fc5e800b7346dd.tar.gz -O - | tar -xz --strip-components=1 -C /app/code/extensions && \
     mv /app/code/extensions /app/code/extensions-orig && \
     ln -s /app/data/extensions /app/code/extensions
 
@@ -22,7 +23,7 @@ RUN a2disconf other-vhosts-access-log
 ADD apache/freshrss.conf /etc/apache2/sites-enabled/freshrss.conf
 RUN echo "Listen 8000" > /etc/apache2/ports.conf
 
-RUN a2enmod headers expires deflate mime dir rewrite setenvif
+RUN a2enmod headers expires deflate mime dir rewrite setenvif auth_openidc
 
 RUN rm -rf /var/lib/php && ln -s /run/php /var/lib/php
 

POSTINSTALL.md

@@ -1,7 +1,16 @@
+<sso>
+On first visit, sign in using the built-in Cloudron authentication and then make the user administrator
+by running:
+```
+php cli/reconfigure.php --default_user YOUR_USERNAME
+```
+</sso>
+
+<nosso>
 This app is pre-setup with an admin account. The initial credentials are:
   
 **Username**: admin<br/>
 **Password**: changeme<br/>
 
 Please change the admin password immediately.
-
+</nosso>

apache/freshrss.conf

@@ -1,3 +1,5 @@
+# https://github.com/FreshRSS/FreshRSS/blob/edge/Docker/FreshRSS.Apache.conf
+
 ServerName %{HTTP_HOST}
 
 <VirtualHost *:8000>
@@ -13,4 +15,41 @@ ServerName %{HTTP_HOST}
         AllowOverride All
         Require all granted
     </Directory>
+
+    <Directory /app/code/p/api>
+        Include /app/code/p/api/.htaccess
+    </Directory>
+
+    <Directory /app/code/p/i>
+        ExpiresActive Off
+
+        <IfDefine OIDC_ENABLED>
+            AuthType openid-connect
+            Require valid-user
+        </IfDefine>
+        IncludeOptional /app/code/p/i/.htaccess
+    </Directory>
+
+    <Directory /app/code/p/themes>
+        Include /app/code/p/themes/.htaccess
+    </Directory>
+
+
+    <IfDefine OIDC_ENABLED>
+        OIDCProviderMetadataURL ${CLOUDRON_OIDC_DISCOVERY_URL}
+        OIDCClientID ${CLOUDRON_OIDC_CLIENT_ID}
+        OIDCClientSecret ${CLOUDRON_OIDC_CLIENT_SECRET}
+
+        OIDCRedirectURI /i/oidc/
+
+        OIDCCryptoPassphrase ${OIDC_CRYPTO_PASSPHRASE}
+
+        OIDCRemoteUserClaim sub
+
+        OIDCScope "openid profile email"
+
+        OIDCRefreshAccessTokenBeforeExpiry 30
+        OIDCPassClaimsAs headers
+        OIDCXForwardedHeaders X-Forwarded-Proto
+    </IfDefine>
 </VirtualHost>

start.sh

@@ -13,7 +13,11 @@ if ! [ -f /app/data/.installed ]; then
       --db-user "${CLOUDRON_MYSQL_USERNAME}" --db-password "${CLOUDRON_MYSQL_PASSWORD}" \
       --db-base "${CLOUDRON_MYSQL_DATABASE}" --db-prefix "" \
       --disable_update
-    php cli/create-user.php --user admin --password changeme --language en
+
+    if [[ -z "${CLOUDRON_OIDC_ISSUER:-}" ]]; then
+        php cli/create-user.php --user admin --password changeme --language en
+    fi
+
     touch /app/data/.installed
     echo "==> Done."
 fi
@@ -35,7 +39,15 @@ for f in $(ls /app/code/extensions-orig); do
 done
 
 echo "==> Updating config file"
-php cli/reconfigure.php --default_user admin --base_url "https://${CLOUDRON_APP_DOMAIN}" \
+if [[ -z "${CLOUDRON_OIDC_ISSUER:-}" ]]; then
+    extra_args="--default_user admin"
+    [[ ! -f /app/data/.oauth_crypto_passphrase ]] && openssl rand -base64 42 > /app/data/.oauth_crypto_passphrase
+    export OIDC_CRYPTO_PASSPHRASE=$(</app/data/.oauth_crypto_passphrase) # used in apache config
+else
+    extra_args="--auth_type http_auth"
+fi
+
+php cli/reconfigure.php ${extra_args} --base_url "https://${CLOUDRON_APP_DOMAIN}" \
     --db-type mysql --db-host "${CLOUDRON_MYSQL_HOST}" \
     --db-user "${CLOUDRON_MYSQL_USERNAME}" --db-password "${CLOUDRON_MYSQL_PASSWORD}" \
     --db-base "${CLOUDRON_MYSQL_DATABASE}" --db-prefix "" \
@@ -47,4 +59,4 @@ chown -R www-data.www-data /run/php /app/data /tmp/log_api.txt
 echo "==> Starting apache"
 APACHE_CONFDIR="" source /etc/apache2/envvars
 rm -f "${APACHE_PID_FILE}"
-exec /usr/sbin/apache2 -DFOREGROUND
+exec /usr/sbin/apache2 -D FOREGROUND $([[ -n "$CLOUDRON_OIDC_ISSUER" ]] && echo '-D OIDC_ENABLED')

test/package.json

@@ -9,12 +9,10 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "chromedriver": "^108.0.0",
+    "chromedriver": "^125.0.1",
     "expect.js": "^0.3.1",
-    "mkdirp": "^1.0.4",
-    "mocha": "^10.1.0",
-    "rimraf": "^3.0.2",
-    "selenium-webdriver": "^4.7.0",
-    "superagent": "^8.0.6"
+    "mocha": "^10.4.0",
+    "selenium-webdriver": "^4.21.0",
+    "superagent": "^9.0.2"
   }
 }

test/test.js

@@ -5,29 +5,38 @@
 /* global before */
 /* global after */
 /* global it */
+/* global xit */
 
 'use strict';
 
 require('chromedriver');
 
-var execSync = require('child_process').execSync,
+const execSync = require('child_process').execSync,
     expect = require('expect.js'),
     path = require('path'),
     superagent = require('superagent'),
     { Builder, By, Key, until } = require('selenium-webdriver'),
     { Options } = require('selenium-webdriver/chrome');
 
-var username = 'admin',
-    password = 'changeme';
+const admin_username = 'admin', admin_password = 'changeme';
+
+if (!process.env.USERNAME || !process.env.PASSWORD) {
+    console.log('USERNAME and PASSWORD env vars need to be set');
+    process.exit(1);
+}
 
 describe('Application life cycle test', function () {
     this.timeout(0);
 
     const LOCATION = 'test';
-    const TEST_TIMEOUT = 10000;
+    const TEST_TIMEOUT = parseInt(process.env.TIMEOUT, 10) || 10000;
     const EXEC_ARGS = { cwd: path.resolve(__dirname, '..'), stdio: 'inherit' };
 
-    var browser, app;
+    const USERNAME = process.env.USERNAME;
+    const PASSWORD = process.env.PASSWORD;
+
+    let browser, app;
+    let athenticated_by_oidc = false;
 
     before(function () {
         const options = new Options().windowSize({ width: 1280, height: 1024 });
@@ -56,7 +65,7 @@ describe('Application life cycle test', function () {
         await browser.wait(until.elementIsVisible(browser.findElement(elem)), TEST_TIMEOUT);
     }
 
-    async function login(password) {
+    async function login(username, password) {
         await browser.get('https://' + app.fqdn);
         await waitForElement(By.id('loginButton'));
         await browser.findElement(By.id('username')).sendKeys(username);
@@ -65,6 +74,25 @@ describe('Application life cycle test', function () {
         await waitForElement(By.id('btn-subscription'));
     }
 
+    async function loginOIDC(username, password) {
+        browser.manage().deleteAllCookies();
+        await browser.get(`https://${app.fqdn}/i/`);
+        await browser.sleep(6000);
+
+        if (!athenticated_by_oidc) {
+            await waitForElement(By.xpath('//input[@name="username"]'));
+            await browser.findElement(By.xpath('//input[@name="username"]')).sendKeys(username);
+            await browser.findElement(By.xpath('//input[@name="password"]')).sendKeys(password);
+            await browser.sleep(2000);
+            await browser.findElement(By.xpath('//button[@type="submit" and contains(text(), "Sign in")]')).click();
+            await browser.sleep(2000);
+
+            athenticated_by_oidc = true;
+        }
+
+        await waitForElement(By.id('btn-subscription'));
+    }
+
     async function logout() {
         var logout_btn = By.xpath('//li/a[@class="signout"]');
 
@@ -87,12 +115,10 @@ describe('Application life cycle test', function () {
         await waitForElement(By.xpath('//div[@id="notification" and @class="notification good"]'));
     }
 
-    async function addUser(password) {
-        var test_username = 'test';
-
+    async function addUser(username, password) {
         await browser.get(`${baseUrl()}/i/?c=user&a=manage`);
         await waitForElement(By.id('new_user_name'));
-        await browser.findElement(By.id('new_user_name')).sendKeys(test_username);
+        await browser.findElement(By.id('new_user_name')).sendKeys(username);
         await browser.findElement(By.id('new_user_passwordPlain')).sendKeys(password);
         await browser.findElement(By.xpath('//button[text()="Create"]')).click();
         await waitForElement(By.xpath('//div[@id="notification" and @class="notification good"]'));
@@ -103,6 +129,7 @@ describe('Application life cycle test', function () {
         await waitForElement(By.id('api_enabled'));
         await browser.findElement(By.id('api_enabled')).click();
         await browser.findElement(By.xpath('//button[text()="Submit"]')).click();
+        await browser.sleep(5000);
     }
 
     async function checkApiConfiguration() {
@@ -116,30 +143,42 @@ describe('Application life cycle test', function () {
         return waitForElement(By.xpath('//span[text()="Cloudron"]'));
     }
 
-    function getStaticExtensionFile(callback) {
-        superagent.get(`${baseUrl()}/ext.php?f=xExtension-StickyFeeds/static/script.js&t=js`)
+    async function getStaticExtensionFile() {
+        const response = await superagent.get(`${baseUrl()}/ext.php?f=xExtension-StickyFeeds/static/script.js&t=js`)
             .buffer(true)
-            .end(function (err, res) {
-                expect(err).to.be(null);
-                expect(res.status).to.be(200);
-                expect(res.text).to.contain('sticky_feeds'); // relies on the buffer flag above
-                callback();
-        });
+            .ok(() => true);
+        expect(response.statusCode).to.be(200);
+        expect(response.text).to.contain('sticky_feeds'); // relies on the buffer flag above
     }
 
     xit('build app', function () { execSync('cloudron build', EXEC_ARGS); });
-    it('install app', function () { execSync('cloudron install --location ' + LOCATION, EXEC_ARGS); });
+    // No SSO
+    it('install app (no sso)', function () { execSync('cloudron install --no-sso --location ' + LOCATION, EXEC_ARGS); });
 
     it('can get app information', getAppInfo);
 
-    it('can login', login.bind(null, password));
+    it('can login', login.bind(null, admin_username, admin_password));
     it('can subscribe', addSubscription);
-    it('can add users', addUser.bind(null, password));
+    it('can add users', addUser.bind(null, 'test', admin_password));
     it('can enable API', enableApi);
     it('can check configuration', checkApiConfiguration);
     it('subscription exists', subscriptionExists);
     it('can get static extension file', getStaticExtensionFile);
     it('can logout', logout);
+    it('uninstall app', function () { execSync('cloudron uninstall --app ' + app.id, EXEC_ARGS); });
+
+    // SSO
+    it('install app (sso)', function () { execSync('cloudron install --location ' + LOCATION, EXEC_ARGS); });
+
+    it('can get app information', getAppInfo);
+
+    it('can login OIDC', loginOIDC.bind(null, USERNAME, PASSWORD));
+    it('can make user Administrator', function () { execSync(`cloudron exec --app ${app.id} -- bash -c "php cli/reconfigure.php --default_user ${USERNAME}"`); });
+    it('can subscribe', addSubscription);
+    it('can enable API', enableApi);
+    it('can check configuration', checkApiConfiguration);
+    it('subscription exists', subscriptionExists);
+    it('can get static extension file', getStaticExtensionFile);
 
     it('backup app', function () { execSync('cloudron backup create --app ' + app.id, EXEC_ARGS); });
 
@@ -151,11 +190,10 @@ describe('Application life cycle test', function () {
         execSync(`cloudron restore --backup ${backups[0].id} --app ${app.id}`, EXEC_ARGS);
     });
 
-    it('can login', login.bind(null, password));
+    it('can login OIDC', loginOIDC.bind(null, USERNAME, PASSWORD));
     it('can check configuration', checkApiConfiguration);
     it('subscription exists', subscriptionExists);
     it('can get static extension file', getStaticExtensionFile);
-    it('can logout', logout);
 
     it('move to different location', function () {
         browser.manage().deleteAllCookies();
@@ -165,21 +203,21 @@ describe('Application life cycle test', function () {
         expect(app).to.be.an('object');
     });
 
-    it('can login', login.bind(null, password));
+    it('can login OIDC', loginOIDC.bind(null, USERNAME, PASSWORD));
     it('can check configuration', checkApiConfiguration);
     it('subscription exists', subscriptionExists);
     it('can get static extension file', getStaticExtensionFile);
-    it('can logout', logout);
 
     it('uninstall app', function () { execSync('cloudron uninstall --app ' + app.id, EXEC_ARGS); });
 
     // test update
-    it('can install app', function () { execSync('cloudron install --appstore-id org.freshrss.cloudronapp --location ' + LOCATION, EXEC_ARGS); });
+    it('can install app for update', function () { execSync('cloudron install --appstore-id org.freshrss.cloudronapp --location ' + LOCATION, EXEC_ARGS); });
 
     it('can get app information', getAppInfo);
-    it('can login', login.bind(null, password));
+    it('can login OIDC', loginOIDC.bind(null, USERNAME, PASSWORD));
+    it('can make user Administrator', function () { execSync(`cloudron exec --app ${app.id} -- bash -c "php cli/reconfigure.php --default_user ${USERNAME}"`); });
     it('can subscribe', addSubscription);
-    it('can add users', addUser.bind(null, password));
+    it('can add users', addUser.bind(null, 'test', admin_password));
 
     it('can update', function () {
         execSync('cloudron update --app ' + app.id, EXEC_ARGS);
@@ -188,7 +226,6 @@ describe('Application life cycle test', function () {
         expect(app).to.be.an('object');
     });
 
-    it('can login', login.bind(null, password));
     it('subscription exists', subscriptionExists);
     it('can get static extension file', getStaticExtensionFile);