Selfoss

selfoss is a multipurpose RSS reader and feed aggregation web application. It allows you to easily follow updates from different web sites, social networks and other platforms, all in single place. It is written in PHP, allowing you to run it basically anywhere.

For more information visit our web site.

Status

selfoss is currently maintained by Jan Tojnar in his free time. Due to the limited capacity, maintenance is prioritized over new features. Pull requests are welcome, see the Contributing guide.

Download

• Stable releases – if you just want to use selfoss.
• Development builds – if you want to try unreleased features or bug fixes, or help testing them. Hosted by Cloudsmith
• Git-tracked source code – if you want to join selfoss development. Some assembly required.

Installation

1. Upload all files of this directory (IMPORTANT: also upload the invisible .htaccess files).
2. Make the directories data/cache, data/favicons, data/logs, data/thumbnails and data/sqlite writeable.
3. Insert database access data in config.ini (see below). You do not need to change anything if you want to use SQLite.
4. You do not need to create the database tables, they will be created automatically (ensure that your database user is allowed to create triggers).
5. Create cronjob or systemd timer for updating feeds and point it to https://yourselfossurl.com/update via wget or curl. You can also execute the cliupdate.php from command line.

If you obtained selfoss using Git, some more steps will be required. See the development section.

For further questions or on any problem use our support forum: https://forum.selfoss.aditu.de/

Configuration

No configuration is needed to use selfoss but you can customize the settings as follows:

1. Rename config-example.ini to config.ini.
2. Edit config.ini and delete any lines you do not wish to override.
3. See https://selfoss.aditu.de/ for examples.

Update

1. Backup your database and your data/ directory.
2. (IMPORTANT: do NOT delete the data/ directory) delete all old files and directories excluding the directory data/ and the file config.ini
3. Upload all new files and directories excluding the data/ directory (IMPORTANT: also upload the invisible .htaccess files).
4. Consult the NEWS file to learn about backwards incompatible changes.
5. Clean your browser cache.
6. Insert your current database connection and your individual configuration in config.ini. Important: we change the config.ini and add new options in newer versions. You have to update the config.ini too.
7. The database will be updated automatically (ensure that your database u