Caddy Manager

A UI for managing Caddy configuration files
Explore the docs »

Report Bug (label bug) · Request Feature (label enhancement)

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

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

(back to top)

Built With

• DotNet 9 with Blazor and MudBlazor
• Source code and container registry are stored with Gitea
• Docker is used for containerization with DotNet container publishing

(back to top)

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/
• Caddy container. Follow the instructions at https://caddyserver.com/docs/install
• The Caddy container is having its configuration files organized at:

  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

   git clone https://pikachu-gitea.duydao.org/ebolo/CaddyManager.git
   cd CaddyManager
   

2. Login to the container registry (optional, only need to publish to a remote registry)

   docker login -u $USER_NAME $REGISTRY_URL
   

3. Build and publish container with DotNet

   dotnet publish --os linux --arch x64 /t:PublishContainer -p ContainerRegistry=$REGISTRY_URL
   

   if publishing to only the local machine, the ContainerRegistry parameter can be omitted.

   dotnet publish --os linux --arch x64 /t:PublishContainer
   

Then the container can be run with Docker compose:

services:
  caddy:
    image: 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:

UID=1000 # can be 0 as root user
GID=1000 # can be 0 as root group

(back to top)

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

(back to top)

Roadmap

• Parse the caddy files to get more information, i.e. the domain names, the proxy addresses, etc.

See the open issues for a full list of proposed features (and known issues).

(back to top)

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

Distributed under the GNU GPLv3 License. See COPYING for more information.

(back to top)

Contact

Ebolo - @duydao - daothanhduy305@gmail.com

Project Link: CaddyManager

(back to top)

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
• GitHub Emoji Cheat Sheet
• Malven's Flexbox Cheatsheet
• Malven's Grid Cheatsheet
• Img Shields
• GitHub Pages
• Font Awesome
• React Icons

(back to top)