fix: move README outside

2025-01-26 12:00:51 +07:00
parent be7afadf50
commit 70b1416b77
1 changed files with 0 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,274 @@
+<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
+<a id="readme-top"></a>
+<!--
+*** Thanks for checking out the Best-README-Template. If you have a suggestion
+*** that would make this better, please fork the repo and create a pull request
+*** or simply open an issue with the tag "enhancement".
+*** Don't forget to give the project a star!
+*** Thanks again! Now go create something AMAZING! :D
+-->
+
+
+
+<!-- PROJECT SHIELDS -->
+<!--
+*** I'm using markdown "reference style" links for readability.
+*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
+*** See the bottom of this document for the declaration of the reference variables
+*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
+*** https://www.markdownguide.org/basic-syntax/#reference-style-links
+-->
+
+
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+
+[//]: # (  <a href="https://github.com/othneildrew/Best-README-Template">)
+
+[//]: # (    <img src="images/logo.png" alt="Logo" width="80" height="80">)
+
+[//]: # (  </a>)
+
+<h3 align="center">Caddy Manager</h3>
+
+  <p align="center">
+    A UI for managing Caddy configuration files
+    <br />
+    <a href="https://github.com/othneildrew/Best-README-Template"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://github.com/othneildrew/Best-README-Template">View Demo</a>
+    &middot;
+    <a href="https://github.com/othneildrew/Best-README-Template/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
+    &middot;
+    <a href="https://github.com/othneildrew/Best-README-Template/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
+  </p>
+</div>
+
+
+
+<!-- TABLE OF CONTENTS -->
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+      <ul>
+        <li><a href="#built-with">Built With</a></li>
+      </ul>
+    </li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#prerequisites">Prerequisites</a></li>
+        <li><a href="#installation">Installation</a></li>
+      </ul>
+    </li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#roadmap">Roadmap</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+    <li><a href="#acknowledgments">Acknowledgments</a></li>
+  </ol>
+</details>
+
+
+
+<!-- ABOUT THE PROJECT -->
+## About The Project
+
+[//]: # ([![Product Name Screen Shot][product-screenshot]]&#40;https://example.com&#41;)
+
+Caddy Management is an opinionated UI for managing Caddy configuration files. It is designed to be simple and easy to use. The architecture is based on the following principles:
+- There has been a Caddy container running on the host machine
+- The Caddy container is having its configuration files organized as:
+  - A Caddyfile contains the global configuration, and ending with the line `import *.caddy` 
+  - Other proxy configurations are saved in individual `*.caddy` files
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+### Built With
+
+[![DotNet][DotNet]][DotNet-url]
+[![Gitea][Gitea]][Gitea-url]
+[![Docker][Docker]][Docker-url]
+
+* DotNet 9 with Blazor and [MudBlazor](https://mudblazor.com/)
+* Source code and container registry are stored with Gitea
+* Docker is used for containerization with DotNet container publishing
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- GETTING STARTED -->
+## Getting Started
+
+Given that there has already been a Caddy container running on the host machine, the following steps are required to set up the Caddy Manager using Docker compose.
+
+### Prerequisites
+
+These software are required to be installed on the host machine:
+* Docker. Follow the instructions at [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/)
+* Caddy container. Follow the instructions at [https://caddyserver.com/docs/install](https://caddyserver.com/docs/install#docker)
+* The Caddy container is having its configuration files organized at:
+  ```yaml
+  volumes:
+    - /path/to/configs:/etc/caddy
+  ```
+
+### Installation
+
+This repository can be cloned and then built with DotNet. Using the `dotnet publish` command can have the container image built and pushed to the registry.
+
+1. Clone the repo
+   ```shell
+   git clone https://pikachu-gitea.duydao.org/ebolo/CaddyManager.git
+   cd CaddyManager
+   ```
+2. Login to the container registry
+   ```shell
+   docker login -u $USER_NAME $REGISTRY_URL
+   ```
+3. Build and publish container with DotNet
+   ```shell
+   dotnet publish --os linux --arch x64 /t:PublishContainer -p ContainerRegistry=$REGISTRY_URL
+   ```
+
+Then the container can be run with Docker compose:
+```yaml
+services:
+  caddy:
+    image: $REGISTRY_URL/ebolo/caddy-manager:latest
+    container_name: caddy-manager
+    restart: always
+    environment:
+      - Caddy__ConfigDir=/config # The directory where Caddy configuration files are stored
+      - Docker__CaddyContainerName=caddy # The name of the Caddy container
+    user: "${UID}:${GID}"
+    # The user and group ID of the host user having the permission to write to the Caddy configuration directory
+    ports:
+      - "8080:8080"
+    volumes:
+      - /root/compose/caddy/config:/config
+      - /var/run/docker.sock:/var/run/docker.sock
+
+```
+
+Example of `.env` file. The `UID` and `GID` are the user and group ID of the host user having the permission to write to the Caddy configuration directory:
+```shell
+UID=1000
+GID=1000
+```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- USAGE EXAMPLES -->
+## Usage
+
+TBU.
+
+Currently, the Caddy Manager is able to:
+- List all the Caddy configuration files
+- Edit the content of the Caddy configuration files by clicking on the file name
+- Create a new Caddy configuration file by clicking on the "New" button
+- Delete a Caddy configuration file by clicking on the "Delete" button
+- Edit the global Caddy configuration file by using the tab "Global Cadddyfile"
+- Have the Caddy container be restarted by clicking on the "Restart" button
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- ROADMAP -->
+## Roadmap
+
+- [ ] Parse the caddy files to get more information, i.e. the domain names, the proxy addresses, etc.
+
+See the [open issues](https://pikachu-gitea.duydao.org/ebolo/CaddyManager/issues) for a full list of proposed features (and known issues).
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- CONTRIBUTING -->
+## Contributing
+
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
+Don't forget to give the project a star! Thanks again!
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+
+<!-- LICENSE -->
+## License
+
+Distributed under the GNU GPLv3 License. See `COPYING` for more information.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- CONTACT -->
+## Contact
+
+Ebolo - [@duydao](https://duydao.org) - daothanhduy305@gmail.com
+
+Project Link: [CaddyManager](https://pikachu-gitea.duydao.org/ebolo/CaddyManager)
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- ACKNOWLEDGMENTS -->
+## Acknowledgments
+
+Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!
+
+* [Choose an Open Source License](https://choosealicense.com)
+* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
+* [Malven's Flexbox Cheatsheet](https://flexbox.malven.co/)
+* [Malven's Grid Cheatsheet](https://grid.malven.co/)
+* [Img Shields](https://shields.io)
+* [GitHub Pages](https://pages.github.com)
+* [Font Awesome](https://fontawesome.com)
+* [React Icons](https://react-icons.github.io/react-icons/search)
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge
+[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge
+[forks-url]: https://github.com/othneildrew/Best-README-Template/network/members
+[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge
+[stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers
+[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge
+[issues-url]: https://github.com/othneildrew/Best-README-Template/issues
+[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge
+[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt
+[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
+[linkedin-url]: https://linkedin.com/in/othneildrew
+[product-screenshot]: images/screenshot.png
+[DotNet]: https://img.shields.io/badge/dotnet-563D7C?style=for-the-badge&logo=dotnet&logoColor=white
+[DotNet-url]: https://dotnet.microsoft.com/en-us/
+[Gitea]: https://img.shields.io/badge/Gitea-green?style=for-the-badge&logo=gitea&logoColor=white
+[Gitea-url]: https://about.gitea.com/
+[Docker]: https://img.shields.io/badge/Docker-blue?style=for-the-badge&logo=docker&logoColor=white
+[Docker-url]: https://www.docker.com/