diff --git a/docs/guides/community-wiki/index.md b/docs/guides/community-wiki/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/guides/run-cdp-on-truenas-scale.md b/docs/guides/run-cdp-on-truenas-scale.md deleted file mode 100644 index 7935a72b..00000000 --- a/docs/guides/run-cdp-on-truenas-scale.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Run CDP on TrueNAS Scale -hide: - - toc ---- - -!!! info - Written by [WiiGe](https://github.com/WiiGe){:target="_blank"}. Originally posted on stashapp/stash discussions[^1]. - -A way to use CDP scraper on TrueNAS Scale and install chromedp/headless-shell on TrueNAS Scale. - -People using stash-app on TrueNAS Scale like me may face the problem that no supported CDP app by truecharts or truenas , and now I found a way to properly run [chromedp/headless-shell](https://github.com/chromedp/docker-headless-shell){:target="_blank"}. - -This can be done by custom-app. - -![image](../assets/guides/run-cdp-on-truenas-scale/1.png){ width=300 align=center } - -According to [docker hub page of chromedp/headless-shell](https://hub.docker.com/r/chromedp/headless-shell/){:target="_blank"}, we start container with `docker run -d -p 9222:9222 --rm --name headless-shell --shm-size 2G chromedp/headless-shell`, but this's not enough for TrueNAS Scale which run everything with K3s. - -In order to run a docker image on K3s, we need to warp docker image with [custom-app](https://truecharts.org/charts/stable/custom-app/){:target="_blank"}, fill the Container Repository with `chromedp/headless-shell` and Container Tag with `latest` so that TrueNAS can pull the image for you. - -![image](../assets/guides/run-cdp-on-truenas-scale/2.png){ width=300 align=center } - -As for the docker args `docker run -d -p 9222:9222 --rm --name headless-shell --shm-size 2G chromedp/headless-shell`, we need to translate the args and env parameter into custom-app configuration. Under the Workload Settings section of custom-app configuration page, there will be a list of Extra Args, we put `--name headless-shell --shm-size 2G` here in custom-app way. - -![image](../assets/guides/run-cdp-on-truenas-scale/3.png){ width=200 align=center } - -But due to [this issue](https://github.com/Zenika/alpine-chrome/issues/109#issuecomment-1998061550){:target="_blank"}, K3s will report an error of zygote: `ERROR:zygote_host_impl_linux.cc(262)] Failed to adjust OOM score of renderer with pid 28: Permission denied (13)`, solution is simple - just offer extra args to disable it :`--headless --disable-gpu --no-sandbox --no-zygote --disable-software-rasterizer --disable-dev-shm-usage`. - -`--remote-debugging-address=0.0.0.0 --remote-debugging-port=9222` is not needed because we will set port and ip on Networking and Services section for LoadBalancer (I am using 192.168.1.45 and 9222, change it for your own scenario). - -The Networking section and the final Extra Args page should be like this: - -![image](../assets/guides/run-cdp-on-truenas-scale/4.png){ width=200 align=center } -![image](../assets/guides/run-cdp-on-truenas-scale/5.png){ width=200 align=center } - -and click Install button then your headless-shell will be good to go. - -The last step: just fill stash's CDP setting with `http://192.168.1.45:9222/json/version`(still, change ip:port for your own scenario), and now cdp should be running for you. - -An extra note is Ingress section of custom-app, you may want to use chromedp/headless-shell remotely (e.g. accessing cdp by https://cdp.example.com/json/version), you need to modify the header of request with SetHeader function, see [Host header is specified and is not an IP address or localhost](https://github.com/chromedp/chromedp/issues/505){:target="_blank"}. Obviously stash scraper do not support such operation, write your own scraper in this circumstances. - -I just put the info I found together and share here, hope this page help more people who try to use CDP scraper on K3s-based OS. - -[^1]: [https://github.com/stashapp/stash/discussions/4719](https://github.com/stashapp/stash/discussions/4719){target=_blank} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index c675c27d..e898ab1e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -72,6 +72,7 @@ plugins: 'beginner-guides/exclude-file-configuration.md': 'in-app-manual/configuration.md' 'add-ons.md': 'plugins/index.md' 'faq/setup.md': 'https://discourse.stashapp.cc/t/-/1658' + 'guides/community-wiki/index.md': 'https://discourse.stashapp.cc/tags/c/community-wiki/22/stash' watch: - includes @@ -155,11 +156,12 @@ nav: - Backup and restore database: guides/backup-and-restore-database.md - Reverse proxy: guides/reverse-proxy.md - Troubleshooting video playback: guides/troubleshooting-video-playback.md - - Run CDP on TrueNAS Scale: guides/run-cdp-on-truenas-scale.md - Advanced configuration options: guides/advanced-configuration-options.md - Bulk importing via CSV using gql-iterate: guides/importing-via-csv-using-gql-iterate.md - Manually editing the Stash sqlite3 database: guides/manually-editing-the-stash-sqlite3-database.md - Scraping metadata behind login: guides/scraping-metadata-behind-login.md + - Community wiki: + - guides/community-wiki/index.md - Metadata sources: - metadata-sources/index.md - stash-box instances: metadata-sources/stash-box-instances.md