├── .github └── workflows │ └── docker-publish.yml ├── Dockerfile ├── LICENSE ├── README.md └── entrypoint.sh /.github/workflows/docker-publish.yml: -------------------------------------------------------------------------------- 1 | name: Docker 2 | 3 | on: 4 | push: 5 | # Publish `master` as Docker `latest` image. 6 | branches: 7 | - master 8 | 9 | # Publish `v1.2.3` tags as releases. 10 | tags: 11 | - v* 12 | 13 | # Run tests for any PRs. 14 | pull_request: 15 | 16 | env: 17 | IMAGE_NAME: logrotate 18 | IMAGE_ALT_NAME: eu.gcr.io/linkyard-191615/linkyard-cloud/logrotate 19 | 20 | jobs: 21 | # Run tests. 22 | # See also https://docs.docker.com/docker-hub/builds/automated-testing/ 23 | test: 24 | runs-on: ubuntu-latest 25 | 26 | steps: 27 | - uses: actions/checkout@v2 28 | 29 | - name: Run tests 30 | run: | 31 | if [ -f docker-compose.test.yml ]; then 32 | docker-compose --file docker-compose.test.yml build 33 | docker-compose --file docker-compose.test.yml run sut 34 | else 35 | docker build . --file Dockerfile 36 | fi 37 | 38 | # Push image to GitHub Container Registry. 39 | push: 40 | # Ensure test job passes before pushing image. 41 | needs: test 42 | 43 | runs-on: ubuntu-latest 44 | if: github.event_name == 'push' 45 | 46 | steps: 47 | - uses: actions/checkout@v2 48 | 49 | - name: Build image 50 | run: docker build . --file Dockerfile --tag $IMAGE_NAME 51 | 52 | - name: Log into registry 53 | run: echo "${{ secrets.CR_PAT }}" | docker login ghcr.io -u ${{ secrets.CR_USER }} --password-stdin 54 | 55 | - name: Log into alternate registry 56 | run: echo "${{ secrets.GCR_JSON_KEY }}" | base64 -d | docker login eu.gcr.io -u _json_key --password-stdin 57 | 58 | - name: Push image 59 | run: | 60 | IMAGE_ID=ghcr.io/${{ github.repository_owner }}/$IMAGE_NAME 61 | 62 | # Change all uppercase to lowercase 63 | IMAGE_ID=$(echo $IMAGE_ID | tr '[A-Z]' '[a-z]') 64 | 65 | # Strip git ref prefix from version 66 | VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,') 67 | 68 | # Strip "v" prefix from tag name 69 | [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//') 70 | 71 | # Use Docker `latest` tag convention 72 | [ "$VERSION" == "master" ] && VERSION=latest 73 | 74 | echo IMAGE_ID=$IMAGE_ID 75 | echo VERSION=$VERSION 76 | 77 | docker tag $IMAGE_NAME $IMAGE_ID:$VERSION 78 | docker push $IMAGE_ID:$VERSION 79 | 80 | docker tag $IMAGE_NAME $IMAGE_ALT_NAME:$VERSION 81 | docker push $IMAGE_ALT_NAME:$VERSION 82 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM alpine:3.12 2 | 3 | RUN set -x \ 4 | && apk add --no-cache logrotate tini tzdata moreutils \ 5 | && rm /etc/logrotate.conf && rm -r /etc/logrotate.d \ 6 | && mv /etc/periodic/daily/logrotate /etc/.logrotate.cronjob 7 | 8 | COPY entrypoint.sh /entrypoint.sh 9 | 10 | VOLUME ["/logs"] 11 | 12 | ENTRYPOINT ["tini", "-g", "--"] 13 | CMD ["/entrypoint.sh"] 14 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![Docker](https://github.com/linkyard/docker-logrotate/workflows/Docker/badge.svg) 2 | 3 | # logrotate 4 | 5 | This is a docker container based on Alpine Linux with `logrotate`. 6 | 7 | ## Configuration 8 | 9 | Simply mount a directory with your logs into the container at `/logs` and optionally 10 | configure some logrotation features with the following environment variables: 11 | 12 | - `LOGROTATE_FILE_PATTERN` (default: `*.log`): File pattern within the `/logs` directory for logs 13 | to be rotated by `logrotate` 14 | - `LOGROTATE_TRUNCATE` (default: `copytruncate`): Truncation behaviour of logrotate, use either 15 | `copytruncate` or `nocopytruncate` 16 | - `LOGROTATE_COMPRESS` (default: `nocompress`): Compression behaviour for rotated files, use 17 | either `nocompress` or `compress` 18 | - `LOGROTATE_ROTATE` (default: `5`): The `rotate` option of logrotate 19 | - `LOGROTATE_SIZE` (default `50M`): the `size` option of logrotate 20 | 21 | If you want to use a different logrotate configuration, mount a `logrotate.conf` at `/etc/logrotate.conf` 22 | into the container. The environment variables mentioned above have no effect if you supply your own 23 | logrotate configuration file. 24 | 25 | By default, `logrotate` is run periodically every 15 minutes. You can override the cron schedule with 26 | the environment variable `LOGROTATE_CRON`. Use one of Alpine Linux' predefined periods 27 | (`15min`, `hourly`, `daily`, `weekly` or `monthly`) or specify a cron schedule expression like 28 | `5 4 * * *` (at 04:05 every day). If you are unsure about the cron schedule expression syntax, 29 | consult a tool like [crontab guru](https://crontab.guru/). 30 | 31 | ## Examples 32 | 33 | ```bash 34 | docker run \ 35 | -v /path/to/my/logs:/logs \ 36 | -e LOGROTATE_FILE_PATTERN="*.log" \ 37 | # don't rotate at all but truncate logs when they exceed the configured rotation size 38 | -e LOGROTATE_ROTATE="0" \ 39 | # run logrotate every 5 minutes 40 | -e LOGROTATE_CRON="*/5 0 0 0 0" \ 41 | linkyard:logrotate 42 | ``` 43 | 44 | ## Attribution 45 | 46 | This image is somewhat similar to the no longer maintained [blacklabelops/logrotate](https://github.com/blacklabelops/logrotate) 47 | but a lot simpler to use and maintain. 48 | 49 | 50 | # Usage 51 | It's double published (github and private gcr repo). 52 | 53 | `docker run ghcr.io/linkyard/logrotate` 54 | or 55 | `docker run eu.gcr.io/linkyard-191615/linkyard-cloud/logrotate` 56 | -------------------------------------------------------------------------------- /entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | TS_FORMAT="%Y-%m-%dT%H:%M:%S%z " 4 | 5 | if [ -e /etc/logrotate.conf ]; then 6 | echo "Using mounted /etc/logrotate.conf:" | ts "${TS_FORMAT}" 7 | else 8 | echo "Using templated /etc/logrotate.conf:" | ts "${TS_FORMAT}" 9 | { 10 | echo "/logs/${LOGROTATE_FILE_PATTERN:-*.log} {" 11 | echo " ${LOGROTATE_TRUNCATE:-copytruncate}" 12 | echo " ${LOGROTATE_COMPRESS:-nocompress}" 13 | echo " rotate ${LOGROTATE_ROTATE:-5}" 14 | echo " size ${LOGROTATE_SIZE:-50M}" 15 | echo "}" 16 | } > /etc/logrotate.conf 17 | fi 18 | ts "${TS_FORMAT}" < /etc/logrotate.conf 19 | 20 | if [ -d "/etc/periodic/${LOGROTATE_CRON:-15min}" ]; then 21 | echo "using /etc/periodic/${LOGROTATE_CRON:-15min} cron schedule" | ts "${TS_FORMAT}" 22 | mv /etc/.logrotate.cronjob "/etc/periodic/${LOGROTATE_CRON:-15min}/logrotate" 23 | else 24 | echo "assuming \"${LOGROTATE_CRON:-15min}\" is a cron expression; replacing root's crontab" | ts "${TS_FORMAT}" 25 | echo "${LOGROTATE_CRON:-15min} /etc/.logrotate.cronjob" > /var/spool/cron/crontabs/root 26 | fi 27 | 28 | # shellcheck disable=SC2086 29 | exec crond -d ${CROND_LOGLEVEL:-7} -f 2>&1 | ts "${TS_FORMAT}" 30 | --------------------------------------------------------------------------------