Skip to content

Commit 02d61e5

Browse files
committed
update README
1 parent 5143552 commit 02d61e5

File tree

1 file changed

+28
-5
lines changed

1 file changed

+28
-5
lines changed

README.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,24 @@
22
Simple HTTP server that executes configured commands remotely.
33

44

5-
### Example Usage
5+
### Installation
66

7+
Grab the latest binary and put it in somewhere in your path. Check the [releases](https://github.com/binarymason/bashRPC/releases) page. Alternatively, you can download a package.
78

8-
1) create a config file
9+
Example for Debian systems:
10+
```bash
11+
# Note: this link may be out of date. Be sure to check releases page to get latest version
12+
wget https://github.com/binarymason/bashRPC/releases/download/v19.07.16-1002/bashrpc-v19.07.16-1002.deb
13+
sudo apt install bashrpc-v19.07.16-1002.deb
914

1015
```
16+
17+
### Example Usage
18+
19+
20+
1) Create a config file. If you are using bashRPC as a system service, the config is located at `/etc/bashrpc/bashrpc.yml`
21+
22+
```yml
1123
---
1224

1325
port: 8675
@@ -29,17 +41,28 @@ routes:
2941
git pull
3042
./script/start-app
3143
32-
3344
```
3445
3546
3647
2) start server
48+
49+
```bash
50+
bashrpc -c /path/to/config
3751
```
38-
remote -c /path/to/config
52+
53+
If you installed bashRPC with your package manager, you can alternatively start bashRPC as a system service:
54+
55+
Example for systemd:
56+
```bash
57+
sudo systemctl daemon-reload
58+
sudo systemctl enable bashrpc
59+
sudo systemctl start bashrpc
60+
3961
```
4062

4163
3) ping server
42-
```
64+
65+
```bash
4366
curl -H "Authorization: supersecret" localhost:8675/uptime
4467
```
4568

0 commit comments

Comments
 (0)