From e3a61355880636dd7f63940b8a64df1419ba0d3e Mon Sep 17 00:00:00 2001 From: irul Date: Tue, 6 May 2025 15:31:08 +0000 Subject: [PATCH] feat: init project --- .devcontainer/devcontainer.json | 22 ++++ Dockerfile | 14 +++ LICENSE | 201 ++++++++++++++++++++++++++++++++ README.md | 62 ++++++++++ docker-compose.yml | 18 +++ entrypoint.sh | 11 ++ html/index.html | 1 + html/index_full.html | 56 +++++++++ html/index_mini.html | 1 + 9 files changed, 386 insertions(+) create mode 100644 .devcontainer/devcontainer.json create mode 100644 Dockerfile create mode 100644 LICENSE create mode 100644 README.md create mode 100644 docker-compose.yml create mode 100755 entrypoint.sh create mode 100644 html/index.html create mode 100644 html/index_full.html create mode 100644 html/index_mini.html diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 0000000..23ff077 --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,22 @@ +// For format details, see https://aka.ms/devcontainer.json. For config options, see the +// README at: https://github.com/devcontainers/templates/tree/main/src/debian +{ + "name": "Debian", + // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile + "image": "mcr.microsoft.com/devcontainers/base:bullseye", + "features": { + "ghcr.io/devcontainers/features/docker-in-docker:2": {} + } + + // Features to add to the dev container. More info: https://containers.dev/features. + // "features": {}, + + // Use 'forwardPorts' to make a list of ports inside the container available locally. + // "forwardPorts": [], + + // Configure tool-specific properties. + // "customizations": {}, + + // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root. + // "remoteUser": "root" +} diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..d5a2bb0 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,14 @@ +FROM busybox +LABEL maintainer="Irul " +COPY html/index.html entrypoint.sh / +ENV MESSAGE="Sorry for the inconvenience but we\’re performing some maintenance at the moment. If you need to you can always {{contact}}<\/a>, otherwise we\’ll be back online shortly!" +ENV HEADLINE="We\’ll be back soon!" +ENV MAIL_ADDRESS=mail@example.com +ENV PORT=8080 +ENV TEAM_NAME="The Team" +ENV TITLE="Site Maintenance" +ENV LINK_COLOR="#dc8100" +ENV THEME="Light" +ENV RESPONSE_CODE="503 Service Unavailable" +ENV CONTACT_LINK="contact us" +ENTRYPOINT [ "./entrypoint.sh" ] \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..0f15a05 --- /dev/null +++ b/README.md @@ -0,0 +1,62 @@ +# Maintenance + +A simple maintenance page in a simple docker image. + +## Contents + + 1. Introduction + - Environment variables. + 2. Docker. + 3. Docker Compose. + +## Introduction +This image came as a result for the need to place a simple maintenance page in times of server downtime or maintenance. The main requirement was to use a simple static HTML file. + + #### Environment variables + We introduced a few variables that would change different parts of the maintenance page as shown below. + +|Variable|Description | +|--|--| +|`TITLE`|Modifies the site *title* displayed. Defaults to `Site Maintenance`| +|`HEADLINE`| H1 headline Defaults to `We'll be back soon!` | +|`MESSAGE`| Page message Defaults to `Sorry for the inconvenience but we're performing some maintenance at the moment. If you need to you can always {{contact}}, otherwise we'll be back online shortly!`.

**Note**: include `{{contact}}` in your custom message as placeholder for the contact link. | +|`CONTACT_LINK`| Set the word you want to use instead of the default `contact us`. | +|`MAIL_ADDRESS`| This modifies the email address provided for the *contact us* link in the page. Defaults to `mail@example.com`| +|`TEAM_NAME`| Modifies the *team* or *company name* displayed on the page. Defaults to `The Team`| +|`LINK_COLOR`|Modifies the link color for the *contact us* link. Defaults to `#dc8100` | +|`THEME`|Modifies page theme current options `Light` or `Dark`. Defaults to `Light` +|`RESPONSE_CODE`| Specifies the HTTP response code to serve with the maintenance page. Defaults to `503 Service Unavailable` | +|`PORT`| Specifies the port to serve the maintenance page. Defaults to `8080` | + +## Docker +You can easily run or create a docker container for this [image](https://git.libra.bteklabs.com/irul/maintenance) by using the command: + +`docker run -p 80:8080 git.libra.bteklabs.com/irul/maintenance` + +This will serve the *default* static maintenance page on port 80 of the host machine. You can modify specific variables within the run command which would then look like: + +`docker run -e TEAM_NAME='Team name' -e TITLE='Oops!' -e MAIL_ADDRESS=mail@domain.com -e PORT=9000 --rm -p 80:9000 git.libra.bteklabs.com/irul/maintenance` + +## Docker Compose +For docker compose, you can choose to refer to the *docker-compose.yml* file in the [repo](https://git.libra.bteklabs.com/irul/maintenance) or you can have look at the example below. +``` +version: '3.5' + +services: + maintenance: + image: git.libra.bteklabs.com/irul/maintenance + container_name: maintenance-page + environment: + TEAM_NAME: "Team name" + TITLE: "Oops!" + MAIL_ADDRESS: "mail@domain.com" + LINK_COLOR: "#dc8100" + THEME: "Light" + PORT: 8080 + RESPONSE_CODE: "503 Service Unavailable" + MESSAGE: "This is my custom message. {{contact}} now" + CONTACT_LINK: "contact us" + ports: + - 80:8080 +``` + diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..e06e1ec --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,18 @@ +version: '3.5' + +services: + maintenance: + image: git.libra.bteklabs.com/irul/maintenance + container_name: maintenance-page + environment: + TEAM_NAME: "Team name" + TITLE: "Oops!" + MAIL_ADDRESS: "mail@domain.com" + LINK_COLOR: "#dc8100" + THEME: "Light" + PORT: 8080 + RESPONSE_CODE: "503 Service Unavailable" + MESSAGE: "Sorry for the inconvenience but we're performing some maintenance at the moment. If you need to you can always {{contact}}, otherwise we'll be back online shortly!" + CONTACT_LINK: "contact us" + ports: + - 8080:8080 \ No newline at end of file diff --git a/entrypoint.sh b/entrypoint.sh new file mode 100755 index 0000000..962642b --- /dev/null +++ b/entrypoint.sh @@ -0,0 +1,11 @@ +#! /bin/sh +sed -i "s/{{message}}/$(echo ${MESSAGE})/g" index.html +sed -i "s/{{contact}}/$(echo ${CONTACT_LINK})/g" index.html +sed -i "s/{{mail}}/$(echo ${MAIL_ADDRESS})/g" index.html +sed -i "s/{{headline}}/$(echo ${HEADLINE})/g" index.html +sed -i "s/{{team_name}}/$(echo ${TEAM_NAME})/g" index.html +sed -i "s/{{title}}/$(echo ${TITLE})/g" index.html +sed -i "s/{{theme}}/$(echo ${THEME})/g" index.html +sed -i "s/{{link_color}}/$(echo ${LINK_COLOR})/g" index.html + +while true; do { echo -e "HTTP/1.1 ${RESPONSE_CODE}\r\n"; echo "$(cat index.html)"; } | nc -lvp "$PORT"; done \ No newline at end of file diff --git a/html/index.html b/html/index.html new file mode 100644 index 0000000..efd3d4e --- /dev/null +++ b/html/index.html @@ -0,0 +1 @@ +{{title}}

{{headline}}

{{message}}

—{{team_name}}

\ No newline at end of file diff --git a/html/index_full.html b/html/index_full.html new file mode 100644 index 0000000..4ecff18 --- /dev/null +++ b/html/index_full.html @@ -0,0 +1,56 @@ + + + + + {{title}} + + + + + +
+

{{headline}}

+
+

{{message}}

+

— {{team_name}}

+
+
+ + \ No newline at end of file diff --git a/html/index_mini.html b/html/index_mini.html new file mode 100644 index 0000000..97c4e9e --- /dev/null +++ b/html/index_mini.html @@ -0,0 +1 @@ + {{title}}

{{headline}}

{{message}}

—{{team_name}}

\ No newline at end of file