Skip to content

jwillikers/caddy-config

Repository files navigation

Caddy Config

GitHub Workflow Status pre-commit

Caddy configuration files for services on running on my various devices.

Synopsis

These instructions are for using this Caddyfile and Caddy container using rootless Podman on Fedora IoT. The instructions for building will assume that you are on Fedora.

Usage

  1. Clone the repository.

    git clone git@github.com:jwillikers/caddy-config.git
  2. Change into the project directory.

    cd caddy-config
  3. Symlink sites from the sites-available subdirectory to the sites-enabled subdirectory to enable them.

    ln --relative --symbolic sites-available/nextcloud.caddyfile sites-enabled/nextcloud.caddyfile
  4. Follow the instructions for setting up and running the Caddy OVH Image using the Caddyfile provided in this repository.

Develop

  1. Install the pre-commit in the toolbox.

    sudo dnf -y install pre-commit
  2. Install pre-commit’s Git hooks.

    pre-commit install
  3. Format the Caddyfile.

    podman run \
      -it \
      --name caddy-fmt \
      --rm \
      --volume $PWD:/srv:Z \
      docker.io/caddy:latest caddy fmt --overwrite
  4. Validate the Caddyfile.

    podman run \
      -it \
      --name caddy-validate \
      --rm \
      --volume $PWD:/srv:Z \
      quay.io/jwillikers/caddy-ovh:latest caddy validate

Contributing

Contributions in the form of issues, feedback, and even pull requests are welcome. Make sure to adhere to the project’s Code of Conduct.

Open Source Software

This project is built on the hard work of countless open source contributors. Several of these projects are enumerated below.

Code of Conduct

Refer to the project’s Code of Conduct for details.

License

This repository is licensed under the GPLv3, a copy of which is provided in the license file.

© 2022-2023 Jordan Williams

Authors