Merge pull request #13 from Shuliyey/feature/tzdata

Introduce tzdata, TZ environment variable will take effect (when tzdata is installed)

Author: Steffen Bleul

Dockerfile

@@ -15,7 +15,8 @@ RUN export CONTAINER_USER=logrotate && \
     apk add --update \
       tar \
       gzip \
-      wget && \
+      wget \
+      tzdata && \
     if  [ "${LOGROTATE_VERSION}" = "latest" ]; \
       then apk add logrotate ; \
       else apk add "logrotate=${LOGROTATE_VERSION}" ; \

README.md

@@ -56,6 +56,8 @@ $ docker run -d \
   blacklabelops/logrotate
 ~~~~
 
+> This will logrotate any logfile(s) under /var/lib/docker/containers, /var/log/docker (or subdirectories of them).
+
 # Customize Log File Ending
 
 You can define the file endings fluentd will attach to. The container will by default crawl for
@@ -97,6 +99,8 @@ $ docker run -d \
   blacklabelops/logrotate
 ~~~~
 
+> This will logrotate logfile(s) on hourly basis.
+
 # Set the Number of Rotations
 
 The default number of rotations is five. Further rotations will delete old logfiles. You
@@ -135,6 +139,8 @@ $ docker run -d \
   blacklabelops/logrotate
 ~~~~
 
+> This will logrotate when logfile(s) reaches 10M+.
+
 # Set Log File compression
 
 The default logrotate setting is `nocompress`. In order to enable logfile compression
@@ -151,6 +157,8 @@ $ docker run -d \
   blacklabelops/logrotate
 ~~~~
 
+> This will compress the logrotated logs.
+
 # Set the Output directory
 
 By default, logrotate will rotate logs in their respective directories. You can
@@ -187,6 +195,8 @@ $ docker run -d \
   blacklabelops/logrotate
 ~~~~
 
+> This will logrotate on go-cron schedule \* \* \* \* \* \* (every second).
+
 # Log and View the Logrotate Output
 
 You can specify a logfile for the periodical logrotate execution. The file
@@ -206,7 +216,7 @@ $ docker run -d \
   blacklabelops/logrotate
 ~~~~
 
-> You will be able to see logrotate output every minute in file logs/logrotatecron.log
+> You will be able to see logrotate output every minute in file logs/logrotatecron.log.
 
 # Logrotate Commandline Parameters
 
@@ -270,12 +280,11 @@ $ docker run -d \
   blacklabelops/logrotate
 ~~~~
 
-> You will be able to see cron output every minute in file logs/cron.log
-
+> You will be able to see cron output every minute in file logs/cron.log.
 
 # Setting a Date Extension
 
-With Logrotate it is possible to split files and name them by the date they were generated when used with `LOGROTATE_CRONSCHEDULE`. By setting `LOGROTATE_DATEFORMAT` you will enable the Logrotate `dateext` option.
+With Logrotate it is possible to split files and name them by the date they were generated when used with `LOGROTATE_DATEFORMAT`. By setting `LOGROTATE_DATEFORMAT` you will enable the Logrotate `dateext` option.
 
 The default Logrotate format is `-%Y%m%d`, to enable the defaults `LOGROTATE_DATEFORMAT` should be set to this.
 
@@ -292,6 +301,8 @@ $ docker run -d \
   blacklabelops/logrotate
 ~~~~
 
+> This will set logrotate to split files and name them by date format -%Y%m%d.
+
 # Disable Auto Update
 
 With Logrotate by default it auto update its logrotate configuration file to ensure it only captures all the intended log file in the `LOGS_DIRECTORIES` (before it rotates the log files). It is possible to disable auto update when used with `LOGROTATE_AUTOUPDATE`. By setting `LOGROTATE_AUTOUPDATE` (to not equal true) you will disable the auto update of Logrotate.
@@ -309,9 +320,30 @@ docker run -d \
   blacklabelops/logrotate
 ~~~~
 
+> This will disable logrotate configuration file update (when logrotate action is triggering).
+
+# Set Time Zone
+
+With Logrotate by default it logrotate logs in `UTC` time zone. It is possible to set time zone when used with `TZ`. By setting `TZ` (to a valid time zone) it will logrotate logs in the specified time zone.
+
+The default `TZ` is `""`, to set to different time zone. E.g `Australia/Melbourne`.
+
+Example:
+
+~~~~
+docker run -d \
+  -v /var/lib/docker/containers:/var/lib/docker/containers \
+  -v /var/log/docker:/var/log/docker \
+  -e "LOGS_DIRECTORIES=/var/lib/docker/containers /var/log/docker" \
+  -e "TZ=Australia/Melbourne" \
+  blacklabelops/logrotate
+~~~~
+
+> This will logrotate in Australia/Melbourne time zone.
+
 ## Used in Kubernetes
 
-When we run container in Kubernetes, we can use the logrotate container to rotate the logs. As we create 
+When we run container in Kubernetes, we can use the logrotate container to rotate the logs. As we create
 
 an DaemonSet in cluster ,we can deploy an logrotate container in every nodes of the cluster.