283 lines
380 KiB
HTML
283 lines
380 KiB
HTML
|
<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=description content="Project Documentation for TrueCharts"><meta name=author content="TrueCharts Team"><link href=https://truecharts.org/manual/development/ingress/ rel=canonical><link rel=icon href=../../../_static/img/favicon.png><meta name=generator content="mkdocs-1.3.0, mkdocs-material-8.3.8"><title>Ingress - TrueCharts</title><link rel=stylesheet href=../../../assets/stylesheets/main.1d29e8d0.min.css><link rel=stylesheet href=../../../assets/stylesheets/palette.cbb835fc.min.css><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"><style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style><link rel=stylesheet href=../../../_static/custom.css><script>__md_scope=new URL("../../..",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script><script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-6G6694723V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&>ag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-6G6694723V",{page_path:e.pathname})})})</script><script async src="https://www.googletagmanager.com/gtag/js?id=G-6G6694723V"></script></head> <body dir=ltr data-md-color-scheme data-md-color-primary=none data-md-color-accent=none> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#ingress class=md-skip> Skip to content </a> </div> <div data-md-component=announce> </div> <header class=md-header data-md-component=header> <nav class="md-header__inner md-grid" aria-label=Header> <a href=../../.. title=TrueCharts class="md-header__button md-logo" aria-label=TrueCharts data-md-component=logo> <img src=../../../_static/img/logo1024.png alt=logo> </a> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg> </label> <div class=md-header__title data-md-component=header-title> <div class=md-header__ellipsis> <div class=md-header__topic> <span class=md-ellipsis> TrueCharts </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> Ingress </span> </div> </div> </div> <div class=md-header__source> <a href=https://github.com/truecharts/pub title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 480 512"><!-- Font Awesome Free 6.1.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.
|
||
|
|
label: "Ingress Configuration"
|
||
|
|
group: "Ingress Configuration"
|
||
|
|
schema:
|
||
|
|
type: dict
|
||
|
|
attrs:
|
||
|
|
- variable: main
|
||
|
|
label: "Main Ingress"
|
||
|
|
schema:
|
||
|
|
type: dict
|
||
|
|
attrs:
|
||
|
|
- variable: enabled
|
||
|
|
label: "Enable Ingress"
|
||
|
|
schema:
|
||
|
|
type: boolean
|
||
|
|
default: false
|
||
|
|
show_subquestions_if: true
|
||
|
|
subquestions:
|
||
|
|
- variable: hosts
|
||
|
|
label: "Hosts"
|
||
|
|
schema:
|
||
|
|
type: list
|
||
|
|
default: []
|
||
|
|
items:
|
||
|
|
- variable: host
|
||
|
|
label: "Host"
|
||
|
|
schema:
|
||
|
|
type: dict
|
||
|
|
attrs:
|
||
|
|
- variable: host
|
||
|
|
label: "HostName"
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
default: ""
|
||
|
|
required: true
|
||
|
|
- variable: paths
|
||
|
|
label: "Hosts"
|
||
|
|
schema:
|
||
|
|
type: list
|
||
|
|
default: []
|
||
|
|
items:
|
||
|
|
- variable: path
|
||
|
|
label: "path"
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
required: true
|
||
|
|
hidden: false
|
||
|
|
default: "/"
|
||
|
|
- variable: pathType
|
||
|
|
label: "pathType"
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
required: true
|
||
|
|
hidden: false
|
||
|
|
default: "Prefix"
|
||
|
|
- variable: tls
|
||
|
|
label: "TLS-Settings"
|
||
|
|
schema:
|
||
|
|
type: list
|
||
|
|
default: []
|
||
|
|
items:
|
||
|
|
- variable: hosts
|
||
|
|
label: "Certificate Hosts"
|
||
|
|
schema:
|
||
|
|
type: list
|
||
|
|
default: []
|
||
|
|
items:
|
||
|
|
- variable: host
|
||
|
|
label: "Host"
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
default: ""
|
||
|
|
required: true
|
||
|
|
- variable: scaleCERT
|
||
|
|
label: "Select TrueNAS SCALE Certificate"
|
||
|
|
schema:
|
||
|
|
type: int
|
||
|
|
$ref:
|
||
|
|
- "definitions/certificate"
|
||
|
|
</code></pre></div> <h5 id=tcp-ingress>TCP Ingress<a class=headerlink href=#tcp-ingress title="Permanent link">¶</a></h5> <div class=highlight><pre><span></span><code> - variable: tcp
|
||
|
|
label: "TCP Reverse Proxy Configuration"
|
||
|
|
schema:
|
||
|
|
type: dict
|
||
|
|
attrs:
|
||
|
|
- variable: enabled
|
||
|
|
label: "Enable TCP Reverse Proxy"
|
||
|
|
schema:
|
||
|
|
type: boolean
|
||
|
|
default: false
|
||
|
|
show_subquestions_if: true
|
||
|
|
subquestions:
|
||
|
|
- variable: type
|
||
|
|
label: "Select Reverse Proxy Type"
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
default: "TCP"
|
||
|
|
required: true
|
||
|
|
editable: false
|
||
|
|
hidden: true
|
||
|
|
- variable: serviceName
|
||
|
|
label: "Service name to proxy to"
|
||
|
|
schema:
|
||
|
|
hidden: true
|
||
|
|
editable: false
|
||
|
|
type: string
|
||
|
|
default: ""
|
||
|
|
- variable: entrypoint
|
||
|
|
label: "Select Entrypoint"
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
default: "torrent-tcp"
|
||
|
|
required: true
|
||
|
|
enum:
|
||
|
|
- value: "torrent-tcp"
|
||
|
|
description: "Torrent-TCP: port 51413"
|
||
|
|
</code></pre></div> <h5 id=udp-ingress>UDP Ingress<a class=headerlink href=#udp-ingress title="Permanent link">¶</a></h5> <div class=highlight><pre><span></span><code> - variable: udp
|
||
|
|
label: "UDP Reverse Proxy Configuration"
|
||
|
|
schema:
|
||
|
|
type: dict
|
||
|
|
attrs:
|
||
|
|
- variable: enabled
|
||
|
|
label: "Enable UDP Reverse Proxy"
|
||
|
|
schema:
|
||
|
|
type: boolean
|
||
|
|
default: false
|
||
|
|
show_subquestions_if: true
|
||
|
|
subquestions:
|
||
|
|
- variable: type
|
||
|
|
label: "Select Reverse Proxy Type"
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
default: "UDP"
|
||
|
|
required: true
|
||
|
|
editable: false
|
||
|
|
hidden: true
|
||
|
|
- variable: serviceName
|
||
|
|
label: "Service name to proxy to"
|
||
|
|
schema:
|
||
|
|
hidden: true
|
||
|
|
editable: false
|
||
|
|
type: string
|
||
|
|
default: ""
|
||
|
|
- variable: entrypoint
|
||
|
|
label: "Select Entrypoint"
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
default: "torrent-udp"
|
||
|
|
required: true
|
||
|
|
enum:
|
||
|
|
- value: "torrent-udp"
|
||
|
|
description: "Torrent-UDP: port 51413"
|
||
|
|
</code></pre></div> <h3 id=other-ingress-options>Other Ingress options<a class=headerlink href=#other-ingress-options title="Permanent link">¶</a></h3> <p>There are a few other options that are rarely (if ever) used.</p> <h5 id=serviceport>servicePort<a class=headerlink href=#serviceport title="Permanent link">¶</a></h5> <div class=highlight><pre><span></span><code> - variable: servicePort
|
||
|
|
label: "Service Port to proxy to"
|
||
|
|
schema:
|
||
|
|
hidden: true
|
||
|
|
editable: false
|
||
|
|
type: int
|
||
|
|
default: 80
|
||
|
|
</code></pre></div> <h5 id=servicekind>serviceKind<a class=headerlink href=#servicekind title="Permanent link">¶</a></h5> <div class=highlight><pre><span></span><code> - variable: serviceKind
|
||
|
|
label: "Service Kind to proxy to"
|
||
|
|
schema:
|
||
|
|
hidden: true
|
||
|
|
editable: false
|
||
|
|
type: string
|
||
|
|
default: ""
|
||
|
|
</code></pre></div> <h3 id=external-services>External Services<a class=headerlink href=#external-services title="Permanent link">¶</a></h3> <p>The externalServices option, is actually mostly an Ingress "under the hood" which just creates a very small (minimal) service.</p> <div class=highlight><pre><span></span><code> - variable: externalServices
|
||
|
|
label: "(Advanced) Add External Services"
|
||
|
|
group: "Advanced"
|
||
|
|
schema:
|
||
|
|
type: list
|
||
|
|
default: []
|
||
|
|
items:
|
||
|
|
- variable: externalService
|
||
|
|
label: "External Service"
|
||
|
|
schema:
|
||
|
|
type: dict
|
||
|
|
attrs:
|
||
|
|
- variable: enabled
|
||
|
|
label: "Enable Web Reverse Proxy"
|
||
|
|
schema:
|
||
|
|
type: boolean
|
||
|
|
hidden: true
|
||
|
|
editable: false
|
||
|
|
default: true
|
||
|
|
- variable: type
|
||
|
|
label: "Reverse Proxy Type"
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
default: "HTTP"
|
||
|
|
hidden: true
|
||
|
|
editable: false
|
||
|
|
required: true
|
||
|
|
- variable: serviceName
|
||
|
|
label: "Service name to proxy to"
|
||
|
|
schema:
|
||
|
|
hidden: true
|
||
|
|
editable: false
|
||
|
|
type: string
|
||
|
|
default: ""
|
||
|
|
- variable: serviceTarget
|
||
|
|
label: "IP Adress of the external service"
|
||
|
|
schema:
|
||
|
|
hidden: false
|
||
|
|
editable: true
|
||
|
|
required: true
|
||
|
|
type: string
|
||
|
|
default: "192.168.0.0"
|
||
|
|
- variable: servicePort
|
||
|
|
label: "External Service Port"
|
||
|
|
description: "The port on the external service you want to proxy"
|
||
|
|
schema:
|
||
|
|
hidden: false
|
||
|
|
required: true
|
||
|
|
editable: true
|
||
|
|
type: int
|
||
|
|
default: 80
|
||
|
|
- variable: serviceType
|
||
|
|
label: "Connection Type"
|
||
|
|
description: "Connection Type between Traefik and the external service"
|
||
|
|
schema:
|
||
|
|
hidden: false
|
||
|
|
editable: true
|
||
|
|
required: true
|
||
|
|
default: "HTTP"
|
||
|
|
type: string
|
||
|
|
enum:
|
||
|
|
- value: "HTTP"
|
||
|
|
description: "HTTP"
|
||
|
|
- value: "HTTPS"
|
||
|
|
description: "HTTPS"
|
||
|
|
- variable: serviceKind
|
||
|
|
label: "Service Kind to proxy to"
|
||
|
|
schema:
|
||
|
|
hidden: true
|
||
|
|
editable: false
|
||
|
|
type: string
|
||
|
|
default: ""
|
||
|
|
- variable: entrypoint
|
||
|
|
label: "Select Entrypoint"
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
default: "websecure"
|
||
|
|
required: true
|
||
|
|
enum:
|
||
|
|
- value: "websecure"
|
||
|
|
description: "Websecure: HTTPS/TLS port 443"
|
||
|
|
- variable: host
|
||
|
|
label: "Domain Name"
|
||
|
|
required: true
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
- variable: path
|
||
|
|
label: "path"
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
required: true
|
||
|
|
hidden: false
|
||
|
|
default: "/"
|
||
|
|
- variable: certType
|
||
|
|
label: "Select Certificate Type"
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
default: "selfsigned"
|
||
|
|
enum:
|
||
|
|
- value: ""
|
||
|
|
description: "No Encryption/TLS/Certificates"
|
||
|
|
- value: "selfsigned"
|
||
|
|
description: "Self-Signed Certificate"
|
||
|
|
- value: "ixcert"
|
||
|
|
description: "TrueNAS SCALE Certificate"
|
||
|
|
- variable: certificate
|
||
|
|
label: "Select TrueNAS SCALE Certificate"
|
||
|
|
schema:
|
||
|
|
type: int
|
||
|
|
show_if: [["certType", "=", "ixcert"]]
|
||
|
|
$ref:
|
||
|
|
- "definitions/certificate"
|
||
|
|
- variable: authForwardURL
|
||
|
|
label: "Forward Authentication URL"
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
default: ""
|
||
|
|
</code></pre></div> </article> </div> </div> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href=../handycommands/ class="md-footer__link md-footer__link--prev" aria-label="Previous: Command Cheatsheet" rel=prev> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> </div> <div class=md-footer__title> <div class=md-ellipsis> <span class=md-footer__direction> Previous </span> Command Cheatsheet </div> </div> </a> <a href=../portal/ class="md-footer__link md-footer__link--next" aria-label="Next: Portal Button" rel=next> <div class=md-footer__title> <div class=md-ellipsis> <span class=md-footer__direction> Next </span> Portal Button </div> </div> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> <div class=md-copyright__highlight> Copyright © 2020 - 2022 The TrueCharts Project </div> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "../../..", "features": ["navigation.tabs", "navigation.tracking", "navigation.instant", "search.highlight", "search.share", "search.suggest"], "search": "../../../assets/javascripts/workers/search.b97dbffb.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script> <script src=../../../assets/javascripts/bundle.0238f547.min.js></script> </body> </html>
|