diff --git a/charts/incubator/lancache-monolithic/docs/installation_notes.md b/charts/incubator/lancache-monolithic/docs/installation_notes.md deleted file mode 100644 index d0992f8b389..00000000000 --- a/charts/incubator/lancache-monolithic/docs/installation_notes.md +++ /dev/null @@ -1,15 +0,0 @@ -# Installation Notes - -Clients like Steam, Battle.net, etc sends requests to port 80/443. -In case you don't want to use traefik in front of this app, you need to change the ports. - -- `Service` -> `Main` -> `Port`: **80** -- `Service` -> `https` -> `Port`: **443** - -:::danger - -Doing this will break Traefik and we do NOT recommend it. -Also, you have to make sure that you do NOT have any other service on these ports. -Like TrueNAS Scale WebUI. - -::: diff --git a/charts/incubator/lancache-dns/.helmignore b/charts/stable/lancache-dns/.helmignore similarity index 100% rename from charts/incubator/lancache-dns/.helmignore rename to charts/stable/lancache-dns/.helmignore diff --git a/charts/incubator/lancache-dns/CHANGELOG.md b/charts/stable/lancache-dns/CHANGELOG.md similarity index 100% rename from charts/incubator/lancache-dns/CHANGELOG.md rename to charts/stable/lancache-dns/CHANGELOG.md diff --git a/charts/incubator/lancache-dns/Chart.yaml b/charts/stable/lancache-dns/Chart.yaml similarity index 79% rename from charts/incubator/lancache-dns/Chart.yaml rename to charts/stable/lancache-dns/Chart.yaml index 3681f38e80c..31b67b5f61d 100644 --- a/charts/incubator/lancache-dns/Chart.yaml +++ b/charts/stable/lancache-dns/Chart.yaml @@ -1,18 +1,18 @@ apiVersion: v2 kubeVersion: ">=1.16.0-0" name: lancache-dns -version: 0.0.29 +version: 1.0.0 appVersion: "latest" description: DNS Chart service for a steam cache. type: application deprecated: false -home: https://truecharts.org/docs/charts/incubator/lancache-dns +home: https://truecharts.org/docs/charts/stable/lancache-dns icon: https://truecharts.org/img/hotlink-ok/chart-icons/lancache-dns.png keywords: - lancache-dns - dns sources: - - https://github.com/truecharts/charts/tree/master/charts/incubator/lancache-dns + - https://github.com/truecharts/charts/tree/master/charts/stable/lancache-dns - https://hub.docker.com/r/lancachenet/lancache-dns - https://github.com/lancachenet/lancache-dns dependencies: @@ -25,6 +25,6 @@ maintainers: url: https://truecharts.org annotations: truecharts.org/catagories: | - - incubator + - networking truecharts.org/SCALE-support: "true" truecharts.org/grade: U diff --git a/charts/incubator/lancache-dns/README.md b/charts/stable/lancache-dns/README.md similarity index 100% rename from charts/incubator/lancache-dns/README.md rename to charts/stable/lancache-dns/README.md diff --git a/charts/stable/lancache-dns/docs/installation_notes.md b/charts/stable/lancache-dns/docs/installation_notes.md new file mode 100644 index 00000000000..f2734eeb270 --- /dev/null +++ b/charts/stable/lancache-dns/docs/installation_notes.md @@ -0,0 +1,5 @@ +# Installation Notes + +- Set `USE GENERIC CACHE` to **true** if you are running `lancache-monolithic`. +- Set `LANCACHE IP` to the local IP that `lancache-monolithic` runs on. +- You can leave `Disable Cache DNS Resolvers` as disabled to cache all supported game servers or choose from the small list to not cache. you can add more by setting the environment variable of DISABLE\_${SERVICE}=true to `Configure Extra Environment Variables`. diff --git a/charts/incubator/lancache-dns/icon.png b/charts/stable/lancache-dns/icon.png similarity index 100% rename from charts/incubator/lancache-dns/icon.png rename to charts/stable/lancache-dns/icon.png diff --git a/charts/incubator/lancache-dns/questions.yaml b/charts/stable/lancache-dns/questions.yaml similarity index 100% rename from charts/incubator/lancache-dns/questions.yaml rename to charts/stable/lancache-dns/questions.yaml diff --git a/charts/incubator/lancache-dns/templates/common.yaml b/charts/stable/lancache-dns/templates/common.yaml similarity index 100% rename from charts/incubator/lancache-dns/templates/common.yaml rename to charts/stable/lancache-dns/templates/common.yaml diff --git a/charts/incubator/lancache-dns/values.yaml b/charts/stable/lancache-dns/values.yaml similarity index 100% rename from charts/incubator/lancache-dns/values.yaml rename to charts/stable/lancache-dns/values.yaml diff --git a/charts/incubator/lancache-monolithic/.helmignore b/charts/stable/lancache-monolithic/.helmignore similarity index 100% rename from charts/incubator/lancache-monolithic/.helmignore rename to charts/stable/lancache-monolithic/.helmignore diff --git a/charts/incubator/lancache-monolithic/CHANGELOG.md b/charts/stable/lancache-monolithic/CHANGELOG.md similarity index 100% rename from charts/incubator/lancache-monolithic/CHANGELOG.md rename to charts/stable/lancache-monolithic/CHANGELOG.md diff --git a/charts/incubator/lancache-monolithic/Chart.yaml b/charts/stable/lancache-monolithic/Chart.yaml similarity index 81% rename from charts/incubator/lancache-monolithic/Chart.yaml rename to charts/stable/lancache-monolithic/Chart.yaml index 87f24cc3926..43e9fd122e3 100644 --- a/charts/incubator/lancache-monolithic/Chart.yaml +++ b/charts/stable/lancache-monolithic/Chart.yaml @@ -1,18 +1,18 @@ apiVersion: v2 kubeVersion: ">=1.16.0-0" name: lancache-monolithic -version: 0.0.33 +version: 1.0.0 appVersion: "latest" description: A monolithic lancache service capable of caching all CDNs in a single instance. type: application deprecated: false -home: https://truecharts.org/docs/charts/incubator/lancache-monolithic +home: https://truecharts.org/docs/charts/stable/lancache-monolithic icon: https://truecharts.org/img/hotlink-ok/chart-icons/lancache-monolithic.png keywords: - monolithic - lancache sources: - - https://github.com/truecharts/charts/tree/master/charts/incubator/lancache-monolithic + - https://github.com/truecharts/charts/tree/master/charts/stable/lancache-monolithic - https://hub.docker.com/r/lancachenet/monolithic - https://github.com/lancachenet/monolithic dependencies: diff --git a/charts/incubator/lancache-monolithic/README.md b/charts/stable/lancache-monolithic/README.md similarity index 100% rename from charts/incubator/lancache-monolithic/README.md rename to charts/stable/lancache-monolithic/README.md diff --git a/charts/stable/lancache-monolithic/docs/installation_notes.md b/charts/stable/lancache-monolithic/docs/installation_notes.md new file mode 100644 index 00000000000..432f11a97fd --- /dev/null +++ b/charts/stable/lancache-monolithic/docs/installation_notes.md @@ -0,0 +1,63 @@ +# Installation Notes + +Clients like Steam, Battle.net, etc sends requests to port 80/443. +In case you don't want to use traefik in front of this app, you need to change the ports. + +- `Service` -> `Main` -> `Port`: **80** +- `Service` -> `https` -> `Port`: **443** + +:::danger + +Doing this will break Traefik and we do NOT recommend it. +Also, you have to make sure that you do NOT have any other service on these ports. +Like TrueNAS Scale WebUI. + +::: + +## Lancache-dns + +- It's highly recommended to also install the `lancache-dns` chart along side the monolithic chart. + +## Prefill Tools + +- You can run the Prefill tools directly inside the chart's shell. +- [SteamPrefill](https://github.com/tpill90/steam-lancache-prefill) +- [BattleNetPrefill](https://github.com/tpill90/battlenet-lancache-prefill) + +- In order for those tools to function you will need to install a apt pkg called `unzip`. This pkg will not persist between updates. It will need to be reinstalled before updating the tools everytime. + +- The following scripts are examples, but can be used to not only install them but also update them too. The scripts are a bit modified from the original that comes from [SteamPrefill](https://github.com/tpill90/steam-lancache-prefill/blob/master/scripts/update.sh). + +:::danger + +Always be cautious when running unkown scripts and read them over before executing. + +::: + +### SteamPrefill + +- This is a small modified update script from SteamPrefill to install the tool. +- Add this script to the `/data` dir and name it for ex: `install_steam.sh`. +- run this command on the script `chmod +x install_steam.sh` to be able to execute it from the shell. +- This script will create a new dir called `Steam` and grab the latest zip from `tpill90` repo for SteamPrefill and auto chmod +x for you. +- Then `cd Steam` if still in `/data` and execute `./SteamPrefill select-apps`. +- If you are not login into Steam yet, the tool will ask for: +- Username. +- Password. +- Steam Guard Code(if enabled on the account). + +- Checkout the [install_steam.sh](https://gist.github.com/Xstar97/769878e95e4c505d7339fc840b88c82e) here. + +### BattleNetPrefill + +- This is a small modified update script from SteamPrefill to install BattleNetPrefill. +- Add this script to the `/data` dir and name it for ex: `install_battlenet.sh`. +- run this command on the script `chmod +x install_battlenet.sh` to be able to execute it from the shell. +- This script will create a new dir called `BattleNet` and grab the latest zip from `tpill90` repo for BattlenetPrefill and auto chmod +x for you. +- Then `cd BattleNet` if still in `/data` and execute `./BattleNetPrefill -h`. + +- BattleNetPrefill doesnt require an account. But the command to prefill are a bit different. +- In order to prefill a specific game. you need to run this command first `./BattleNetPrefill list-products` to get the product ID. +- Then you can run `./BattleNetPrefill prefill -p PRODUCT_ID`. + +- Checkout the [install_battlenet.sh](https://gist.github.com/Xstar97/ebb42ccbd9b00a1407e363dbd917309b) here. diff --git a/charts/incubator/lancache-monolithic/icon.png b/charts/stable/lancache-monolithic/icon.png similarity index 100% rename from charts/incubator/lancache-monolithic/icon.png rename to charts/stable/lancache-monolithic/icon.png diff --git a/charts/incubator/lancache-monolithic/questions.yaml b/charts/stable/lancache-monolithic/questions.yaml similarity index 100% rename from charts/incubator/lancache-monolithic/questions.yaml rename to charts/stable/lancache-monolithic/questions.yaml diff --git a/charts/incubator/lancache-monolithic/templates/common.yaml b/charts/stable/lancache-monolithic/templates/common.yaml similarity index 100% rename from charts/incubator/lancache-monolithic/templates/common.yaml rename to charts/stable/lancache-monolithic/templates/common.yaml diff --git a/charts/incubator/lancache-monolithic/values.yaml b/charts/stable/lancache-monolithic/values.yaml similarity index 96% rename from charts/incubator/lancache-monolithic/values.yaml rename to charts/stable/lancache-monolithic/values.yaml index ab152142a1e..8eced2f8870 100644 --- a/charts/incubator/lancache-monolithic/values.yaml +++ b/charts/stable/lancache-monolithic/values.yaml @@ -39,7 +39,7 @@ service: persistence: config: enabled: true - mountPath: "/data/cache" + mountPath: "/data" logs: enabled: true mountPath: "/data/logs"