jilo-agent/README.md

50 lines
914 B
Markdown
Raw Normal View History

2024-09-01 11:34:49 +00:00
# jilo-agent
2024-09-02 20:09:42 +00:00
## overview
Jilo Agent - a remote agent for Jilo Web written in Go.
2024-09-02 20:09:42 +00:00
## license
This project is licensed under the GNU General Public License version 2 (GPL-2.0). See LICENSE file.
## installation
2024-09-02 21:07:31 +00:00
Clone the git repo. Either run the agent with Goor build it and run the executable.
Run it (mainly used for tests):
```bash
go run main.go
```
2024-09-02 20:09:42 +00:00
Build the agent:
```bash
go build -o jilo-agent main.go
```
## configuration
The config file is "jilo-agent.json", in the same folder as the "jilo-agent" binary.
If you add the SSL config options, HTTPS will be used.
2024-09-02 21:07:31 +00:00
You can run the agent without a config file - then default vales are used.
2024-09-02 20:09:42 +00:00
## usage
Run the agent
```bash
./jilo-agent
```
2024-09-02 21:07:31 +00:00
Send queries to its port (by default 8081, in order to avoid 80, 8080, 8888; configurable in jilo-agent.json):
2024-09-02 20:09:42 +00:00
```bash
2024-09-02 21:07:31 +00:00
curl -s http://localhost:8081/nginx
curl -s http://localhost:8081/jicofo
2024-09-02 20:09:42 +00:00
etc...
```