Caddyfile Dynamodb Configuration Syntax

shreecodes · November 4, 2021, 4:09pm

1. Caddy version (`caddy version`):

2.4.5

2. How I run Caddy:

a. System environment:

Docker for macOS v20.10.8
macOS 11.3.1

b. Command:

In folder containing Dockerfile and Caddyfile:

docker build -t caddy-test .
docker run -e "DYNAMODB_TABLE=caddy-storage" -e "DYNAMODB_REGION=us-east-2" -p 80:80 -p 443:443 caddy-test

c. Service/unit/compose file:

Dockerfile

FROM caddy:2.4.5-builder-alpine AS builder
RUN xcaddy build --with github.com/silinternational/certmagic-storage-dynamodb@2.0.1

FROM caddy
COPY --from=builder /usr/bin/caddy /usr/bin/caddy
COPY Caddyfile /etc/caddy/Caddyfile

d. My complete Caddyfile or JSON config:

{
	on_demand_tls {
		ask https://www.oursite.com/api/domain/verification
	}

	storage dynamodb {$DYNAMODB_TABLE} {
		aws_region {$DYNAMODB_REGION}
		lock_polling_interval 5s
		lock_timeout 5m
	}
}

https:// {
	tls {
		on_demand
	}

	handle {
		rewrite * /web?uri={path}&host={host}

		reverse_proxy https://www.oursite.com {
			header_up Host {upstream_hostport}
			header_up X-Forwarded-Host {host}
		}
	}
}

3. The problem I’m having:

Neither the lock_polling_interval nor the lock_timeout from the storage config seem to be accepted by Caddy. It works if I omit those two options, but I prefer declarative, explicit configuration values as opposed to relying on implicit defaults.

Does the Caddyfile support the lock options for the dynamodb storage plugin?

4. Error messages and/or full log output:

{"level":"info","ts":1636041834.6633754,"msg":"using provided configuration","config_file":"/etc/caddy/Caddyfile","config_adapter":"caddyfile"}
run: adapting config using caddyfile: parsing caddyfile tokens for 'storage': /etc/caddy/Caddyfile:8 - Error during parsing: unrecognized parameter 'lock_timeout'

and (depending on which of the lock options is first in the config)

run: adapting config using caddyfile: parsing caddyfile tokens for 'storage': /etc/caddy/Caddyfile:8 - Error during parsing: unrecognized parameter 'lock_polling_interval'

5. What I already tried:

It works if I omit the values. I also tried removing the underscores, e.g. lockpollinginterval but to no avail.

The documentation for the JSON config has underscores: Modules - Caddy Documentation

And this github issue for the dynamodb storage plugin mentions the lock options:

github.com/silinternational/certmagic-storage-dynamodb

Caddyfile storage syntax

opened 12:08AM - 09 Jun 20 UTC

closed 10:21PM - 10 Jun 20 UTC

danlsgiga

I believe this requires some help / advice from @mholt. To follow Caddyfile d…ocs, isn't better to have: ```caddy-d dynamodb <table_name> { aws_endpoint <endpoint> aws_region <region> } ``` modified to ```caddy-d dynamodb { table <dynamodb_table_name> aws_endpoint <endpoint> aws_region <region> } ``` [Here](https://caddyserver.com/docs/caddyfile/options) is how Caddyfile global options are structured. ```caddy-d storage <module_name> { <options...> } ``` So the "correct" syntax would be something like: ```caddy-d storage dynamodb { table Caddy aws_endpoint <awsendpoint> aws_region <awsregion> aws_disable_ssl <true|false> lock_timeout 10s lock_polling_interval 30s } ``` I can get a PR for this if that's the desired syntax.

6. Links to relevant resources:

N/A

francislavoie · November 4, 2021, 9:35pm

I don’t think the Caddyfile adapter supports that option. See the code:

github.com

silinternational/certmagic-storage-dynamodb/blob/425c047ecb157233a3ece8ee6c54bde65f7b8cff/caddy.go#L28


      
          	}
          }
          
          // CertMagicStorage converts s to a certmagic.Storage instance.
          func (s *Storage) CertMagicStorage() (certmagic.Storage, error) {
          	return s, nil
          }
          
          // UnmarshalCaddyfile sets up the storage module from Caddyfile tokens. Syntax:
          //
          // dynamodb <table_name> {
          //     aws_endpoint <endpoint>
          //     aws_region   <region>
          // }
          //
          // Only the table name is required.
          func (s *Storage) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {
          	for d.Next() {
          		if !d.NextArg() {
          			return d.ArgErr()
          		}

Best if you open an issue with the plugin repo and ask for help, since this is a third party plugin.

system · December 4, 2021, 4:10pm

This topic was automatically closed after 30 days. New replies are no longer allowed.