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

Example app config how-to's needed #742

Closed
Ixian opened this issue Aug 7, 2021 · 5 comments
Closed

Example app config how-to's needed #742

Ixian opened this issue Aug 7, 2021 · 5 comments
Labels
enhancement New feature or request

Comments

@Ixian
Copy link

Ixian commented Aug 7, 2021

Is your feature request related to a problem? Please describe.
As the TrueNAS Scale RC gets closer to release, there will be an influx of new users looking to install apps who are not familiar with Kubernetes, Traefix, Docker, or all 3. The existing manual is out of date and lacks important info such as common configuration examples.
Describe the solution you'd like
A start-to-finish example of how to configure common apps (such as Plex, etc.) in combination with Traefix, etc. would be very useful.

Describe alternatives you've considered
Unless you are already very familiar with Kubernetes it is extremely difficult to map existing Kubernetes tutorials to how TrueNAS & Truecharts GUI configuration works, especially since the latter often "hides" advanced details.

I am pretty adept at working with dockers/docker-compose, and also familar with reverse proxies as I use HAProxy on my OPNSense firewall. However I found myself at a loss trying to even get a basic Truecharts app setup due to having no "starting point" for configurations - how ingress is handled in particular is quite confusing.

It's not even completely clear (it is mentioned, yes, but not obvious) that the first Truecharts app that should be installed is Traefix, or how to configure it once you do.

A setup walkthrough would be really helpful to new users so we could take advantage of all the great effort that is being put in to this project - much appreciated!

@Ixian Ixian added the enhancement New feature or request label Aug 7, 2021
@stavros-k
Copy link
Member

Documentation is indeed outdated, but it's on the todo list. I can say an exact ETA because I'm not the guy that can make good documentation :D.

About the "how ingress works", most of it is handled automatically on the background from the common library that @Ornias1993 has put a ton of time to make it super.

There will be some basic walkthroughs videos for now, that will show how to get started. You can view them soon in the new TrueCharts channel in Youtube

Traefik is not something that you have to install or to install first. It's just the "easy" way to have ingress on your apps. But, yes, if you want to take advantage of the ingress feature on TrueCharts apps, you will need it.

I probably can make some additional videos later for configuring common apps, but it will be probably without sound,

@Ixian
Copy link
Author

Ixian commented Aug 7, 2021

Thanks! I'm doing testing on a backup server learning by doing.

I ran into trouble even trying a simple test app I was already familiar with (Jellyfin) - I could only access it via the Node port. I tried going the traefik route but am lost trying to figure out what to enter for host, path, etc. Also getting an error in the Traefix GUI telling me the middleware for my app is not configured. I'm obviously missing some important bits which is why examples would be really helpful - even if they don't fit my exact situation it'll help everything "click" in to place.

@stavros-k
Copy link
Member

You can always come to the Discord server, post screenshots of your config and find out where the problem is!

@Ornias1993
Copy link
Member

I'm going to close this, as it's too arbitrary to keep an issue open for this.
There is no "magic pill" for setting up apps that would be 100% universal and the documentation that needs improving is to general and to much of an "ongoing process to keep an issue open.

@truecharts-admin
Copy link
Collaborator

This issue is locked to prevent necro-posting on closed issues. Please create a new issue or contact staff on discord of the problem persists

@truecharts truecharts locked and limited conversation to collaborators Feb 6, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants