search

caddy-dns / cloudflare

Caddy module: dns.providers.cloudflare
Apache License 2.0
465 stars 60 forks source link

Request: Install instructions #83

Closed douglasg14b closed 2 weeks ago

douglasg14b commented 1 month ago

Can this module include instructions on how to install or dd it to a new or existing caddy setup on common platform?

devnoname120 commented 2 weeks ago

See: https://caddyserver.com/docs/modules/dns.providers.cloudflare

mholt commented 2 weeks ago

Caddy documentation explains how to add/remove plugins, either with xcaddy (linked above by @devnoname120 -- thanks!) or the CLI for existing binaries: https://caddyserver.com/docs/command-line#caddy-add-package

devnoname120 commented 2 weeks ago

@mholt Is caddy add-package recommended even if caddy was installed from a Linux package manager?

mholt commented 2 weeks ago

Ironically, most (all?) Linux package managers unfortunately do not have the ability to manage packages for software like Caddy... they only support dynamically-linked builds not statically-linked builds. Which is bonkers to me, since anyone can dynamically link libs. It's the statically-linked builds that need to assist with compilation to make it easier.

Anyway, I digress... you can use caddy add-package but I presume that the next time your system package manager updates, it will wipe out the customizations.

douglasg14b commented 1 week ago

@devnoname120

See: caddyserver.com/docs/modules/dns.providers.cloudflare

Unfortunately this does not describe how to add it to an existing package, which is why I came here.

It's kind of awkward that the easiest way to find the instructions is to find issues. Instead of reading this projects docs.

The caddy docs are poorly discoverable, and its not obvious that every 3rd party project like this will be contained in their docs in the first place. If you don't know what you're looking for, you can't find it.

Which is why I made this issue, IMHO it should be in THIS project's readme. Or at the very least this project should point to the caddy documentation for itself.

@mholt Is caddy add-package recommended even if caddy was installed from a Linux package manager?

This is a good example of this confusion.

😒 At least there is now another issue people can search for to find hints at how to add this project

mholt commented 1 week ago

Sure, we can add a sentence that links to the Caddy docs for how to do this, for instance.

How about above the "Configuration" section (after "Module name") there's a new section for installing this plugin, with a couple different options (new build, existing build) -- and just link to the docs.