docker-compose pull results in error

[teejo75]

Using your sample docker-compose.yml iun your readme.md, when doing docker-compose pull I get:

Pulling readarr ... error

ERROR: for readarr  name unknown
ERROR: name unknown

If I change the image to simply linuxserver/readarr, I get:

Pulling readarr ... error

ERROR: for readarr  manifest for linuxserver/readarr:latest not found: manifest unknown: manifest unknown
ERROR: manifest for linuxserver/readarr:latest not found: manifest unknown: manifest unknown

[github-actions]

Thanks for opening your first issue here! Be sure to follow the bug or feature issue templates!

[Roxedus]

Our readme does not say :latest is a valid tag

[j0nnymoe]

As per our readme, there is only a nightly tag: https://github.com/linuxserver/docker-readarr#version-tags

[NemesisRE]

but the readme does say there is a latest in the recommended compose part it doesn't add a tag which results in latest
https://github.com/linuxserver/docker-readarr#docker-compose-recommended-click-here-for-more-info

[j0nnymoe]

Those are examples: Here are some example snippets to help you get started creating a container.

The recommended is suggesting that compose is our recommended deployment method. You should still be checking what tags are available in the table above.

[NemesisRE]

Yes sure but an example that doesn't work is a bad or at least missleading. If there is only one tag wouldn't it be better to added that tag to the example.
On the other hand if there is only one tag it's also the latest so you could double tag nightly with latest until you switch it to a production version.
It is just an suggestion IMHO an example should work to be an example.

But I don't wanted to sound ungrateful I am thankful for your work keep it up!

[Roxedus]

The reasoning for it being the way it is, is because Readarr is still beta, and it's not guaranteed to work the way you may expect (but it also isn't guaranteed to break). Having a user not blindly follow a example helps us make sure the user is somewhat invested in this.

[facorazza]

The readme could still be improved regardless

[PsychoData]

@Roxedus

the Contributing document says to edit the readme-vars.yml but there is no readme-vars.yml file to modify to fix the ReadMe file.

The Usage section of the current ReadMe file has docker-compose and docker CLI setups that do not work (because Latest is not a valid Tag, as mentioned above). The Image is specified as ghcr.io/linuxserver/readarr which doesn't handle the need to use :nightly .

It looks like switching to ghcr.io/linuxserver/readarr:nightly will at least make it so that the commands on the readme page will work - and it could be tweaked back to ghcr.io/linuxserver/readarr with no tag whenever it is time for normal release.

There are several other places on the Readme that also mention JUST ghcr.io/linuxserver/readarr or linuxserver/readarr or readarr where it also should get changed if you want the commands mentioned on the Readme page to be correct/work.

So, I'm not sure if we need to just edit the Readme.md directly right now, or figure out what to put in the readme-vars.yml to match the existing Readme.md. Is there something to describe the build process for the readme, so we can fix it?

[Roxedus]

This is done with intention, readarr is in beta, so we highly recommend users to read and understand the readme, which does state which tags are active.

[PsychoData]

Ah, so it's intentionally left with broken commands and no direct explanation because you only want people who can put together that docker pull linuxserver/readarr is going to pull :latest by default - and since :latest is NOT listed that is why all of the examples are broken.

If you don't want people to follow examples - just remove the examples

[Roxedus]

They are just that, examples.

[jt196]

Came here to figure this out.

Honestly, I'd probably leave the image tag on the sample docker-compose file to something that's working, even though it's in beta.

IMHO Better to have an off the bat working docker-compose file and some explanation about the tag usage than have (potentially) some folks drop out from frustration.