saltyorg / docs Goto Github PK

Step 1: Run install according to the docs
Step 2: Access Plex and set up the libraries

After setting everything up I get this in Autoscan and my Radarr imported movies do not pop up in Plex:

Apr 10 14:16:30 INF Starting server on port 3030
Apr 10 14:16:30 FTL Failed initialising target error="version: 404 Not Found: target unavailable" target=plex target_url=https://plex.domain.tld

Where should I start looking?

Docs for: saltyorg/Sandbox#158

It looks like bernard isn't included at all as a trigger but the documentation doesn't reflect that.

Also, a-train isn't installed in core, so it looks like the user needs to install sandbox and a-train before moving forward with autoscan setup.

May I suggest removing reference to port 80 in the example format(s) for your-own-containers.md. I aware (now) that's its clearly referenced down the bottom of the page that it's the container port that should go here, but because it wasn't at least highlighted or maybe shown with a value of <container_port> I missed it when throwing a container together.

This is definitely a "just make sure you read the whole page" kinda thing but I thought it could relieve some headaches in the future for people half asleep like me.

Moving Sandbox Issue to Docs issue.
#115

Wiki needs to be updated in accessing_apps.md to show the Plex Webtools address as https://plex-webtools.yourdomain.com and remove the * from the bottom.

Community and Sandbox settings.yml documentations need to be reworked after app migration.

Following the guide in the docs, the link at the bottom of google permissions under google, in References . The link at the bottom of the page, continue with next step is broken. However, on the left you can select the subsequent tab under google.

Docker run example:

