Skip to content

Commit

Permalink
[DOC] Enhance documentation in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dameyerdave committed Sep 27, 2023
1 parent ca474da commit b23c81d
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .env.TEMPLATE
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=
22 changes: 21 additions & 1 deletion README.md
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
```

0 comments on commit b23c81d

Please sign in to comment.