init manual

README.md

@@ -1,6 +1,6 @@
-# {{service}} with Tailscale Integration
+# Jellyfin with Tailscale Integration
 
-This project sets up a {{service}} instance with Tailscale VPN integration using Docker Compose. It creates a secure, private network connection for your {{service}} instance using Tailscale.
+This project sets up a Jellyfin instance with Tailscale VPN integration using Docker Compose. It creates a secure, private network connection for your Jellyfin instance using Tailscale.
 
 ## Prerequisites
 
@@ -10,65 +10,64 @@ This project sets up a {{service}} instance with Tailscale VPN integration using
 
 ## Project Structure
 ```
-your-project/
+ts-jellyfin/
 ├── docker-compose.yml
 ├── tailscale/
 │   ├── tailscale-data/  # Persistent Tailscale state
 │   └── config/         # Tailscale configuration files
-└── {{service}}/
-    └── config/         # {{service}} configuration files
+└── jellyfin/
+    └── config/         # Jellyfin configuration files
+    └── cache/         # Jellyfin cache files
+    └── media/         # Jellyfin media files
 ```
 
 ## Setup Instructions
 
 1. **Clone the Repository**
    ```bash
-   git clone <repository-url>
-   cd <repository-name>
+   git clone https://gitea.damconsulting.llc/DAM/ts-jellyfin/
+   cd ts-jellyfin
    ```
 2. Create Required Directories
     ```bash
-    mkdir -p tailscale/tailscale-data
+    mkdir -p tailscale/tailscale-data jellyfin/config jellyfin/cache jellyfin/media
     ```
 3. Configure Tailscale
     - Replace `{{YOUR_TAILSCALE_AUTHKEY}}` in the docker-compose.yml with your actual Tailscale auth key
     - Optionally, update the file in `tailscale/config/serve.json` if you need specific Tailscale serve configurations
         - CAUTION: Changing `"${TS_CERT_DOMAIN}:443": false` to `true` will expose the service to the internet
 
-4. Configure {{service}}
-    - See {{service_docs}} for configuration options
-
-5. Start the Services
+4. Start the Services
     ```bash
     docker-compose up -d
     ```
 
-6. Wait for Certificate to propagate [~2m] 
+5. Wait for Certificate to propagate [~2m] 
 
-7. Login with default credentials `usr:admin` `pwd:admin`
+6. Login with and create admin account
 
 ## Services
 
-### {{service}}-ts (Tailscale)
+### jellyfin-ts (Tailscale)
 
 - Runs Tailscale VPN client
 - Image: tailscale/tailscale:latest
-- Container name: {{service}}-ts
-- Hostname: {{service}}
+- Container name: jellyfin-ts
+- Hostname: jellyfin
 - Requires NET_ADMIN and SYS_MODULE capabilities
 - Persists state in ./tailscale/tailscale-data
 - Uses configuration from ./tailscale/config
 
-### {{service}}
+### jellyfin
 
-- Depends on {{service}}-ts service
+- Depends on jellyfin-ts service
 
 ## Usage
 
-- After starting the services your service should be available via tailnet at `https://{{service}}.{{YOUR_TAILNET_DOMAIN}}.ts.net` ie `https://{{service}}.tail12345.ts.net/`
+- After starting the services your service should be available via tailnet at `https://jellyfin.{{YOUR_TAILNET_DOMAIN}}.ts.net` ie `https://jellyfin.tail12345.ts.net/`
 - To manually get the Tailscale IP/hostname of your container:
     ```bash
-    docker logs {{service}}-ts
+    docker logs jellyfin-ts
     ```
     Look for the Tailscale IP address in the logs.
 
@@ -91,18 +90,18 @@ your-project/
 ## Troubleshooting
 - Check container logs:
     ```bash
-    docker logs {{service}}-ts
-    docker logs {{service}}
+    docker logs jellyfin-ts
+    docker logs jellyfin
     ```
 - Ensure your Tailscale auth key is valid and not expired
 - Verify the configuration files have proper permissions
 - Make sure required directories exist before starting
 ## Notes
-- The {{service}} service uses the Tailscale service's network stack via network_mode: service:{{service}}-ts
+- The Jellyfin service uses the Tailscale service's network stack via network_mode: service:Jellyfin-ts
 - Direct port mapping is disabled by default as Tailscale handles the networking
 - Services restart automatically unless explicitly stopped
 - For more information:
 - Tailscale documentation: https://tailscale.com/kb/
-- {{service}} documentation: {{service_docs}}
-- {{service}} repository: {{service_repo}}
-- {{service}} linuxserve.io: {{service_lcsr}}
+- Jellyfin documentation: https://jellyfin.org/docs/
+- Jellyfin repository: https://github.com/jellyfin/jellyfin
+- Jellyfin linuxserve.io: https://github.com/linuxserver/docker-jellyfin