docker run -d  \
    --name=APPNAME  \
    --restart=unless-stopped  \
    -e PGID=1000 -e PUID=1000  \
    -v /opt/APPNAME:/CONFIG  \
    -v /etc/localtime:/etc/localtime:ro  \
    --network=saltbox \
    --network-alias=APPNAME  \
    --label com.github.saltbox.saltbox_managed=true \
    --label traefik.enable=true \
    --label traefik.http.routers.APPNAME.entrypoints=websecure \
    --label traefik.http.routers.APPNAME.middlewares=secureHeaders@file \
    --label traefik.http.routers.APPNAME.rule=Host(\`APPNAME.yourdomain.com\`) \
    --label traefik.http.routers.APPNAME.service=APPNAME \
    --label traefik.http.routers.APPNAME.tls.certresolver=cfdns \
    --label traefik.http.routers.APPNAME.tls.options=securetls@file \
    --label traefik.http.services.APPNAME.loadbalancer.server.port=80 \
    docker/image

Explain how to setup zerossl with EAB credentials. Sidenote: add help in saltbox if needed to facilitate such a configuration.

In the rClone section of this documentation page: https://docs.saltbox.dev/saltbox/install/install/#preinstall

The info block isn't called out expressly enough. It's very easy to miss that the small "here" link is a list of actionable items and easy to overlook, particularly when the previous and next info blocks on the page are meta-documentation with nothing actionable.

The fact that this is a set of actionable tasks should be called out more.

Appears client is significantly different to when docs were first made for this app.

Docs for: saltyorg/Sandbox#157

Docs for: saltyorg/Sandbox#161

Docs for: saltyorg/Sandbox#164

Docs for saltyorg/Sandbox#163

Nevermind.

Hi there,
Not sure if I should be posting this here, but here I go anyway. Firstly, love your work and thank you;

Secondly, I just wanted to ask if it is possible to change the options in adv_settings.yml, specifically enabling nVidia GPU support, after installing and configuring the rest of saltbox; ie. I've had it installed for weeks now but I only just saw this option.

Thanks! :)
Lachie

Docs for: saltyorg/Sandbox#169

Cloudflare has a new UI so things don't look the same as on the documentation.

The screenshot is not viewable for the examples.

Docs for: saltyorg/Sandbox#155

https://docs.saltbox.dev/sandbox/apps/comixed/

A community-supported supercharged version of paperless: scan, index and archive all your physical documents.

Example docker compose: https://github.com/paperless-ngx/paperless-ngx/blob/main/docker/compose/docker-compose.postgres-tika.yml

Docs for: saltyorg/Sandbox#154

Docs for: saltyorg/Sandbox#173

Moving Docs Needed for tdarr issue from Sandbox repo to docs repo.

saltyorg/Sandbox#22

https://docs.saltbox.dev/reference/guides/chazguides/server/#server-hardware

There are three left over from Cloudbox

reference/domain.md
  45,14: ![](http://i.imgur.com/I7h5jSs.png)
  169,18:    ![](https://i.imgur.com/MaqAv5i.png)

saltbox/basics/paths.md
  25,15: ![](https://i.imgur.com/kwnNjni.png)

Since we've removed the manual healthcheck from the Sandbox repo, we need to create a docs page with sample healthchecks for various roles that a user can add via inventories. The below were the ones previously included and subsequently removed from Sandbox.

aria2_ng_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:8080"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

docspell_docker_healthcheck:
  test: ["CMD", "wget", "--spider", "http://localhost:{{ docspell_web_port }}/api/info/version"]
  interval: 1m
  timeout: 10s
  retries: 2
  start_period: 30s

duplicati_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:{{ duplicati_web_port }}"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

elasticsearch_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:9200"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

gaps_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:8484"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

heimdall_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:80"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

homeassistant_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:{{ homeassistant_web_port }}"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

koel_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

lunasea_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

omegabrr_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:{{ omegabrr_web_port }}"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

phpmyadmin_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:{{ phpmyadmin_web_port }}"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

plexshare_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:{{ plexshare_web_port }}"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

reposilite_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:{{ reposilite_web_port }}"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

rflood_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:3000"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

solr_docker_healthcheck:
  test: ["CMD", "curl", "-f", "http://localhost:{{ solr_docker_env_port }}/solr/{{ solr_docker_env_core_name }}/admin/ping"]
  interval: 1m
  timeout: 10s
  retries: 5
  start_period: 30s

tubearchivist_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:{{ tubearchivist_web_port }}"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

tvheadend_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:{{ tvheadend_web_port }}"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

wikijs_docker_healthcheck:
  test: ["CMD", "curl", "--fail", "http://localhost:3000"]
  interval: 10s
  timeout: 5s
  retries: 10
  start_period: 10s

Add explanation about how to do var overrides for instances with dashes in the name.

Short explanation is that Ansible doesn't allow dashes (while it technically works anyway we're trying to avoid problems in the future in case it becomes enforced with default vars as well) in variable names so we're renaming the instance under the hood even if the folders, docker container/hostname, and the like still contains the dash in it the variable will replace dashes with underscores.

Add doc related to sandbox role: saltyorg/Sandbox#167

https://docs.saltbox.dev/apps/hetzner_nfs/

Incorrect : nano /opt/community/hetzner_nfs.yml
Correct : nano /srv/git/saltbox/hetzner_nfs.yml

Under section : https://docs.saltbox.dev/apps/hetzner_nfs/#nfs-server-feederbox

Incorrect : sb install hetzner_nfs_server
Correct : sb install hetzner_nfs_client_mount

https://github.com/RealOrangeOne/docker-db-auto-backup

saltyorg/Sandbox@963d2eb

Docs for: saltyorg/Sandbox#156

Docs for saltyorg/Sandbox#160

Please add sarotate instructions.

Please Add Pyload
https://hub.docker.com/r/linuxserver/pyload-ng

Docs for: saltyorg/Sandbox#147

Explain media_server, download_clients and download_indexers roles and how to use them to change the apps installed by Saltbox, Mediabox and Feederbox tags.

Have created links and barebones template docs for following apps that were missing from the sandbox index.yml

They all need completing and filling out - URLS to docs and project page and they will need adding to the mkdocs.yml file when completed / repaired. If you fix one of these maybe mention it here or copy below list and remove the doc you have worked on when you paste it in a comment for the next person to look at - I will try to edit this post to reflect work done.

• sandbox/apps/a_train.md
• aria2-ng
• sandbox/apps/changedetection.md
• sandbox/apps/cherry.md
• dashy
• docspell
• elasticsearch
• sandbox/apps/freshrss.md
• sandbox/apps/gotenberg.md
• homeassistant
• sandbox/apps/homebox.md
• jellyseerr
• koel
• lunasea
• sandbox/apps/mcrouter.md
• mqtt
• n8n
• node-red
• phpmyadmin - NO DOC Made
• sandbox/apps/plex_auto_languages.md
• sandbox/apps/plex_autoscan.md
• sandbox/apps/plex_patrol.md
• plexshare
• sandbox/apps/plextraktsync.md
• sandbox/apps/plex_utills.md
• sandbox/apps/pyload.md
• sandbox/apps/python-plexlibrary.md
• sandbox/apps/qbittorrentvpn.md
• sandbox/apps/rdtclient.md
• sandbox/apps/rocketchat.md
• sandbox/apps/sarotate.md
• solr
• tauticord
• sandbox/apps/teamspeak.md
• sandbox/apps/tika.md
• sandbox/apps/transmissionvpn.md
• tvheadend
• sandbox/apps/whisparr.md
• sandbox/apps/xbackbone.md

Docs for: saltyorg/Sandbox#178

Docs for: saltyorg/Sandbox#175

Docs for: saltyorg/Sandbox#146

https://docs.saltbox.dev/saltbox/inventory/

Lists /srv/git/saltbox/role_name/defaults/main.yml where it should be /srv/git/saltbox/roles/role_name/defaults/main.yml

Docs for: saltyorg/Sandbox#189

https://docs.saltbox.dev/apps/radarr/#settings And https://docs.saltbox.dev/apps/sonarr/#settings. Both say to turn OFF hardlinks. Was told to create an issue. Hopefully I did it right.

Move out of sandbox and into Saltbox as per Blu_Pig discord discussion.

FYI)
I guess the app "netdata" is moved from "sandbox" to "embedded(?)" category.
in my case,
sb install sandbox-netdata # -> error ocurr
sb install netdata # -> works!

Audiobookshelf is a self-hosted audiobook server for managing and playing your audiobooks. Audiobookshelf has a clean, accessible design that's loaded with features but not overly complicated. Not only will it host your audiobooks, but Audiobookshelf will scan and host your Ebooks and podcasts. This also includes the iOS and Android apps that can be used in conjunction with the host side with playback sync. You can listen with the phone app on the go then continue where you left off on your laptop when you get home. Playback will seamlessly sync between all of your devices much like Plex or Jellyfin.

Features and Support

• Host and serve Audiobooks
• Host and serve Ebooks
• Host, search, automatically download and serve Podcasts
• Fully open-source, including the android & iOS app (in beta)
• Stream all audiobook formats on the fly
• Multi-user support w/ custom permissions
• Keeps progress per user and syncs across devices
• Auto-detects library updates, no need to re-scan
• Upload audiobooks w/ bulk upload drag and drop folders
• Backup your metadata + automated daily backups
• Progressive Web App (PWA)
• Chromecast support on the web app
• Fetch metadata and cover art from several sources

Links

• https://github.com/advplyr/audiobookshelf
• https://hub.docker.com/r/advplyr/audiobookshelf
• https://www.audiobookshelf.org/docs

Tracker announcements to Sonarr/Radarr/Lidarr.

https://gitlab.com/cloudb0x/trackarr
https://hotio.dev/containers/trackarr/