selfoss

Copyright ⓒ 2015 Tobias Zeising, tobias.zeising@aditu.de
https://selfoss.aditu.de
Licensed under the GPLv3 license
Version 2.19-SNAPSHOT

DOWNLOAD

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

INSTALLATION

Upload all files of this folder (IMPORTANT: also upload the invisible .htaccess files)
Make the directories data/cache, data/favicons, data/logs, data/thumbnails and data/sqlite writeable
Insert database access data in config.ini (see below -- you don't have to change anything if you want to use sqlite)
You don't have to install the database, it will be created automatically (ensure that your database has enought rights for creating triggers)
Create cronjob for updating feeds and point it to https://yourselfossurl.com/update via wget or curl. You can also execute the cliupdate.php from commandline.

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://selfoss.aditu.de/forum/

CONFIGURATION

Copy defaults.ini to config.ini
Edit config.ini and delete any lines you do not wish to override
Do not delete the [globals] line
See https://selfoss.aditu.de/ for examples

UPDATE

Backup your database and your "data" folder
(IMPORTANT: don't delete the "data" folder) delete all old files and folders excluding the folder "data" and the file config.ini
Upload all new files and folders excluding the data folder (IMPORTANT: also upload the invisible .htaccess files)
Consult the NEWS file to learn about backwards incompatible changes.
Rename your folder /data/icons into /data/favicons
Clean your browser cache
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.
The database will be updated automatically (ensure that your database has enought rights for creating triggers)

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

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

SUPPORT

Issue tracker for reporting problems and requesting new features
Forum for general questions about usage
Chat on Gitter (or #selfoss:matrix.org mirror) for discussing selfoss development or just about anything

OPML Import

Selfoss supports importing OPML files. Find the OPML export in the old application, it is usually located somewhere in settings. Then visit the page https://yourselfossurl.com/opml and upload it there.

APPS

Two third party apps are available for Android: Selfoss and Reader For Selfoss.

DEVELOPMENT

Selfoss uses composer and npm for installing external libraries. When you clone the repository you have to issue composer install to retrieve the external sources.

For the client side, you will also need JavaScript dependencies installed by calling npm install in the assets directory. You can use npm run install-dependencies as a shortcut for installing both sets of dependencies.

We use Parcel (installed by the command above) to build the client side of selfoss. Every time anything in assets directory changes, you will need to run npm run build for the client to be built and installed into the public directory. When developing, you can also use npm run dev; it will watch for asset changes, rebuild the bundles as needed, and reload selfoss automatically.

If you want to create a package with all the dependencies bundled, you can run npm run dist command to produce a zipball.

Every patch is expected to adhere to our coding style, which is checked automatically by Travis. You can install the checkers locally either with your package manager or by calling utils/install-phars.sh, and then run the checks using npm run check before submitting a pull request.

CREDITS

Very special thanks to all contributors of pull requests here on github. Your improvements are awesome!!!

Special thanks to the great programmers of this libraries which will be used in selfoss:

Icon comes from http://www.artcoreillustrations.com/

Themroc/selfoss