Installation Notes

New installation

  • Identify your database server (PostgreSQL or MySQL) connection parameters - e.g. database name, user, password.
  • Install database schema (schema/ttrss_schema_XXXX.sql) - the exact method of doing this varies on what you have available, e.g. you can use command line database client if you have shell access or some web frontend like phpMyAdmin.
  • Copy config.php-dist to config.php and edit it (you have to fill in database configuration parameters, but it is recommended to look over entire configuration file)
  • When editing config.php you'll have to decide on updating method. Please read UpdatingFeeds.
  • Open tt-rss in your browser and login with default username/password (see README.txt). Don't forget to change the password!

Upgrade from previous version

  • Backup your database!
  • Unpack the new tarball and replace tt-rss files with new ones
  • Check config.php-dist for new options and copy them into your config.php, updating CONFIG_VERSION if needed
  • Reload tt-rss in your browser
    • If database upgrade is required, tt-rss will prompt you to perform it (should be self-explanatory, just click "update" button)
    • If not, just start using tt-rss as usual
  • Immediately after upgrade you can get all sorts of weird bugs, because some scripts and whatsuch could have stuck in your browser cache. Closing and opening your browser and refreshing several times usually helps.
  • If the database schema update is required and the updater fails for some reason, you can apply schema diffs manually. Go from the schema version reported by updater and apply all needed schema version diffs (they are placed in schema/versions/(YOURDB) consecutively either using database console frontend or some other tool (e.g. phpMyAdmin and such). E.g. if the updater reports schema version 35, you'll need to install all files with a number larger than 35 in their name - e.g. 36.sql, 37.sql et cetera in ascending order. DO NOT INSTALL DIFFS IN ANY OTHER ORDER!

Upgrading issues (for old versions ONLY)

See ObsoleteInstallationNotes

Other issues

  • icons directory should be writable to your http server user (w.g. www-data) if you plan on using feed icons
  • Leave DB_HOST empty if you want to connect to database via unix socket
  • For PostgreSQL don't forget to create database with UTF-8 encoding 
    createdb -E utf-8 -O owner_user database
  • Don't forget to change your password from default value on your first login
  • Check your config.php for blank lines out of PHP code tags (e.g. before <? and after ?>), See #1

See also: Upgrading107to11, KnownBugs