Documentation update

README.md

@@ -11,7 +11,7 @@ instances.
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 **Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
 
-- [Upgrading to 2.0.0](#upgrading-to-200)
+- [Upgrading to 2.x](#upgrading-to-2x)
 - [Features](#features)
 - [Philosophy](#philosophy)
 - [Documentation](#documentation)
@@ -20,10 +20,11 @@ instances.
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
-## Upgrading to 2.0.0
+## Upgrading to 2.x
 
-There are many breaking changes in the configuration between 1.8 and 2.0. Please
-check carefully the list of breaking changes here: [Change Log](CHANGELOG.md).
+There are many breaking changes in the configuration between 1.8 and 2.x. Please
+check carefully the list of breaking changes here:
+[Change Log](CHANGELOG.md#200).
 
 Packages also now default to using a `log-courier` user. If you require the old
 behaviour of `root`, please be sure to modify the `/etc/sysconfig/log-courier`

docs/PublicRepositories.md

@@ -16,6 +16,12 @@
 There are pre-built Log Courier packages readily available in public
 repositories for RedHat, CentOS and Ubuntu.
 
+Log Courier is pre-configured to run as a user called `log-courier`, and this
+user will need to be given the necessary permissions to access the log files
+you wish to ship. Alternatively, Log Courier can be reconfigured to run as any
+other user. See the repository description for your platform for notes on how
+to do this.
+
 ## Redhat / CentOS
 
 *The Log Courier repository depends on the __EPEL__ repository which can be
@@ -33,8 +39,9 @@ then be installed using `yum install log-courier`.
 [driskell-log-courier2-epel-7.repo](https://copr.fedoraproject.org/coprs/driskell/log-courier2/repo/epel-7/driskell-log-courier2-epel-7.repo)
 
 Once installed, create a configuration file at
-`/etc/log-courier/log-courier.conf` to suit your needs, then start the Log
-Courier service to begin shipping.
+`/etc/log-courier/log-courier.yaml` to suit your needs. If you need to change
+the user that Log Courier runs as, edit `/etc/sysconfig/log-courier`. Then when
+you're all set, start the Log Courier service to begin shipping.
 
     service log-courier start
 
@@ -48,8 +55,9 @@ To install the Log Courier apt-get repository, run the following commands.
 Log Courier may then be installed using `apt-get install log-courier`.
 
 Once installed, create a configuration file at
-`/etc/log-courier/log-courier.conf` to suit your needs, then start the Log
-Courier service to begin shipping.
+`/etc/log-courier/log-courier.yaml` to suit your needs. If you need to change
+the user that Log Courier runs as, edit `/etc/default/log-courier`. Then when
+you're all set, start the Log Courier service to begin shipping.
 
     service log-courier start
 
@@ -70,3 +78,7 @@ configuration files for CentOS or RedHat.
 [driskell-log-courier-epel-7.repo](https://copr.fedoraproject.org/coprs/driskell/log-courier/repo/epel-7/driskell-log-courier-epel-7.repo)
 
 For Ubuntu, use `ppa:devel-k/log-courier` instead of `ppa:devel-k/log-courier2`.
+
+In contract to the current packages, the version 1.x packages refer to a JSON
+configuration file at `/etc/log-courier/log-courier.conf` and always run as the
+`root` user.