Browse Source

Documentation update

tags/0.6.0
J. King 7 months ago
parent
commit
37025bb49f
3 changed files with 25 additions and 14 deletions
  1. 3
    1
      CHANGELOG
  2. 2
    1
      README.md
  3. 20
    12
      UPGRADING

+ 3
- 1
CHANGELOG View File

@@ -1,15 +1,17 @@
Version 0.6.0 (????-??-??)
Version 0.6.0 (2019-01-21)
==========================

New features:
- Support for PostgreSQL databases
- Support for MySQL databases
- Validation of configuration parameters

Bug fixes:
- Use a general-purpose Unicode collation with SQLite databases

Changes:
- Improve performance of common database queries by 80-90%
- Make configuration defaults consistent with their defined types

Version 0.5.1 (2018-11-10)
==========================

+ 2
- 1
README.md View File

@@ -6,6 +6,7 @@ At present the software should be considered in an "alpha" state: though its cor

- Providing more sync protocols (Google Reader, Fever, others)
- Better packaging and configuration samples
- A user manual

## Requirements

@@ -75,7 +76,7 @@ Please refer to `CONTRIBUTING.md` for guidelines on contributing code to The Ars

Functionally there is no reason to prefer either SQLite or PostgreSQL over the other. SQLite is significantly simpler to set up in most cases, requiring only read and write access to a containing directory in order to function; PostgreSQL may perform better than SQLite when serving hundreds of users or more, though this has not been tested.

MySQL, on the other hand, is *not recommended* due to its relatively constrained index prefix limits which may cause some newsfeeds which would otherwise work to be rejected. If using MySQL, special care should also be taken when performing schema upgrades, as errors during the process can leave the database in a half-upgraded state which The Arsse cannot itself recover from.
MySQL, on the other hand, is **not recommended** due to its relatively constrained index prefix limits which may cause some newsfeeds which would otherwise work to be rejected. If using MySQL, special care should also be taken when performing schema upgrades, as errors during the process can leave the database in a half-upgraded state which The Arsse cannot itself recover from.

Note that MariaDB is not compatible with The Arsse: its support for common table expressions is, as of this writing, not sufficient for our needs.


+ 20
- 12
UPGRADING View File

@@ -1,41 +1,49 @@
General upgrade notes
=====================

When upgrading between any two versions of The Arsse, the following are usually prudent:
When upgrading between any two versions of The Arsse, the following are
usually prudent:

- Back up your database
- Check for any changes to sample Web server configuration
- Check for any changes to sample systemd unit or other init files
- If installing from source, update dependencies with `composer install -o --no-dev`
- If installing from source, update dependencies with:
`composer install -o --no-dev`


Upgrading from 0.5.1 to 0.6.0
=============================

- The database schema has changed from rev3 to rev4; if upgrading the database manually, apply the 3.sql file
- The database schema has changed from rev3 to rev4; if upgrading the database
manually, apply the 3.sql file
- Configuration is now validated for type and semantics: some previously
working configurations may no longer be accepted


Upgrading from 0.2.1 to 0.3.0
=============================

- The following Composer dependencies have been added:
- zendframework/zend-diactoros
- psr/http-message
- zendframework/zend-diactoros
- psr/http-message


Upgrading from 0.2.0 to 0.2.1
=============================

- The database schema has changed from rev2 to rev3; if upgrading the database manually, apply the 2.sql file
- The database schema has changed from rev2 to rev3; if upgrading the database
manually, apply the 2.sql file


Upgrading from 0.1.x to 0.2.0
=============================

- The database schema has changed from rev1 to rev2; if upgrading the database manually, apply the 1.sql file
- Web server configuration has changed to accommodate Tiny Tiny RSS; the following URL paths are affected:
- /tt-rss/api/
- /tt-rss/feed-icons/
- /tt-rss/images/
- The database schema has changed from rev1 to rev2; if upgrading the database
manually, apply the 1.sql file
- Web server configuration has changed to accommodate Tiny Tiny RSS; the
following URL paths are affected:
- /tt-rss/api/
- /tt-rss/feed-icons/
- /tt-rss/images/
- The following Composer dependencies have been added:
- jkingweb/druuid
- jkingweb/druuid

Loading…
Cancel
Save