Difference between revisions of "TinyTinyRSS"

From SME Server
Jump to navigationJump to search
 
(14 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
{{Languages}}
 
{{Languages}}
 
  
 
===Maintainer===
 
===Maintainer===
[[User:VIP-ire|Daniel B.]]<br/>
+
We have now imported these contribs originally built by Daniel into smecontribs.
[http://www.firewall-services.com Firewall Services]<br>
 
mailto:daniel@firewall-services.com
 
  
 +
[mailto:daniel@firewall-services.com][[User:VIP-ire|Daniel B.]] from [http://www.firewall-services.com Firewall Services]
  
=== Description ===
+
===Version===
 +
{{#smeversion: smeserver-tt-rss }}
 +
[[Has SME10::true| ]]
 +
{{#smeversion: tt-rss }}
  
[http://tt-rss.org/redmine/ Tiny Tiny RSS] is a web based feed reader. You can take a look at the [http://tt-rss.org/demo/ online demo]
+
===Description===
  
=== Requirement ===
+
[http://tt-rss.org/redmine/ Tiny Tiny RSS] is a web based feed reader. You can take a look at the [https://srv.tt-rss.org/tt-rss/ online demo, login - demo, demo]
  
This contrib has been developped and tested on SME Server 8b6 and later. It probably won't work on SME 7.
+
===Installation 9.x===
  
=== Installation ===
+
v9 is now EOL and deprecated
  
Configure Firewall-Services's repository:
+
===Installation v10.x===
  
db yum_repositories set fws repository \
+
{{Warning box|These contribs are still in the smetest repo for testing}}
BaseURL http://repo.firewall-services.com/centos/\$releasever \
 
EnableGroups no GPGCheck yes \
 
Name "Firewall Services" \
 
GPGKey http://repo.firewall-services.com/RPM-GPG-KEY \
 
Visible yes status disabled
 
signal-event yum-modify
 
  
*install the rpms
+
To install normally you would use the following:
  
  yum --enablerepo=fws install smeserver-tt-rss
+
  yum --enablerepo=smecontribs install smeserver-tt-rss
  
* Appply the needed configuration:
+
You should not need a reboot.
  
 +
Any changes should be activated with
 
  signal-event webapps-update
 
  signal-event webapps-update
db configuration set UnsavedChanges no
 
  
 
You can now access the application using this URL: https://your-server.domain.tld/tt-rss
 
You can now access the application using this URL: https://your-server.domain.tld/tt-rss
 
All users created on your SME Server can login with their usual credentials.
 
All users created on your SME Server can login with their usual credentials.
  
{{Tip box| be aware that after a major update a script db-updater.php is automatically launched by TinyTinyRSS and you need to give the default admin login and password ('''admin/password''') to allow the script execution.}}
+
If you cannot access the application and get the following error : ''Please set SELF_URL_PATH to the correct value .....''  
 +
you can change the default URL in the configuration DB like this :
  
=== Additional options ===
+
example:
 +
db configuration setprop tt-rss Uri https://your_server_address/tt-rss
 +
expand-template /usr/share/tt-rss/config.php
 +
 
 +
{{Tip box| be aware that after a major update of this contrib, a script db-updater.php is automatically launched by TinyTinyRSS and you need to give the default admin login and password ('''admin/password''') to allow the script execution.}}
 +
 
 +
===Additional options===
  
 
Some settings are available from the DB
 
Some settings are available from the DB
  
* '''Authentication''': Control the way users are authenticated. Correct values are '''http''' (apache protect the access), '''internal''' (uses the internal database to manage users and groups. An admin have to create user account before they can login). If you use the internal authentication mechanism, you need to login using '''admin/password'''. A last value is available for this prop: '''LemonLDAP''' which uses [[LemonLDAP-NG]] to validate credentials, and the internal ldap server do get user/group information. You can have more information on this later on this page.
+
*'''Authentication''': Control the way users are authenticated. Correct values are '''http''' (apache protect the access), '''internal''' (uses the internal database to manage users and groups. An admin have to create user account before they can login). If you use the internal authentication mechanism, you need to login using '''admin/password'''. A last value is available for this prop: '''LemonLDAP''' which uses [[LemonLDAP-NG]] to validate credentials, and the internal ldap server to get user/group information. You can have more information on this later on this page.
* '''MultiUser''': If set to disabled, the application will only manage one profile, everyone will share the same settings, the same list of RSS etc...
+
*'''MultiUser''': If set to disabled, the application will only manage one profile, everyone will share the same settings, the same list of RSS etc...
* '''AliasOnPrimary''': can be enabled or disabled (default is enabled). This prop lets you disable the access to Tiny Tiny RSS on your primary domain (the alias /tt-rss won't be added in apache configuration). This is useful if you want the application to be available only with a virtualhost.  
+
*'''AliasOnPrimary''': can be enabled or disabled (default is enabled). This prop lets you disable the access to Tiny Tiny RSS on your primary domain (the alias /tt-rss won't be added in apache configuration). This is useful if you want the application to be available only with a virtualhost.
* '''status''' (enabled|disabled). Enable or disable web access, as well as the demon update
+
*'''Uri:''' This prop lets you change the URL of your Tiny Tiny RSS application.
 +
*'''status''' (enabled|disabled). Enable or disable web access, as well as the demon update
 
*'''access''' (public|private). Private by default, gives access only to local networks and the IP address are allowed to access in the server-manager ($ $ localAccess externalSSLAccess)
 
*'''access''' (public|private). Private by default, gives access only to local networks and the IP address are allowed to access in the server-manager ($ $ localAccess externalSSLAccess)
  
Line 57: Line 60:
  
  
'''Keep in mind that if you want to use the application tiny-rss with a mobile phone (android of course) or a laptop outside of your wifi network, you must allow the application in Public way.'''
+
{{note box|Keep in mind that if you want to use the application tiny-rss with a mobile phone (android of course) or a laptop outside of your wifi network, you must allow the application in Public way.}}
  
 
example:
 
example:
Line 63: Line 66:
 
  signal-event webapps-update
 
  signal-event webapps-update
  
=== Integration with LemonLDAP::NG ===
+
===Integration with LemonLDAP::NG===
 
Tiny Tiny RSS can be protected by LemonLDAP::NG. Here're the steps to protect it
 
Tiny Tiny RSS can be protected by LemonLDAP::NG. Here're the steps to protect it
  
==== Disable the access on the primary domain ====
+
====Disable the access on the primary domain====
 
You should disable the access to Tiny Tiny RSS on your primary domain:
 
You should disable the access to Tiny Tiny RSS on your primary domain:
 
  db configuration setprop tt-rss AliasOnPrimary disabled
 
  db configuration setprop tt-rss AliasOnPrimary disabled
 
  signal-event webapps-update
 
  signal-event webapps-update
  
==== Enable LemonLDAP::NG integration ====
+
====Enable LemonLDAP::NG integration====
 
This contrib support LemonLDAP NG auth quite easily:
 
This contrib support LemonLDAP NG auth quite easily:
 
  db configuration setprop tt-rss Authentication LemonLDAP
 
  db configuration setprop tt-rss Authentication LemonLDAP
 
  signal-event webapps-update
 
  signal-event webapps-update
  
==== Create a new virtualhost for Tiny Tiny RSS ====
+
====Create a new virtualhost for Tiny Tiny RSS====
 
Lets create a new virtualhost for Tiny Tiny RSS. You can choose the name you want, for example, lets create rss.domain.tld:
 
Lets create a new virtualhost for Tiny Tiny RSS. You can choose the name you want, for example, lets create rss.domain.tld:
  
 
  db domains set rss.$(db configuration get DomainName) domain Content Primary Description 'Tiny Tiny RSS' \
 
  db domains set rss.$(db configuration get DomainName) domain Content Primary Description 'Tiny Tiny RSS' \
 
  DocumentRoot /usr/share/tt-rss Nameservers internet TemplatePath WebAppVirtualHost \
 
  DocumentRoot /usr/share/tt-rss Nameservers internet TemplatePath WebAppVirtualHost \
  LemonLDAP enabled
+
  Authentication LemonLDAP
 
  signal-event domain-create rss.$(db configuration get DomainName)
 
  signal-event domain-create rss.$(db configuration get DomainName)
 
  signal-event webapps-update
 
  signal-event webapps-update
  
==== Declare this virtualhost in LemonLDAP ====
+
====Declare this virtualhost in LemonLDAP====
 
You can now create the virtualhost in LemonLDAP management interface. You can create the rules you want. For example, here're the rules to accept only members of the group 'rss'
 
You can now create the virtualhost in LemonLDAP management interface. You can create the rules you want. For example, here're the rules to accept only members of the group 'rss'
  
* Comment: default
+
*Comment: default
* Rule: $groups =~ /\brss\b/
+
*Rule: $groups =~ /\brss\b/
  
=== Uninstall ===
+
===Uninstall===
 
If you want to remove the contrib, just run:
 
If you want to remove the contrib, just run:
 
  yum remove tt-rss
 
  yum remove tt-rss
  
  
=== Source ===
+
===Bugs===
The source for this contrib can be found in Firewall-Services's repository [http://repo.firewall-services.com/centos/5/SRPMS/].
+
Please raise bugs under the SME-Contribs section in [http://bugs.contribs.org/enter_bug.cgi bugzilla]
 +
and select the tt-rss component or use {{BugzillaFileBug|product=SME%20Contribs|component=tt-rss|title=this link}}.
 +
{{#bugzilla:columns=id,product,version,status,summary |sort=id |order=desc |component=tt-rss|noresultsmessage="No open bugs found."}}
 +
 
 +
 
 +
Please raise bugs under the SME-Contribs section in [http://bugs.contribs.org/enter_bug.cgi bugzilla]
 +
and select the smeserver-tt-rss component or use {{BugzillaFileBug|product=SME%20Contribs|component=smeserver-tt-rss|title=this link}}.
 +
{{#bugzilla:columns=id,product,version,status,summary |sort=id |order=desc |component=smeserver-tt-rss|noresultsmessage="No open bugs found."}}
 +
 
 +
===Changelog===
 +
Only versions released in smecontrib are listed here.
 +
 
 +
{{#smechangelog: smeserver-tt-rss}}
 +
 
  
 
----
 
----
 
[[Category:Contrib]]
 
[[Category:Contrib]]
 +
[[Category:Webapps]]

Latest revision as of 10:56, 5 December 2021


Maintainer

We have now imported these contribs originally built by Daniel into smecontribs.

[1]Daniel B. from Firewall Services

Version

Contrib 10:
smeserver-tt-rss
The latest version of smeserver-tt-rss is available in the SME repository, click on the version number(s) for more information.


tt-rss
The latest version of tt-rss is available in the SME repository, click on the version number(s) for more information.


Description

Tiny Tiny RSS is a web based feed reader. You can take a look at the online demo, login - demo, demo

Installation 9.x

v9 is now EOL and deprecated

Installation v10.x

Warning.png Warning:
These contribs are still in the smetest repo for testing


To install normally you would use the following:

yum --enablerepo=smecontribs install smeserver-tt-rss

You should not need a reboot.

Any changes should be activated with

signal-event webapps-update

You can now access the application using this URL: https://your-server.domain.tld/tt-rss All users created on your SME Server can login with their usual credentials.

If you cannot access the application and get the following error : Please set SELF_URL_PATH to the correct value ..... you can change the default URL in the configuration DB like this :

example:

db configuration setprop tt-rss Uri https://your_server_address/tt-rss
expand-template /usr/share/tt-rss/config.php


Information.png Tip:
be aware that after a major update of this contrib, a script db-updater.php is automatically launched by TinyTinyRSS and you need to give the default admin login and password (admin/password) to allow the script execution.


Additional options

Some settings are available from the DB

  • Authentication: Control the way users are authenticated. Correct values are http (apache protect the access), internal (uses the internal database to manage users and groups. An admin have to create user account before they can login). If you use the internal authentication mechanism, you need to login using admin/password. A last value is available for this prop: LemonLDAP which uses LemonLDAP-NG to validate credentials, and the internal ldap server to get user/group information. You can have more information on this later on this page.
  • MultiUser: If set to disabled, the application will only manage one profile, everyone will share the same settings, the same list of RSS etc...
  • AliasOnPrimary: can be enabled or disabled (default is enabled). This prop lets you disable the access to Tiny Tiny RSS on your primary domain (the alias /tt-rss won't be added in apache configuration). This is useful if you want the application to be available only with a virtualhost.
  • Uri: This prop lets you change the URL of your Tiny Tiny RSS application.
  • status (enabled|disabled). Enable or disable web access, as well as the demon update
  • access (public|private). Private by default, gives access only to local networks and the IP address are allowed to access in the server-manager ($ $ localAccess externalSSLAccess)

example:

db configuration setprop tt-rss AliasOnPrimary disabled
signal-event webapps-update


Important.png Note:
Keep in mind that if you want to use the application tiny-rss with a mobile phone (android of course) or a laptop outside of your wifi network, you must allow the application in Public way.


example:

db configuration setprop tt-rss access public
signal-event webapps-update

Integration with LemonLDAP::NG

Tiny Tiny RSS can be protected by LemonLDAP::NG. Here're the steps to protect it

Disable the access on the primary domain

You should disable the access to Tiny Tiny RSS on your primary domain:

db configuration setprop tt-rss AliasOnPrimary disabled
signal-event webapps-update

Enable LemonLDAP::NG integration

This contrib support LemonLDAP NG auth quite easily:

db configuration setprop tt-rss Authentication LemonLDAP
signal-event webapps-update

Create a new virtualhost for Tiny Tiny RSS

Lets create a new virtualhost for Tiny Tiny RSS. You can choose the name you want, for example, lets create rss.domain.tld:

db domains set rss.$(db configuration get DomainName) domain Content Primary Description 'Tiny Tiny RSS' \
DocumentRoot /usr/share/tt-rss Nameservers internet TemplatePath WebAppVirtualHost \
Authentication LemonLDAP
signal-event domain-create rss.$(db configuration get DomainName)
signal-event webapps-update

Declare this virtualhost in LemonLDAP

You can now create the virtualhost in LemonLDAP management interface. You can create the rules you want. For example, here're the rules to accept only members of the group 'rss'

  • Comment: default
  • Rule: $groups =~ /\brss\b/

Uninstall

If you want to remove the contrib, just run:

yum remove tt-rss


Bugs

Please raise bugs under the SME-Contribs section in bugzilla and select the tt-rss component or use this link .

"No open bugs found."


Please raise bugs under the SME-Contribs section in bugzilla and select the smeserver-tt-rss component or use this link .

IDProductVersionStatusSummary (2 tasks)
11966SME Contribs10.0CONFIRMEDUnable to open Unix domain Socket on web page access
11878SME Contribs10.0UNCONFIRMEDUnable to see pages after logging in (smeserver-ttrss)

Changelog

Only versions released in smecontrib are listed here.

smeserver-tt-rss Changelog: SME 10 (smecontribs)
2022/06/30 Michel Begue 0.5.0-3.sme
- update to httpd 2.4 syntax [SME: 12062]
2021/11/21 Michel Begue 0.5.0-2.sme
- Fix log file not fed

2021/11/01 Michel Begue 0.5.0-1.sme
- First import to sme 10
- systemd, update event & php-fpm

- Support tt-rss 20211029

2017/07/13 Daniel Berteaud 0.3.0-1.sme
- Switch to php fpm, using PHP 7.1

- Support tt-rss 20170713
2016/02/16 Daniel Berteaud 0.2.11-1.sme
- Remove SESSION_CHECK_ADDRESS