manual init

README.md

@@ -1,8 +1,8 @@
-# {{Service}} with Tailscale Integration
+# MkDocs with Tailscale Integration
 
-![{{Service}} with Tailscale](https://damconsulting.llc/images/logo_yellow.svg "{{Service}}")
+![MkDocs with Tailscale](https://damconsulting.llc/images/logo_yellow.svg "MkDocs")
 
-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 MkDocs instance with Tailscale VPN integration using Docker Compose. It creates a secure, private network connection for your MkDocs instance using Tailscale.
 
 ## Prerequisites
 
@@ -12,21 +12,22 @@ This project sets up a {{Service}} instance with Tailscale VPN integration using
 
 ## Project Structure
 ```
-ts-{{service}}/
+ts-mkdocs/
 ├── docker-compose.yml
 ├── tailscale/
 │   ├── tailscale-data/     # Persistent Tailscale state
 │   └── config/             # Tailscale configuration files
-└── {{service}}/
-    └── config/             # {{Service}} configuration files
+└── mkdocs/
+    ├── docs/               # MkDocs content files
+    └── mkdocs.yml          # MkDocs config file
 ```
 
 ## 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-mkdocs
+   cd ts-mkdocs
    ```
 2. Create Required Directories
     ```bash
@@ -37,8 +38,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 MkDocs
+    - A basic configuration has been provided.
+    - See the [documentation](https://www.mkdocs.org/getting-started/#creating-a-new-project) for learning how to add content
 
 5. Start the Services
     ```bash
@@ -48,30 +50,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://mkdocs.{{YOUR_TAILNET_DOMAIN}}.ts.net ie https://mkdocs.tail12345.ts.net/
 
 ## Services
 
-### {{service}}-ts (Tailscale)
+### mkdocs-ts (Tailscale)
 
 - Runs Tailscale VPN client
 - Image: tailscale/tailscale:latest
-- Container name: {{service}}-ts
-- Hostname: {{service}}
+- Container name: mkdocs-ts
+- Hostname: mkdocs
 - Requires NET_ADMIN and SYS_MODULE capabilities
 - Persists state in ./tailscale/tailscale-data
 - Uses configuration from ./tailscale/config
 
-### {{service}}
+### mkdocs
 
-- Depends on {{service}}-ts service
+- Depends on mkdocs-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://mkdocs.{{YOUR_TAILNET_DOMAIN}}.ts.net` ie `https://mkdocs.tail12345.ts.net/`
 - To manually get the Tailscale IP/hostname of your container:
     ```bash
-    docker logs {{service}}-ts
+    docker logs mkdocs-ts
     ```
     Look for the Tailscale IP address in the logs.
 
@@ -90,19 +92,18 @@ ts-{{service}}/
 ## Troubleshooting
 - Check container logs:
     ```bash
-    docker logs {{service}}-ts
-    docker logs {{service}}
+    docker logs mkdocs-ts
+    docker logs mkdocs
     ```
 - 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 MkDocs service uses the Tailscale service's network stack via `network_mode: service:mkdocs-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}})
+    - Tailscale [documentation](https://tailscale.com/kb/)
+    - MkDocs [documentation](https://www.mkdocs.org/getting-started/#creating-a-new-project)
+    - MkDocs [repository](https://github.com/mkdocs/mkdocs)