Skip to content

Add Unraid Community Applications template - #502

Open
mellow-fox wants to merge 1 commit into
tobiasehlert:mainfrom
mellow-fox:feat/unraid-community-apps
Open

Add Unraid Community Applications template#502
mellow-fox wants to merge 1 commit into
tobiasehlert:mainfrom
mellow-fox:feat/unraid-community-apps

Conversation

@mellow-fox

Copy link
Copy Markdown

What this PR does

This PR adds the two files required to list TeslaMateApi in the Unraid Community Applications catalog:

  • ca_profile.xml — Repository profile metadata (description, project link)
  • templates/teslamateapi.xml — Docker template that defines how the container appears and is configured in the Unraid UI

Why

TeslaMateApi is a great companion to TeslaMate, and many TeslaMate users run their stack on Unraid. Having TeslaMateApi available in the Community Apps catalog would make it discoverable and installable in a few clicks, instead of requiring manual Docker setup.

What's in the template

The XML template exposes all the key environment variables from the README:

Section Variables
Always visible DATABASE_HOST, DATABASE_PORT, DATABASE_USER, DATABASE_PASS, DATABASE_NAME, ENCRYPTION_KEY, MQTT_HOST, MQTT_PORT, TZ
Advanced MQTT auth/TLS/namespace, TeslaMate host/port/SSL, database timeout/SSL, API token, commands toggle, debug mode

Sensitive values (DATABASE_PASS, ENCRYPTION_KEY, API_TOKEN, MQTT_PASSWORD) are masked in the UI.

What you'd need to do after merging

To complete the listing, you would need to submit this repository to the Unraid Community Apps catalog:

  1. Go to https://ca.unraid.net/submit/new
  2. Enter your repository URL (https://github.com/tobiasehlert/teslamateapi)
  3. Follow the validation steps (Validate → Scan → Submit)

That's it — the XML files in this PR handle everything else. Unraid's system will periodically sync your repo to keep the listing up to date.

Optional enhancements

  • Icon: Adding an icon.png or icon.svg at the repo root and referencing it in both XML files would give the app a logo in the Unraid catalog
  • Forum/Discord links: Can be added to ca_profile.xml if you have community channels

References

Add ca_profile.xml and Docker XML template to enable submission
to the Unraid Community Applications catalog.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@mellow-fox

Copy link
Copy Markdown
Author

Also, if you'd rather not handle the submission yourself, I'm happy to create a separate repository with these templates and submit it to the Unraid CA catalog on your behalf. Just let me know what you'd prefer!

@sonarqubecloud

Copy link
Copy Markdown

@tobiasehlert tobiasehlert self-assigned this Jul 7, 2026
@tobiasehlert tobiasehlert added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jul 7, 2026
@tobiasehlert

Copy link
Copy Markdown
Owner

Hi @mellow-fox,

Thanks for the PR and for taking the time to put this together! 🙏
However, I'm not sure if I think merging it is what I'd do, but let's discuss!

The TeslaMate project itself had a PR for adding Unraid Community Apps support (teslamate-org/teslamate#4758) but decided not to include that — instead opting for a docs page covering Unraid installation: https://docs.teslamate.org/docs/installation/unsupported/unraid
As @JakobLichterfeld noted in that PR, maintaining a Community Apps template also means being able to support that deployment method, and that's something I think can be a little hard, I'm not familiar with Unraid as well.

I appreciate the idea though, but maybe a way forward would be if you'd like to maintain a personal Community Apps template for TeslaMateApi instead as others do for other applications?
I'm happy to link to it from the README in that case as well.

Kind regards,
Tobias

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation good first issue Good for newcomers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants