From e5235460f1749288fd65d0765203c6c39d0cfe5c Mon Sep 17 00:00:00 2001 From: Dmitrii Date: Fri, 24 May 2024 14:27:19 +0200 Subject: [PATCH] Initial commit --- .gitignore | 1 + LICENSE | 201 ++++++++++++++++++++++++ Makefile | 44 ++++++ README.md | 138 ++++++++++++++++ files/LICENSE | 201 ++++++++++++++++++++++++ files/cloudflared-remote-access.service | 38 +++++ 6 files changed, 623 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 README.md create mode 100644 files/LICENSE create mode 100644 files/cloudflared-remote-access.service diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..567609b --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +build/ 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/Makefile b/Makefile new file mode 100644 index 0000000..049ae74 --- /dev/null +++ b/Makefile @@ -0,0 +1,44 @@ +# SPDX-FileCopyrightText: 2024 Enapter +# SPDX-License-Identifier: Apache-2.0 + +SKOPEO_COPY ?= skopeo copy --insecure-policy +UMOUNT ?= umount +MKSQUASHFS ?= mksquashfs +MKDIR ?= mkdir +CP ?= cp +LN ?= ln +CD ?= cd +RM ?= rm + +CLOUDFLARED_VERSION ?= 2024.5.0 + +PROJECT_ROOT ?= `pwd` +LAYER_TMP ?= "$(PROJECT_ROOT)/build/cloudflared-remote-access-layer" +LAYER_TMP_ROOTFS = "$(LAYER_TMP)/rootfs" +LAYER_TMP_IMAGES = "$(LAYER_TMP)/images" + +LAYER_PATH ?= build/cloudflared-remote-access.img + +SKOPEO_TARGET = "overlay@$(LAYER_TMP_IMAGES)" + +build: + $(MKDIR) -p $(LAYER_TMP) + $(SKOPEO_COPY) docker://cloudflare/cloudflared:$(CLOUDFLARED_VERSION) containers-storage:[$(SKOPEO_TARGET)]cloudflared:latest + $(UMOUNT) $(LAYER_TMP_IMAGES)/overlay || true + $(MKDIR) -p $(LAYER_TMP_ROOTFS) + $(MKDIR) -p $(LAYER_TMP_ROOTFS)/usr/lib/systemd/system/ + $(MKDIR) -p $(LAYER_TMP_ROOTFS)/etc/systemd/system/default.target.wants/ + $(MKDIR) -p $(LAYER_TMP_ROOTFS)/etc/systemd/system/multi-user.target.wants/ + $(CP) $(PROJECT_ROOT)/files/cloudflared-remote-access.service $(LAYER_TMP_ROOTFS)/usr/lib/systemd/system/cloudflared-remote-access.service + $(LN) -s /usr/lib/systemd/system/cloudflared-remote-access.service $(LAYER_TMP_ROOTFS)/etc/systemd/system/default.target.wants/cloudflared-remote-access.service + $(LN) -s /usr/lib/systemd/system/cloudflared-remote-access.service $(LAYER_TMP_ROOTFS)/etc/systemd/system/multi-user.target.wants/cloudflared-remote-access.service + $(MKSQUASHFS) $(LAYER_TMP) $(LAYER_PATH) -noappend -comp lzo -all-root + +.PHONY: build + +clean: + $(UMOUNT) $(LAYER_TMP_IMAGES)/overlay || true + $(RM) -f $(LAYER_PATH) + $(RM) -rf $(LAYER_TMP) + +.PHONY: clean diff --git a/README.md b/README.md new file mode 100644 index 0000000..ca64849 --- /dev/null +++ b/README.md @@ -0,0 +1,138 @@ +# Enapter Industrial Linux - Layer Example + +This repository provides an example of how to create a custom layer for [Enapter Industrial Linux](https://github.com/Enapter/enapter-industrial-linux). The example layer includes a systemd service and a Docker container. + +## About Enapter Industrial Linux + +Enapter Industrial Linux (EIL) is a robust and minimalistic Linux distribution optimized for industrial IoT and embedded devices. + +### Key Features + +- **Reliable and Secure**: Utilizes an overlayfs with a SquashFS root image for read-only root, aiding in system stability and reliability. + +- **Power Failure Tolerance**: System files are read-only, reducing the risk of corruption during power failures. + +- **USB Stick Boot**: Easily boot from a USB stick with a simple FAT32 partition. + +- **Service Discovery**: Built-in service for device discovery in the network. + +- **Docker Integration**: Easily run third-party programs and services inside Docker containers using Podman. + +- **Flexible Layer System**: Introducing the concept of layers for modular and scalable system enhancements. Add functionality using layers with systemd services, Docker containers, and more. + +## Requirements + +To build the example layer, you need the following utilities installed. These require a Linux environment, Windows Subsystem for Linux (WSL) on Windows, or MacOS. + +* **make utility**: [GNU Make](https://www.gnu.org/software/make/) + + Install on **Ubuntu/Debian**: + + + ```sh + sudo apt-get install make + ``` + + Install on **Fedora**: + + ```sh + sudo dnf install make + ``` + Install on **MacOS** (using Homebrew): + + ```sh + brew install make + ``` + +* **skopeo utility**: [Skopeo](https://github.com/containers/skopeo) + + Install on **Ubuntu/Debian**: + + ```sh + sudo apt-get install skopeo + ``` + + Install on **Fedora**: + + ```sh + sudo dnf install skopeo + ``` + + Install on **MacOS** (using Homebrew): + + ```sh + brew install skopeo + ``` + +* **mksquashfs utility**: Part of the [SquashFS tools](https://github.com/plougher/squashfs-tools) + + Install on **Ubuntu/Debian**: + + ```sh + sudo apt-get install squashfs-tools + ``` + + Install on **Fedora**: + + ```sh + sudo dnf install squashfs-tools + ``` + + Install on **MacOS** (using Homebrew): + + ```sh + brew install squashfs + ``` + +## Custom Layers + +Layers are SquashFS images containing additional software and services. Each layer has: + +- `rootfs/`: Directory structure overlaid on the root filesystem. + +- `images/`: Docker container registry for including pre-packaged containers. + +## Example Layer: Adding a Systemd Service and Docker Container + +### Layer Directory Structure + +``` +cloudflared-remote-access-layer/ +├── rootfs/ +│ ├── usr/ +│ ├── lib/ +│ │ ├── systemd/ +│ │ └── system/ +│ │ └── cloudflared-remote-access.service +│ ├── etc/ +│ ├── systemd/ +│ │ ├── system/ +│ │ │ ├── default.target.wants/ +│ │ │ │ └── cloudflared-remote-access.service -> /usr/lib/systemd/system/cloudflared-remote-access.service +│ │ │ └── multi-user.target.wants/ +│ │ │ └── cloudflared-remote-access.service -> /usr/lib/systemd/system/cloudflared-remote-access.service +└── images/ + ├── # (Docker container registry structure will be created by 'skopeo copy')` +``` + +### Build Process + +1. **Prepare your USB stick**: + - Use [Etcher](https://etcher.balena.io) utility or `dd` Linux utility to flash `.img` image of [Enapter Industrial Linux](https://github.com/Enapter/enapter-industrial-linux/releases/download/v3.0.0-dev1/enapter-linux-v3.0.0-dev1.zip) onto USB stick. + +2. **Create and deploy your layer**: + - Structure your layer as shown. Please check the `Makefile` in this repository as an example + - Use `mksquashfs` to create the SquashFS image. + - Copy the SquashFS image to the USB stick into `layers/` directory (create it if not exists). + +3. **Insert the USB stick and boot**. + +The system will boot, mount the USB in read-only mode, and overlay your custom layer to provide the additional functionality. + +## Conclusion + +This example demonstrates how to extend Enapter Industrial Linux using custom layers. By leveraging the robustness of read-only filesystems and the flexibility of overlayfs, you can easily add new functionalities, such as systemd services and Docker containers, without modifying the core system files. + +## Support + +For any questions, feel free to reach out to us at [developers@enapter.com](mailto:developers@enapter.com) or join our community on [Discord](https://discord.com/invite/TCaEZs3qpe). diff --git a/files/LICENSE b/files/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/files/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/files/cloudflared-remote-access.service b/files/cloudflared-remote-access.service new file mode 100644 index 0000000..70f9bdd --- /dev/null +++ b/files/cloudflared-remote-access.service @@ -0,0 +1,38 @@ +[Unit] +Description=Cloudflared Remote Access Service +ConditionPathExists=/user/etc/cloudflared-remote-access.env +After=network-online.target local-fs.target +StartLimitIntervalSec=0 + +[Service] +Environment=PODMAN_SYSTEMD_UNIT=%n +EnvironmentFile=/user/etc/cloudflared-remote-access.env +Type=forking + +KillMode=mixed +Restart=on-failure +TimeoutStopSec=30 +RestartSec=10 + +ExecStartPre=/bin/rm -f %t/container-%N.pid %t/container-%N.ctr-id + +ExecStart=/usr/bin/podman run \ + --conmon-pidfile %t/container-%N.pid \ + --cidfile %t/container-%N.ctr-id \ + --detach \ + --rm \ + --log-driver=journald \ + --log-opt=tag="{{.Name}}" \ + --replace \ + --network=host \ + --privileged \ + --name %N \ + cloudflared:latest \ + tunnel --no-autoupdate run --token ${CLOUDFLARED_REMOTE_ACCESS_TOKEN} + +ExecStop=/usr/bin/podman stop --ignore --cidfile %t/container-%N.ctr-id -t 10 + +PIDFile=%t/container-%N.pid + +[Install] +WantedBy=multi-user.target default.target