aboutsummaryrefslogtreecommitdiff
path: root/CLAUDE.md
blob: e3c935eb97efe29662bc31bd4d53f5bc109d543a (plain)
ofshex dumpascii
0000 23 20 47 72 75 6d 70 79 20 43 6f 6e 74 61 69 6e 65 72 73 20 2d 20 50 72 6f 6a 65 63 74 20 43 6f #.Grumpy.Containers.-.Project.Co
0020 6e 74 65 78 74 0a 0a 23 23 20 50 72 6f 6a 65 63 74 20 4f 76 65 72 76 69 65 77 0a 41 20 63 6f 6c ntext..##.Project.Overview.A.col
0040 6c 65 63 74 69 6f 6e 20 6f 66 20 44 6f 63 6b 65 72 20 63 6f 6e 74 61 69 6e 65 72 73 20 66 6f 72 lection.of.Docker.containers.for
0060 20 65 76 65 72 79 64 61 79 20 74 61 73 6b 73 20 61 6e 64 20 73 65 72 76 69 63 65 73 2c 20 6d 61 .everyday.tasks.and.services,.ma
0080 6e 61 67 65 64 20 77 69 74 68 20 60 6a 75 73 74 60 20 62 75 69 6c 64 20 61 75 74 6f 6d 61 74 69 naged.with.`just`.build.automati
00a0 6f 6e 2e 0a 0a 23 23 20 42 75 69 6c 64 20 53 79 73 74 65 6d 0a 2d 20 2a 2a 42 75 69 6c 64 20 54 on...##.Build.System.-.**Build.T
00c0 6f 6f 6c 2a 2a 3a 20 60 6a 75 73 74 60 20 28 63 6f 6d 6d 61 6e 64 20 72 75 6e 6e 65 72 29 0a 2d ool**:.`just`.(command.runner).-
00e0 20 2a 2a 52 65 67 69 73 74 72 79 2a 2a 3a 20 60 70 75 62 6c 69 63 2e 65 63 72 2e 61 77 73 2f 73 .**Registry**:.`public.ecr.aws/s
0100 30 66 39 6f 32 6b 35 60 0a 2d 20 2a 2a 56 65 72 73 69 6f 6e 69 6e 67 2a 2a 3a 20 53 65 6d 61 6e 0f9o2k5`.-.**Versioning**:.Seman
0120 74 69 63 20 76 65 72 73 69 6f 6e 69 6e 67 20 69 6e 20 56 45 52 53 49 4f 4e 20 66 69 6c 65 73 20 tic.versioning.in.VERSION.files.
0140 70 65 72 20 63 6f 6e 74 61 69 6e 65 72 0a 0a 23 23 20 4b 65 79 20 43 6f 6d 6d 61 6e 64 73 0a 60 per.container..##.Key.Commands.`
0160 60 60 62 61 73 68 0a 23 20 53 68 6f 77 20 61 76 61 69 6c 61 62 6c 65 20 72 65 63 69 70 65 73 0a ``bash.#.Show.available.recipes.
0180 6a 75 73 74 0a 0a 23 20 42 75 69 6c 64 20 61 6c 6c 20 63 6f 6e 74 61 69 6e 65 72 73 20 61 6e 64 just..#.Build.all.containers.and
01a0 20 74 61 72 67 65 74 73 0a 6a 75 73 74 20 62 75 69 6c 64 0a 0a 23 20 50 75 73 68 20 61 6c 6c 20 .targets.just.build..#.Push.all.
01c0 63 6f 6e 74 61 69 6e 65 72 73 20 61 6e 64 20 74 61 72 67 65 74 73 20 20 0a 6a 75 73 74 20 70 75 containers.and.targets...just.pu
01e0 73 68 0a 0a 23 20 42 75 69 6c 64 20 73 70 65 63 69 66 69 63 20 63 6f 6e 74 61 69 6e 65 72 0a 6a sh..#.Build.specific.container.j
0200 75 73 74 20 62 75 69 6c 64 2d 63 6f 6e 74 61 69 6e 65 72 20 3c 63 6f 6e 74 61 69 6e 65 72 2d 6e ust.build-container.<container-n
0220 61 6d 65 3e 0a 0a 23 20 50 75 73 68 20 73 70 65 63 69 66 69 63 20 63 6f 6e 74 61 69 6e 65 72 0a ame>..#.Push.specific.container.
0240 6a 75 73 74 20 70 75 73 68 2d 63 6f 6e 74 61 69 6e 65 72 20 3c 63 6f 6e 74 61 69 6e 65 72 2d 6e just.push-container.<container-n
0260 61 6d 65 3e 0a 0a 23 20 42 75 6d 70 20 76 65 72 73 69 6f 6e 20 66 6f 72 20 63 6f 6e 74 61 69 6e ame>..#.Bump.version.for.contain
0280 65 72 0a 6a 75 73 74 20 62 75 6d 70 2d 76 65 72 73 69 6f 6e 20 3c 63 6f 6e 74 61 69 6e 65 72 2d er.just.bump-version.<container-
02a0 6e 61 6d 65 3e 20 5b 70 61 74 63 68 7c 6d 69 6e 6f 72 7c 6d 61 6a 6f 72 5d 0a 0a 23 20 42 75 6d name>.[patch|minor|major]..#.Bum
02c0 70 20 61 6c 6c 20 76 65 72 73 69 6f 6e 73 0a 6a 75 73 74 20 62 75 6d 70 2d 76 65 72 73 69 6f 6e p.all.versions.just.bump-version
02e0 73 20 5b 70 61 74 63 68 7c 6d 69 6e 6f 72 7c 6d 61 6a 6f 72 5d 0a 60 60 60 0a 0a 23 23 20 50 72 s.[patch|minor|major].```..##.Pr
0300 6f 6a 65 63 74 20 53 74 72 75 63 74 75 72 65 0a 60 60 60 0a 73 72 63 2f 0a 1c 00 00 20 62 61 73 oject.Structure.```.src/.....bas
0320 65 2f 20 20 20 20 20 20 20 20 20 20 20 23 20 42 61 73 65 20 63 6f 6e 74 61 69 6e 65 72 20 69 6d e/...........#.Base.container.im
0340 61 67 65 0a 1c 00 00 20 63 67 69 74 2f 20 20 20 20 20 20 20 20 20 20 20 23 20 57 65 62 20 69 6e age.....cgit/...........#.Web.in
0360 74 65 72 66 61 63 65 20 66 6f 72 20 67 69 74 20 72 65 70 6f 73 69 74 6f 72 69 65 73 0a 1c 00 00 terface.for.git.repositories....
0380 20 63 6c 75 73 74 65 72 2f 20 20 20 20 20 20 20 20 23 20 43 6f 6e 74 61 69 6e 65 72 20 6f 72 63 .cluster/........#.Container.orc
03a0 68 65 73 74 72 61 74 69 6f 6e 20 74 6f 6f 6c 73 0a 1c 00 00 20 67 69 74 2d 73 6e 61 70 73 68 6f hestration.tools.....git-snapsho
03c0 74 2f 20 20 20 23 20 47 69 74 20 72 65 70 6f 73 69 74 6f 72 79 20 62 61 63 6b 75 70 20 75 74 69 t/...#.Git.repository.backup.uti
03e0 6c 69 74 79 0a 1c 00 00 20 67 69 74 6f 6c 69 74 65 2f 20 20 20 20 20 20 20 23 20 47 69 74 20 68 lity.....gitolite/.......#.Git.h
0400 6f 73 74 69 6e 67 20 61 6e 64 20 61 63 63 65 73 73 20 6d 61 6e 61 67 65 6d 65 6e 74 0a 1c 00 00 osting.and.access.management....
0420 20 67 6f 2d 65 63 68 6f 2f 20 20 20 20 20 20 20 20 23 20 53 69 6d 70 6c 65 20 47 6f 20 65 63 68 .go-echo/........#.Simple.Go.ech
0440 6f 20 73 65 72 76 65 72 0a 1c 00 00 20 6a 75 73 74 2f 20 20 20 20 20 20 20 20 20 20 20 23 20 4a o.server.....just/...........#.J
0460 75 73 74 20 63 6f 6d 6d 61 6e 64 20 72 75 6e 6e 65 72 20 63 6f 6e 74 61 69 6e 65 72 0a 1c 00 00 ust.command.runner.container....
0480 20 70 65 6c 69 63 61 6e 2f 20 20 20 20 20 20 20 20 23 20 53 74 61 74 69 63 20 73 69 74 65 20 67 .pelican/........#.Static.site.g
04a0 65 6e 65 72 61 74 6f 72 0a 1c 00 00 20 72 63 6c 6f 6e 65 2f 20 20 20 20 20 20 20 20 20 23 20 43 enerator.....rclone/.........#.C
04c0 6c 6f 75 64 20 73 74 6f 72 61 67 65 20 73 79 6e 63 20 74 6f 6f 6c 0a 1c 00 00 20 73 61 6c 6c 79 loud.storage.sync.tool.....sally
04e0 2f 20 20 20 20 20 20 20 20 20 20 23 20 43 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6d 61 6e 61 67 /..........#.Configuration.manag
0500 65 6d 65 6e 74 20 74 6f 6f 6c 0a 1c 00 00 20 73 74 61 74 69 63 2d 66 69 6c 65 73 2f 20 20 20 23 ement.tool.....static-files/...#
0520 20 53 74 61 74 69 63 20 66 69 6c 65 20 73 65 72 76 65 72 0a 14 00 00 20 75 6e 62 6f 75 6e 64 2d .Static.file.server.....unbound-
0540 61 64 62 6c 6f 63 6b 2f 20 23 20 44 4e 53 20 61 64 2d 62 6c 6f 63 6b 69 6e 67 20 73 65 72 76 69 adblock/.#.DNS.ad-blocking.servi
0560 63 65 0a 60 60 60 0a 0a 23 23 20 43 6f 6e 74 61 69 6e 65 72 20 44 65 74 61 69 6c 73 0a 45 61 63 ce.```..##.Container.Details.Eac
0580 68 20 63 6f 6e 74 61 69 6e 65 72 20 64 69 72 65 63 74 6f 72 79 20 63 6f 6e 74 61 69 6e 73 3a 0a h.container.directory.contains:.
05a0 2d 20 60 44 6f 63 6b 65 72 66 69 6c 65 60 20 2d 20 43 6f 6e 74 61 69 6e 65 72 20 62 75 69 6c 64 -.`Dockerfile`.-.Container.build
05c0 20 69 6e 73 74 72 75 63 74 69 6f 6e 73 0a 2d 20 60 56 45 52 53 49 4f 4e 60 20 2d 20 53 65 6d 61 .instructions.-.`VERSION`.-.Sema
05e0 6e 74 69 63 20 76 65 72 73 69 6f 6e 20 66 6f 72 20 74 68 65 20 63 6f 6e 74 61 69 6e 65 72 0a 2d ntic.version.for.the.container.-
0600 20 60 62 69 6e 2f 60 20 2d 20 45 78 65 63 75 74 61 62 6c 65 20 73 63 72 69 70 74 73 20 28 69 66 .`bin/`.-.Executable.scripts.(if
0620 20 61 70 70 6c 69 63 61 62 6c 65 29 0a 2d 20 60 65 74 63 2f 60 20 2d 20 43 6f 6e 66 69 67 75 72 .applicable).-.`etc/`.-.Configur
0640 61 74 69 6f 6e 20 66 69 6c 65 73 20 28 69 66 20 61 70 70 6c 69 63 61 62 6c 65 29 0a 0a 23 23 20 ation.files.(if.applicable)..##.
0660 54 65 73 74 69 6e 67 0a 4e 6f 20 66 6f 72 6d 61 6c 20 74 65 73 74 20 66 72 61 6d 65 77 6f 72 6b Testing.No.formal.test.framework
0680 20 64 65 74 65 63 74 65 64 2e 20 54 65 73 74 69 6e 67 20 69 73 20 64 6f 6e 65 20 74 68 72 6f 75 .detected..Testing.is.done.throu
06a0 67 68 3a 0a 2d 20 44 6f 63 6b 65 72 20 62 75 69 6c 64 20 76 61 6c 69 64 61 74 69 6f 6e 0a 2d 20 gh:.-.Docker.build.validation.-.
06c0 4d 61 6e 75 61 6c 20 63 6f 6e 74 61 69 6e 65 72 20 76 65 72 69 66 69 63 61 74 69 6f 6e 0a 2d 20 Manual.container.verification.-.
06e0 52 75 6e 74 69 6d 65 20 74 65 73 74 69 6e 67 20 6f 66 20 73 65 72 76 69 63 65 73 0a 0a 23 23 20 Runtime.testing.of.services..##.
0700 48 75 67 6f 20 43 6f 6e 74 61 69 6e 65 72 20 55 73 61 67 65 0a 54 68 65 20 68 75 67 6f 20 63 6f Hugo.Container.Usage.The.hugo.co
0720 6e 74 61 69 6e 65 72 20 73 75 70 70 6f 72 74 73 20 63 6f 6e 66 69 67 75 72 61 62 6c 65 20 69 6e ntainer.supports.configurable.in
0740 70 75 74 20 61 6e 64 20 6f 75 74 70 75 74 20 64 69 72 65 63 74 6f 72 69 65 73 3a 0a 0a 60 60 60 put.and.output.directories:..```
0760 62 61 73 68 0a 23 20 42 75 69 6c 64 20 77 69 74 68 20 64 65 66 61 75 6c 74 20 64 69 72 65 63 74 bash.#.Build.with.default.direct
0780 6f 72 69 65 73 20 28 2f 6f 70 74 2f 61 70 70 2f 73 72 63 20 2d 3e 20 2f 6f 70 74 2f 61 70 70 2f ories.(/opt/app/src.->./opt/app/
07a0 70 75 62 6c 69 63 29 0a 64 6f 63 6b 65 72 20 72 75 6e 20 2d 76 20 2f 70 61 74 68 2f 74 6f 2f 68 public).docker.run.-v./path/to/h
07c0 75 67 6f 2f 73 69 74 65 3a 2f 6f 70 74 2f 61 70 70 2f 73 72 63 20 2d 76 20 2f 70 61 74 68 2f 74 ugo/site:/opt/app/src.-v./path/t
07e0 6f 2f 6f 75 74 70 75 74 3a 2f 6f 70 74 2f 61 70 70 2f 70 75 62 6c 69 63 20 70 75 62 6c 69 63 2e o/output:/opt/app/public.public.
0800 65 63 72 2e 61 77 73 2f 73 30 66 39 6f 32 6b 35 2f 68 75 67 6f 3a 76 30 2e 30 2e 31 0a 0a 23 20 ecr.aws/s0f9o2k5/hugo:v0.0.1..#.
0820 42 75 69 6c 64 20 77 69 74 68 20 63 75 73 74 6f 6d 20 64 69 72 65 63 74 6f 72 69 65 73 0a 64 6f Build.with.custom.directories.do
0840 63 6b 65 72 20 72 75 6e 20 2d 76 20 2f 70 61 74 68 2f 74 6f 2f 68 75 67 6f 2f 73 69 74 65 3a 2f cker.run.-v./path/to/hugo/site:/
0860 69 6e 70 75 74 20 2d 76 20 2f 70 61 74 68 2f 74 6f 2f 6f 75 74 70 75 74 3a 2f 6f 75 74 70 75 74 input.-v./path/to/output:/output
0880 20 70 75 62 6c 69 63 2e 65 63 72 2e 61 77 73 2f 73 30 66 39 6f 32 6b 35 2f 68 75 67 6f 3a 76 30 .public.ecr.aws/s0f9o2k5/hugo:v0
08a0 2e 30 2e 31 20 2d 2d 69 6e 70 75 74 20 2f 69 6e 70 75 74 20 2d 2d 6f 75 74 70 75 74 20 2f 6f 75 .0.1.--input./input.--output./ou
08c0 74 70 75 74 0a 0a 23 20 45 6e 76 69 72 6f 6e 6d 65 6e 74 20 76 61 72 69 61 62 6c 65 73 0a 64 6f tput..#.Environment.variables.do
08e0 63 6b 65 72 20 72 75 6e 20 2d 65 20 49 4e 50 55 54 5f 44 49 52 3d 2f 63 75 73 74 6f 6d 2f 69 6e cker.run.-e.INPUT_DIR=/custom/in
0900 70 75 74 20 2d 65 20 4f 55 54 50 55 54 5f 44 49 52 3d 2f 63 75 73 74 6f 6d 2f 6f 75 74 70 75 74 put.-e.OUTPUT_DIR=/custom/output
0920 20 70 75 62 6c 69 63 2e 65 63 72 2e 61 77 73 2f 73 30 66 39 6f 32 6b 35 2f 68 75 67 6f 3a 76 30 .public.ecr.aws/s0f9o2k5/hugo:v0
0940 2e 30 2e 31 0a 60 60 60 0a 0a 23 23 20 44 65 76 65 6c 6f 70 6d 65 6e 74 20 57 6f 72 6b 66 6c 6f .0.1.```..##.Development.Workflo
0960 77 0a 31 2e 20 4d 61 6b 65 20 63 68 61 6e 67 65 73 20 74 6f 20 63 6f 6e 74 61 69 6e 65 72 20 73 w.1..Make.changes.to.container.s
0980 6f 75 72 63 65 0a 32 2e 20 55 70 64 61 74 65 20 56 45 52 53 49 4f 4e 20 66 69 6c 65 20 69 66 20 ource.2..Update.VERSION.file.if.
09a0 6e 65 65 64 65 64 0a 33 2e 20 42 75 69 6c 64 20 63 6f 6e 74 61 69 6e 65 72 3a 20 60 6a 75 73 74 needed.3..Build.container:.`just
09c0 20 62 75 69 6c 64 2d 63 6f 6e 74 61 69 6e 65 72 20 3c 6e 61 6d 65 3e 60 0a 34 2e 20 54 65 73 74 .build-container.<name>`.4..Test
09e0 20 63 6f 6e 74 61 69 6e 65 72 20 66 75 6e 63 74 69 6f 6e 61 6c 69 74 79 0a 35 2e 20 50 75 73 68 .container.functionality.5..Push
0a00 20 74 6f 20 72 65 67 69 73 74 72 79 3a 20 60 6a 75 73 74 20 70 75 73 68 2d 63 6f 6e 74 61 69 6e .to.registry:.`just.push-contain
0a20 65 72 20 3c 6e 61 6d 65 3e 60 er.<name>`