-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOC] Enhance documentation in readme
- Loading branch information
1 parent
ca474da
commit b23c81d
Showing
2 changed files
with
22 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
# A comma separated list of actions to allow, default: .deploy | ||
ACINT_ACTIONS= | ||
ACINT_ALLOWED_ACTIONS= | ||
|
||
# The proxy path for the service, default: /acint | ||
ACINT_PROXY_PATH= |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,23 @@ | ||
# Action Interface (actint) | ||
|
||
The Action Interface (actint) is a simple service that touches a file for the called action. For example if the action `deploy` is called | ||
The Action Interface (actint) is a simple service that touches a file for the called action. | ||
For example if the action `.deploy` is called it touches a file into the `/do` folder inside | ||
the docker container. | ||
|
||
## Environment | ||
|
||
### `ACINT_ALLOWED_ACTIONS` | ||
|
||
A comma separated list of actions to allow, default: .deploy | ||
|
||
```bash | ||
ACINT_ALLOWED_ACTIONS=.deploy | ||
``` | ||
|
||
### `ACINT_PROXY_PATH` | ||
|
||
The proxy path for the service, default: /acint | ||
|
||
```bash | ||
ACINT_PROXY_PATH=/acint | ||
``` |