Tidying
This commit is contained in:
33
templates/example-nginx/README.txt
Normal file
33
templates/example-nginx/README.txt
Normal file
@ -0,0 +1,33 @@
|
||||
DropShell Template Example - Nginx simple webserver
|
||||
|
||||
A simple service example, creating a single docker container running nginx, with contant on the host
|
||||
in the configurable LOCAL_DATA_FOLDER directory.
|
||||
|
||||
Shell scripts defined in this folder are run as DropShell commands on the remote server (not locally!).
|
||||
|
||||
When they are run, the following environment variables will be set:
|
||||
- SERVER (server name), SERVICE (service name) and CONFIG_PATH (path to the user's service configuration folder)
|
||||
- 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).
|
||||
|
||||
Mandatory scripts are:
|
||||
- install.sh
|
||||
- uninstall.sh
|
||||
|
||||
Optional standard scripts are:
|
||||
- start.sh
|
||||
- stop.sh
|
||||
- backup.sh
|
||||
- restore.sh
|
||||
- status.sh
|
||||
- ports.sh
|
||||
- logs.sh
|
||||
|
||||
|
||||
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).
|
Reference in New Issue
Block a user