Fix inline comments in dropshell handling
All checks were successful
Build-Test-Publish / build (linux/amd64) (push) Successful in 35s
Build-Test-Publish / build (linux/arm64) (push) Successful in 59s

This commit is contained in:
Your Name
2025-09-20 10:14:28 +12:00
parent 0916953018
commit c8493b92a0
2 changed files with 31 additions and 4 deletions

View File

@@ -122,17 +122,21 @@ CONFIG_VOLUME="${CONTAINER_NAME}_config"
Default service configuration that **will be modified per installation**. When a user creates a service from this template, they edit this file to customize the deployment:
```bash
# Service-specific settings
# Service identification (REQUIRED)
CONTAINER_NAME=service-name
IMAGE_TAG="latest"
# Server settings
SSH_USER="root"
# Server settings (REQUIRED by dropshell)
SSH_USER="root" # CRITICAL: This must always be defined!
# Docker settings (optional)
IMAGE_TAG="latest"
# Service-specific variables
# (Add any configuration specific to your service)
```
**CRITICAL REQUIREMENT**: The `SSH_USER` variable MUST be defined in every service.env file. Dropshell uses this internally for server management. Without it, the template will fail with "SSH_USER variable not defined" error.
**Important**: This is the file users edit to customize each service instance. Different deployments of the same template will have different `service.env` files.
### How Environment Variables Work
@@ -332,6 +336,7 @@ Templates must pass these validation checks:
2. **Scripts are executable**: All `.sh` files must have execute permissions
3. **TEMPLATE variable matches**: The `TEMPLATE` variable in `.template_info.env` must match the directory name
4. **Valid environment files**: Both `.env` files must be parseable
5. **SSH_USER defined**: The `SSH_USER` variable MUST be present in `service.env`
## Best Practices
@@ -377,6 +382,7 @@ CONTENT_VOLUME="${CONTAINER_NAME}_content"
`service.env`:
```bash
CONTAINER_NAME=nginx-server
SSH_USER="root"
IMAGE_TAG="alpine"
HTTP_PORT=8080
```
@@ -434,6 +440,7 @@ CONFIG_VOLUME="${CONTAINER_NAME}_config"
`service.env`:
```bash
CONTAINER_NAME=postgres-db
SSH_USER="root"
IMAGE_TAG="15-alpine"
DB_PORT=5432
POSTGRES_PASSWORD="changeme"