[GH-ISSUE #845] Feature Request: version listing for the Docker Hub page #523

Closed
opened 2026-03-01 14:44:18 +03:00 by kerem · 4 comments
Owner

Originally created by @MPeti1 on GitHub (Sep 12, 2021).
Original GitHub issue: https://github.com/ArchiveBox/ArchiveBox/issues/845

Type

  • General question or discussion
  • Propose a brand new feature
  • Request modification of existing behavior or design

What is the problem that your feature request solves

I usually run ArchiveBox in Docker or similar, and when there's a new version I always find it hard to find it on Docker Hub page among all the versions.

Describe the ideal specific solution you'd want, and whether it fits into any broader scope of changes

Provide version summaries at the top of the Docker Hub page of the project, like other projects do.
An example is Alpine Linux's page on DH: https://hub.docker.com/_/alpine/
Here they provide a version summary, in which every row is like a channel, that shows which version codes point to the same container at the moment.

With ArchiveBox it could go such as this:

  • a row for the latest stable release (where as of now 0.6, 0.6.2 and latest would point to the same container)
  • a row for the previous stable minor release (where there could be 0.6.1, and others if there are more which points to it and makes sense)
  • a row for the previous stable major release (0.5 and 0.5.6)
  • a row for the state of the dev branch
  • a row for the latest version that's name starts with sha-, though I'm not sure what are these.
    I don't know if and how this can be automated, but seeing how many big projects do this I would assume that it's possible.

What hacks or alternative solutions have you tried to solve the problem?

I tried searching with ctrl+f on the tags listing for sha- and only look at those releases which weren't highlighted, and go to the next page until I find the latest stable version by number.

How badly do you want this new feature?

  • It's an urgent deal-breaker, I can't live without it
  • It's important to add it in the near-mid term future
  • It would be nice to have eventually

  • I'm willing to contribute dev time / money to fix this issue
  • I like ArchiveBox so far / would recommend it to a friend
  • I've had a lot of difficulty getting ArchiveBox set up
Originally created by @MPeti1 on GitHub (Sep 12, 2021). Original GitHub issue: https://github.com/ArchiveBox/ArchiveBox/issues/845 <!-- Please fill out the following information, feel free to delete sections if they're not applicable or if long issue templates annoy you :) --> ## Type - [x] General question or discussion - [ ] Propose a brand new feature - [ ] Request modification of existing behavior or design ## What is the problem that your feature request solves <!-- e.g. I need to be able to archive spanish and french subtitle files from a particular <example.com> movie site that's going down soon. --> I usually run ArchiveBox in Docker or similar, and when there's a new version I always find it hard to find it on Docker Hub page among all the versions. ## Describe the ideal specific solution you'd want, and whether it fits into any broader scope of changes <!-- e.g. I specifically need a new archive method to look for multilingual subtitle files related to pages. The bigger picture solution is the ability for custom user scripts to be run in a puppeteer context during archiving. --> Provide version summaries at the top of the Docker Hub page of the project, like other projects do. An example is Alpine Linux's page on DH: https://hub.docker.com/_/alpine/ Here they provide a version summary, in which every row is like a channel, that shows which version codes point to the same container at the moment. With ArchiveBox it could go such as this: - a row for the latest stable release (where as of now `0.6`, `0.6.2` and `latest` would point to the same container) - a row for the previous stable minor release (where there could be 0.6.1, and others if there are more which points to it and makes sense) - a row for the previous stable major release (0.5 and 0.5.6) - a row for the state of the dev branch - a row for the latest version that's name starts with `sha-`, though I'm not sure what are these. I don't know if and how this can be automated, but seeing how many big projects do this I would assume that it's possible. ## What hacks or alternative solutions have you tried to solve the problem? <!-- A clear and concise description of any alternative solutions, workarounds, or other software you've considered using to fix the problem. --> I tried searching with ctrl+f on the tags listing for `sha-` and only look at those releases which weren't highlighted, and go to the next page until I find the latest stable version by number. ## How badly do you want this new feature? - [ ] It's an urgent deal-breaker, I can't live without it - [ ] It's important to add it in the near-mid term future - [x] It would be nice to have eventually --- - [ ] I'm willing to contribute [dev time](https://github.com/ArchiveBox/ArchiveBox#archivebox-development) / [money](https://github.com/sponsors/pirate) to fix this issue - [x] I like ArchiveBox so far / would recommend it to a friend - [ ] I've had a lot of difficulty getting ArchiveBox set up
Author
Owner

@pirate commented on GitHub (Sep 16, 2021):

It's painful because right now the Docker homepage is just the github readme verbatim, I don't really want to build a whole pipeline to generate a separate Docker readme.

I think this is mostly only a problem when we have a big gap in time between releases. For now I recommend using the Github releases page instead of Dockers to find the latest tag. https://github.com/ArchiveBox/ArchiveBox/releases

<!-- gh-comment-id:920541734 --> @pirate commented on GitHub (Sep 16, 2021): It's painful because right now the Docker homepage is just the github readme verbatim, I don't really want to build a whole pipeline to generate a separate Docker readme. I think this is mostly only a problem when we have a big gap in time between releases. For now I recommend using the Github releases page instead of Dockers to find the latest tag. https://github.com/ArchiveBox/ArchiveBox/releases
Author
Owner

@MPeti1 commented on GitHub (Sep 16, 2021):

Thank you, but an other reason I wanted to recommend this is that this way it would be possible to set version 0.6 or just 0 in the docker-compose file, so the container could be upgraded somewhat easier (maybe automatically) when a new version comes out, but so that it only auto-updates to bugfix versions, and not to versions where there are bigger changes.

I think this does not actually need a Dockerhub page different from the Github one, but only that you use multiple tags when building the container (like one tag for all 3 parts of the version code).

<!-- gh-comment-id:921051747 --> @MPeti1 commented on GitHub (Sep 16, 2021): Thank you, but an other reason I wanted to recommend this is that this way it would be possible to set version 0.6 or just 0 in the docker-compose file, so the container could be upgraded somewhat easier (maybe automatically) when a new version comes out, but so that it only auto-updates to bugfix versions, and not to versions where there are bigger changes. I think this does not actually need a Dockerhub page different from the Github one, but only that you use multiple tags when building the container (like one tag for all 3 parts of the version code).
Author
Owner

@pirate commented on GitHub (Sep 16, 2021):

It should already do that right now, we have a new autotag pipeline in 0.6 that tags with 0.6.3 and 0.6 (but not 0 on its own).

<!-- gh-comment-id:921104418 --> @pirate commented on GitHub (Sep 16, 2021): It should already do that right now, we have a new autotag pipeline in 0.6 that tags with 0.6.3 and 0.6 (but not 0 on its own).
Author
Owner

@MPeti1 commented on GitHub (Sep 16, 2021):

oh, that's good to know, thank you!
could you include this in the readme (or a wiki article)?

<!-- gh-comment-id:921270944 --> @MPeti1 commented on GitHub (Sep 16, 2021): oh, that's good to know, thank you! could you include this in the readme (or a wiki article)?
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/ArchiveBox#523
No description provided.