Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

instructions for docker and linux #353

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sanderjo
Copy link
Contributor

@Safihre what do you think?

@jeffgeorge
Copy link
Member

I've got some concerns about this.

Regarding Docker, we should absolutely not be directing people straight to dockerhub, as it's full of rando images that aren't being maintained. I support breaking out Docker install instructions to its own page, but think we should link to a couple of the specific well supported images:

I also don't agree that users should be attempting to install from their package managers first, Docker should be considered a first-class option, and in cases of things like Debian Docker should be considered strongly preferred to the versions in apt out-of-the-box. These days many of our users who come in through Discord looking for help are either running TrueNAS Scale (so, Debian with Docker for applications) or Unraid (so they should be using Docker for applications), so highlighting Docker is very important.

I'm open to splitting off the Docker docs to a standalone page (since it can technically be used anywhere you can run Docker, not just Unix/Linux), but I don't think we need to have a ton of explicit installation docs, and instead leave that up to the actual image maintainers.

Regarding the Linux page, what's your intent here? Why would we not just expand on the existing Unix/Linux landing page, which already has basically all this information?

@sanderjo
Copy link
Contributor Author

I've got some concerns about this.

Regarding Docker, we should absolutely not be directing people straight to dockerhub, as it's full of rando images that aren't being maintained. I support breaking out Docker install instructions to its own page, but think we should link to a couple of the specific well supported images:

How did you do this triage? Why not "binhex"? Are you willing to keep that updated?

I also don't agree that users should be attempting to install from their package managers first, Docker should be considered a first-class option, and in cases of things like Debian Docker should be considered strongly preferred to the versions in apt out-of-the-box.

I agree now for platforms without a SABnzbd package, and long term for all platforms.

But here and now:

On Debian, you say people should use docker? In my experience with users in the forum, Docker from CLI is hard (and AFAIK Debian has no GUI built-in for docker). Harder than installing & configuring SABnzbd on Debian for the repo.

And for Ubuntu?

These days many of our users who come in through Discord looking for help are either running TrueNAS Scale (so, Debian with Docker for applications) or Unraid (so they should be using Docker for applications), so highlighting Docker is very important.

I agree on Unraid. Easy & beautiful via the Unraid GUI. Wow ... example how it should be. That was my trigger to write the page.

But for Synology ... there is a nice SABnzbd package from a great maintainer. I would not dare to say "don't use that".

I'm open to splitting off the Docker docs to a standalone page (since it can technically be used anywhere you can run Docker, not just Unix/Linux), but I don't think we need to have a ton of explicit installation docs, and instead leave that up to the actual image maintainers.

Yes. I referred to that.

Regarding the Linux page, what's your intent here? Why would we not just expand on the existing Unix/Linux landing page, which already has basically all this information?

When was the last time someone said to you he/she/they used "Unix"? Unix is a word for SunOS / Solaris, *BSD and HP-UX. So I want the Unix page to become minimalistic and refer to the "from source" page.

@sanderjo
Copy link
Contributor Author

Ah, the triage / criteria for getting in the list: number of pulls, plus how recent the image is

https://hub.docker.com/v2/repositories/linuxserver/sabnzbd/

image

sander@penguin:~$ curl -s 'https://hub.docker.com/v2/repositories/linuxserver/sabnzbd/' | jq | grep -i -e pull_count -e last_updated
  "pull_count": 705188911,
  "last_updated": "2025-01-09T02:45:48.059268Z",

sander@penguin:~$ curl -s 'https://hub.docker.com/v2/repositories/hotio/sabnzbd/' | jq | grep -i -e pull_count -e last_updated
  "pull_count": 4157494,
  "last_updated": "2025-01-08T20:46:02.108376Z",
sander@penguin:~$ 

sander@penguin:~$ curl -s 'https://hub.docker.com/v2/repositories/ich777/sabnzbd/' | jq | grep -i -e pull_count -e last_updated
  "pull_count": 55353,
  "last_updated": "2024-12-19T08:24:34.607724Z",

@jeffgeorge
Copy link
Member

Why not "binhex"?

Bah, I knew I forgot one. Those four are the "big" docker providers I'm aware of, and binhex in particular presently holds the super-high-speed performance record based on testing @thezoggy has been doing. If some new major provider crops up we can link to them, or they can file a PR. My big issue with dockerhub is that they provide pretty terrible tools for users to figure out what the "right" or "best" provider is if there isn't an "official" one. You can't sort by stars or downloads, just "best match" or "latest updated", you just have to know.

For Debian I absolutely suggest anything-but-apt first, that's what I wrote in the recently updated Debian docs. It's less of an issue for Ubuntu, Arch, etc, but on those platforms I think it should be as-good of an option as installing natively.

If your main issue with the old page is that it says unix first, we can totally swap that around, but I'd rather we handle it by renaming the old page and setting a redirect by doing this in the header:

---
title: Install SABnzbd for Linux
redirect_from:
    - /wiki/installation/install-unix
---

Or I can set up the redirect in Cloudflare if we'd prefer a proper 301 instead of a meta-refresh redirect.

@Safihre
Copy link
Member

Safihre commented Jan 12, 2025

We definitely don't want to just link to the hub, we need a curated list. Just like we had for years now.

@sanderjo
Copy link
Contributor Author

Docker should be considered a first-class option

@jeffgeorge this is an example of SABnzbd on Docker on a NAS (Asustor) ... with problems: https://www.reddit.com/r/SABnzbd/comments/1hz4gri/permission_erroe/ . If you can help that user, that would very be helpful: I find this very hard to analyze: docker mapping, settings inside SABnzbd, rights on the disk ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants