docs(lidatube): Update README with detailed template information

templates/lidatube/README.md

@@ -1,8 +1,24 @@
-# lidatube (templates)
+# LidaTube (Portainer template)
 
-### Description
+LidaTube is a tool designed to bridge the gap between YouTube and your personal media library, often used for automating the downloading and organization of YouTube content into a format compatible with media servers like Lidarr.
-Description for lidatube goes here.
 
-### Configuration
+Quick notes:
-- Path: templates/lidatube/docker-compose.yml
+
-- Status: Draft
+- **Integration**: Designed to work alongside Lidarr to manage music videos or audio content sourced from YouTube.
+- **Persistence**: Ensure you map volumes for the configuration files and the download directory to prevent data loss.
+- **Dependencies**: Requires a functional internet connection and may require `ffmpeg` within the container environment for transcoding.
+
+Usage:
+
+1. Import the compose file into Portainer's Stacks or App Templates.
+2. Configure the volume mappings to point to your media library and config folder.
+3. Set environment variables for any specific naming conventions or quality preferences.
+4. Deploy the stack via Portainer.
+5. Access the web interface (if applicable) to link with your Lidarr instance.
+
+Helpful links:
+
+- GitHub Repository: https://github.com/TheLick/LidaTube
+- Docker Hub: https://hub.docker.com/r/thelick/lidatube
+
+**Status:** Ready for configuration

templates/lidatube/docker-compose.yml

@@ -0,0 +1,23 @@
+services:
+  lidatube:
+    image: thewicklowwolf/lidatube:latest
+    container_name: lidatube
+    volumes:
+      # Host path for application configuration. Change this to your desired path.
+      - ./config/lidatube:/lidatube/config
+      # Host path for music downloads. Change this to your desired path.
+      - ./data/lidatube/downloads:/lidatube/downloads
+      - /etc/localtime:/etc/localtime:ro
+    ports:
+      - 9274:5000
+    environment: 
+      # Set PUID and PGID to match your host user's UID and GID for proper file permissions.
+      # You can find these by running 'id <username>' on your host machine.
+      - PUID=1000
+      - PGID=1000
+      - sync_schedule=19,20,21,22,23,0,1,2,3,4,5
+      - attempt_lidarr_import=False
+      - thread_limit=1
+      - sleep_interval=1
+      
+    restart: unless-stopped