.
This commit is contained in:
15
TEMPLATES.md
15
TEMPLATES.md
@@ -9,13 +9,13 @@ Every template must follow this directory structure:
|
||||
```
|
||||
template-name/
|
||||
├── config/
|
||||
│ ├── .template_info.env # REQUIRED: Template metadata
|
||||
│ └── service.env # REQUIRED: Default service configuration
|
||||
├── install.sh # REQUIRED: Installation script
|
||||
│ └── service.env # REQUIRED: Default service configuration
|
||||
├── template_info.env # REQUIRED: Template metadata
|
||||
├── install.sh # REQUIRED: Installation script
|
||||
├── uninstall.sh # REQUIRED: Uninstallation script
|
||||
├── status.sh # REQUIRED: Check service status (needed for 'dropshell list' command)
|
||||
├── start.sh # OPTIONAL: Start the service
|
||||
├── stop.sh # OPTIONAL: Stop the service
|
||||
├── status.sh # REQUIRED: Check service status (needed for 'dropshell list' command)
|
||||
├── logs.sh # OPTIONAL: View service logs
|
||||
├── backup.sh # OPTIONAL: Backup service data
|
||||
├── restore.sh # OPTIONAL: Restore service data
|
||||
@@ -92,20 +92,17 @@ echo "Service and all data destroyed"
|
||||
|
||||
## Essential Files
|
||||
|
||||
### 1. config/.template_info.env
|
||||
### 1. template_info.env
|
||||
|
||||
Template metadata file that defines the template and its requirements. This file is managed by the template author and should NOT be modified by users:
|
||||
|
||||
```bash
|
||||
# Template identifier - MUST match the directory name
|
||||
TEMPLATE=template-name
|
||||
|
||||
# Requirements
|
||||
REQUIRES_HOST_ROOT=false # Whether root access on host is needed
|
||||
REQUIRES_DOCKER=true # Whether Docker is required
|
||||
REQUIRES_DOCKER_ROOT=false # Whether Docker root privileges are needed
|
||||
|
||||
# Docker image settings
|
||||
# Docker image settings (if needed)
|
||||
IMAGE_REGISTRY="docker.io"
|
||||
IMAGE_REPO="vendor/image"
|
||||
IMAGE_TAG="latest"
|
||||
|
||||
Reference in New Issue
Block a user