From c6b7e2bb41d00f9b71cd1f46514df2ab38db4bfe Mon Sep 17 00:00:00 2001 From: Your Name Date: Sat, 3 May 2025 20:30:06 +1200 Subject: [PATCH] Tidying --- templates/example-nginx/README.txt | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/templates/example-nginx/README.txt b/templates/example-nginx/README.txt index ff3141d..b1da890 100644 --- a/templates/example-nginx/README.txt +++ b/templates/example-nginx/README.txt @@ -10,12 +10,13 @@ When they are run, the following environment variables will be set: - everything in _default.env - everything in the server's particular service.env file (defaults in example/service.env) -The optional backup and restore scripts get a second argument, which is the backup file to create/restore -(must be a single tgz file). +The optional backup and restore scripts get two additional arguments, which are the backup file to create/restore +(must be a single tgz file), and an empty temporary directory on the server which automatically gets cleaned up. Mandatory scripts are: -- install.sh -- uninstall.sh +- install.sh (installs, or if already installed updates - non-destructive) +- uninstall.sh (preserves data) +- nuke.sh (deletes all data) Optional standard scripts are: - start.sh @@ -30,4 +31,10 @@ Optional standard scripts are: The example/ folder gets copied to the service's configuration, edited for the particular server settings, then copied onto the server. The location is server-specific, but can be accessed via CONFIG_PATH. -You can use it to store things like an nginx config file (this example does not). +You can use it to store things like an nginx config file (this simple example does not). + +The example/.template_info.env must contain the TEMPLATE= definition, which must match the template folder name +(in this case 'example-nginx'). + +You can start a new template with the command: +dropshell create-template