manual init

README.md

@@ -1,6 +1,8 @@
-# {{service}} with Tailscale Integration
+# Baby Buddy 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.
+![Baby Buddy with Tailscale](https://github.com/babybuddy/babybuddy/blob/master/babybuddy/static_src/logo/icon-brand.png?raw=true "babybuddy")
+
+This project sets up a Baby Buddy instance with Tailscale VPN integration using Docker Compose. It creates a secure, private network connection for your Baby Buddy instance using Tailscale.
 
 ## Prerequisites
 
@@ -15,8 +17,8 @@ your-project/
 ├── tailscale/
 │   ├── tailscale-data/  # Persistent Tailscale state
 │   └── config/         # Tailscale configuration files
-└── {{service}}/
+└── babybuddy/
-    └── config/         # {{service}} configuration files
+    └── config/         # Baby Buddy configuration files
 ```
 
 ## Setup Instructions
@@ -34,7 +36,7 @@ your-project/
     - 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
 
-4. Configure {{service}}
+4. Configure Baby Buddy
     - See {{service_docs}} for configuration options
 
 5. Start the Services
@@ -44,39 +46,37 @@ your-project/
 
 ## Services
 
-### {{service}}-ts (Tailscale)
+### babybuddy-ts (Tailscale)
 
 - Runs Tailscale VPN client
 - Image: tailscale/tailscale:latest
-- Container name: {{service}}-ts
+- Container name: babybuddy-ts
-- Hostname: {{service}}
+- Hostname: babybuddy
 - Requires NET_ADMIN and SYS_MODULE capabilities
 - Persists state in ./tailscale/tailscale-data
 - Uses configuration from ./tailscale/config
 
-### {{service}}
+### babybuddy
 
-- Depends on {{service}}-ts service
+- Runs Baby Buddy Django Server
+- Depends on babybuddy-ts service
+- Container name: babybuddy
 
 ## 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://babybuddy.{{YOUR_TAILNET_DOMAIN}}.ts.net` ie `https://babybuddy.tail12345.ts.net/`
 - To manually get the Tailscale IP/hostname of your container:
     ```bash
-    docker logs {{service}}-ts
+    docker logs babybuddy-ts
     ```
     Look for the Tailscale IP address in the logs.
 
 ## Optional Features
 
-- Uncomment the Docker socket volume mapping in the service to enable Docker integrations:
-    ```yaml
-    - /var/run/docker.sock:/var/run/docker.sock
-    ```
 - Uncomment and adjust the ports mapping if you need direct access (without Tailscale):
     ```yaml
     ports:
-    - 3000:3000
+    - 8000:8000
     ```
 - Stopping the Services
     ```bash
@@ -86,16 +86,18 @@ your-project/
 ## Troubleshooting
 - Check container logs:
     ```bash
-    docker logs {{service}}-ts
+    docker logs babybuddy-ts
-    docker logs {{service}}
+    docker logs babybuddy
     ```
 - 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 Baby Buddy service uses the Tailscale service's network stack via network_mode: service:babybuddy-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}}
+- Baby Buddy documentation: https://docs.baby-buddy.net/
+- Baby Buddy repo: https://github.com/babybuddy/babybuddy
+- Baby Buddy linuxserve.io repo: https://github.com/linuxserver/docker-babybuddy