Skip to content

Commit

Permalink
updates README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shubhang93 committed May 7, 2024
1 parent 58b2643 commit ec395bd
Showing 1 changed file with 17 additions and 9 deletions.
26 changes: 17 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
# tplagent

<!-- TOC -->

* [tplagent](#tplagent)
* [Generate and refresh config/any type of files dynamically using Go templates](#generate-and-refresh-configany-type-of-files-dynamically-using-go-templates)
* [Installation instructions](#installation-instructions)
* [Supported Platforms](#supported-platforms)
* [Directory Permissions](#directory-permissions)
* [Configuration explained](#configuration-explained)
* [Actions](#actions)
* [How to invoke a certain action](#how-to-invoke-a-certain-action)
* [Contributing new actions](#contributing-new-actions)
* [On How to use Go templates properly please refer to](#on-how-to-use-go-templates-properly-please-refer-to)
* [Generate and refresh config/any type of files dynamically using Go templates](#generate-and-refresh-configany-type-of-files-dynamically-using-go-templates)
* [Installation instructions](#installation-instructions)
* [Supported Platforms](#supported-platforms)
* [Directory Permissions](#directory-permissions)
* [Configuration explained](#configuration-explained)
* [Actions](#actions)
* [How to invoke a certain action](#how-to-invoke-a-certain-action)
* [Contributing new actions](#contributing-new-actions)
* [On How to use Go templates properly please refer to](#on-how-to-use-go-templates-properly-please-refer-to)

<!-- TOC -->

## Generate and refresh config/any type of files dynamically using Go templates
Expand Down Expand Up @@ -45,6 +47,12 @@ It is recommended that the `tplagent` process is started under a dedicated user
are files created by `tplagent` use the `766` permissions. It is also recommended to manage directory permissions as
part of setting up the agent to avoid permission errors.

## Reloading the agent

Agent can be reloaded by sending a SIGHUP signal to the agent process, if the agent process starts up successfully the
PID is stored inside
`/tmp/tplagent/agent.pid`. Agent reloading can be useful to read new config

## Configuration explained

```json5
Expand Down

0 comments on commit ec395bd

Please sign in to comment.