From 7e2405cdc986947f4338ecc072119811895f9306 Mon Sep 17 00:00:00 2001
From: peskyadmin <peskyadmin@pm.me>
Date: Tue, 15 Apr 2025 21:05:10 -0500
Subject: [PATCH] manual init

---
 README.md | 51 ++++++++++++++++++++++++++-------------------------
 1 file changed, 26 insertions(+), 25 deletions(-)

diff --git a/README.md b/README.md
index 66e12b3..fbdbd56 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
-# {{Service}} with Tailscale Integration
+# Immich with Tailscale Integration
 
-![{{Service}} with Tailscale](https://damconsulting.llc/images/logo_yellow.svg "{{Service}}")
+![Immich with Tailscale](https://immich.app/img/immich-logo-inline-light.png "Immich")
 
-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 Immich instance with Tailscale VPN integration using Docker Compose. It creates a secure, private network connection for your Immich instance using Tailscale.
 
 ## Prerequisites
 
@@ -12,21 +12,21 @@ This project sets up a {{Service}} instance with Tailscale VPN integration using
 
 ## Project Structure
 ```
-ts-{{service}}/
+ts-immich/
 ├── docker-compose.yml
 ├── tailscale/
 │   ├── tailscale-data/     # Persistent Tailscale state
 │   └── config/             # Tailscale configuration files
-└── {{service}}/
-    └── config/             # {{service}} configuration files
+└── immich/
+    └── config/             # immich configuration files
 ```
 
 ## Setup Instructions
 
 1. **Clone the Repository**
    ```bash
-   git clone https://gitea.damconsulting.llc/DAM/ts-{{service}}
-   cd ts-{{service}}
+   git clone https://gitea.damconsulting.llc/DAM/ts-immich
+   cd ts-immich
    ```
 2. Create Required Directories
     ```bash
@@ -37,8 +37,9 @@ ts-{{service}}/
     - 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 the [documentation]({{service_docs}}) for configuration options
+4. Configure Immich
+    - A default configuration is provided in the `.env` file.
+    - See the [documentation](https://immich.app/docs/install/environment-variables) for additional configuration options
 
 5. Start the Services
     ```bash
@@ -48,30 +49,30 @@ ts-{{service}}/
 6. Wait for Certificate to propagate [~2m] 
 
 7. Login 
-    - 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://immich.{{YOUR_TAILNET_DOMAIN}}.ts.net ie https://immich.tail12345.ts.net/
 
 ## Services
 
-### {{service}}-ts (Tailscale)
+### immich-ts (Tailscale)
 
 - Runs Tailscale VPN client
 - Image: tailscale/tailscale:latest
-- Container name: {{service}}-ts
-- Hostname: {{service}}
+- Container name: immich-ts
+- Hostname: immich
 - Requires NET_ADMIN and SYS_MODULE capabilities
 - Persists state in ./tailscale/tailscale-data
 - Uses configuration from ./tailscale/config
 
-### {{service}}
+### immich
 
-- Depends on {{service}}-ts service
+- Depends on immich-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://immich.{{YOUR_TAILNET_DOMAIN}}.ts.net` ie `https://immich.tail12345.ts.net/`
 - To manually get the Tailscale IP/hostname of your container:
     ```bash
-    docker logs {{service}}-ts
+    docker logs immich-ts
     ```
     Look for the Tailscale IP address in the logs.
 
@@ -80,7 +81,7 @@ ts-{{service}}/
 - Uncomment and adjust the ports mapping if you need direct access (without Tailscale):
     ```yaml
     ports:
-    - 3000:3000
+    - 2283:2283
     ```
 - Stopping the Services
     ```bash
@@ -90,19 +91,19 @@ ts-{{service}}/
 ## Troubleshooting
 - Check container logs:
     ```bash
-    docker logs {{service}}-ts
-    docker logs {{service}}
+    docker logs immich-ts
+    docker logs immich
     ```
 - 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 Immich service uses the Tailscale service's network stack via `network_mode: service:immich-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}})
\ No newline at end of file
+    - Immich [documentation]({{service_docs}})
+    - Immich [repository]({{service_repo}})
+    - Immich [linuxserve.io]({{service_lcsr}})
\ No newline at end of file