Merge pull request #15 from cmehay/readme

Update readme
secret
Christophe Mehay 7 years ago committed by GitHub
commit b3bb8c270f

@ -9,7 +9,7 @@ This tool avoids writing shell scripts to:
- Run commands before starting service
- Reload service when configuration has changed
[![Documentation Status](https://readthedocs.org/projects/pyentrypoint/badge/?version=latest)](http://pyentrypoint.readthedocs.io/en/latest/?badge=latest)
[![Documentation Status](https://readthedocs.org/projects/pyentrypoint/badge/?version=latest)](http://pyentrypoint.readthedocs.io/en/latest/?badge=latest) [![Build Status](https://travis-ci.org/cmehay/pyentrypoint.svg?branch=master)](https://travis-ci.org/cmehay/pyentrypoint)
## Usages
@ -135,6 +135,9 @@ pre_conf_commands:
post_conf_commands:
- echo "something else" > to_this_another_file
post_run_commands:
- echo run commands after started service
# Reload service when configuration change by sending a signal to process
reload:
signal: SIGHUP # Optional, signal to send, default is SIGHUP

@ -46,7 +46,7 @@ This is an example of ``entrypoint-config.yml`` file.
# Links are handled here
# Port, name, protocol or env variable can be used to identify the links
# Raise an error if the link could not be identified
# This not supported when using docker network or docker-compose v2.
# This is not supported when using docker network or docker-compose v2.
links:
'ssh':
port: 22
@ -70,6 +70,9 @@ This is an example of ``entrypoint-config.yml`` file.
post_conf_commands:
- echo "something else" > to_this_another_file
post_run_commands:
- echo run commands after started service
# Reload service when configuration change by sending a signal to process
reload:
signal: SIGHUP # Optional, signal to send, default is SIGHUP
@ -227,6 +230,18 @@ List of shell commands to run after applying configuration
post_conf_commands:
- echo "something else" > to_this_another_file
post_run_commands
^^^^^^^^^^^^^^^^^^
List of shell commands to run after service is started
.. code:: yaml
post_run_commands:
- sleep 5
- echo "something else" > to_this_another_file
reload
^^^^^^

Loading…
Cancel
Save