Skip to content

docs: add Unraid installation instructions (no support) #4758

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

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

vypergts
Copy link

I've been responding to different reddit posts about setup on Unraid. I've had this working well for quite some time now so I figured it would be good to contribute directly here to the documentation. I haven't ever worked on github before though so please forgive if I didn't do this correctly or let me know how I can improve it for future updates.

Copy link

netlify bot commented May 23, 2025

Deploy Preview for teslamate ready!

Name Link
🔨 Latest commit 5f4895d
🔍 Latest deploy log https://app.netlify.com/projects/teslamate/deploys/6830d1af674c4c0007385d57
😎 Deploy Preview https://deploy-preview-4758--teslamate.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@JakobLichterfeld
Copy link
Member

JakobLichterfeld commented May 24, 2025

Thank you for your contribution!

I am not sure about adding this. We do not have the capacity to support all variants, therefore we only support docker and NixOS installation. All other tickets will be closed. Separate backup and restore instructions will delute the documentation even further and will result in bad maintainability.

@JakobLichterfeld JakobLichterfeld changed the title Unraid Documentation docs: add Unraid installation instructions (no support) May 24, 2025
@JakobLichterfeld JakobLichterfeld added the kind:documentation Adds or improves documentation label May 24, 2025
@JakobLichterfeld JakobLichterfeld marked this pull request as draft May 24, 2025 07:31
@swiffer
Copy link
Collaborator

swiffer commented May 25, 2025

Can't one use the compose add in and use the standard install we provide via docker?

https://docs.ibracorp.io/docker-compose/docker-compose-for-unraid

@vypergts
Copy link
Author

I can totally understand if you don’t want to support other installs, it’s still docker though, just easier? Updating a docker container in Unraid is one click with how I’ve documented it. It’s a way, way less command line. I suppose people could run the compose plugin too, my method is keeping it closer to the docker-for-dummys approach that Unraid takes.

@fiveangle
Copy link

On many other projects I've see a "Community Resources" section (with appropriate "not maintained or monitored by this project" disclaimer) in the project documentation that links to community-maintained resources, forums, docs, plugins, etc. It is a much lower level of management for the project maintainer since even if the links die well before the maintainer "cleans it up" once or twice a year, it doesn't reflect poorly on the project (plus there's always archive.org ;)
This allows rich resources for impassioned communities to be easily found without requiring users to have a minimum blue-belt in google-fu to find it. Something to consider.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:documentation Adds or improves documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants