mirror of
https://github.com/0x1d/rcond.git
synced 2025-12-14 18:25:21 +01:00
docs: improve readme
This commit is contained in:
4
Makefile
4
Makefile
@@ -10,7 +10,7 @@ build:
|
|||||||
mkdir -p bin
|
mkdir -p bin
|
||||||
env GOOS=linux GOARCH=${ARCH} go build -o bin/rcond-${ARCH} ./cmd/rcond/main.go
|
env GOOS=linux GOARCH=${ARCH} go build -o bin/rcond-${ARCH} ./cmd/rcond/main.go
|
||||||
|
|
||||||
install:
|
install: build
|
||||||
sudo mkdir -p /etc/rcond
|
sudo mkdir -p /etc/rcond
|
||||||
sudo mkdir -p /var/rcond
|
sudo mkdir -p /var/rcond
|
||||||
sudo cp config/rcond.yaml /etc/rcond/config.yaml
|
sudo cp config/rcond.yaml /etc/rcond/config.yaml
|
||||||
@@ -29,7 +29,7 @@ uninstall:
|
|||||||
sudo rm -rf /usr/local/bin/rcond
|
sudo rm -rf /usr/local/bin/rcond
|
||||||
sudo rm -rf /etc/systemd/system/rcond.service
|
sudo rm -rf /etc/systemd/system/rcond.service
|
||||||
|
|
||||||
run:
|
run: build
|
||||||
bin/rcond-${ARCH} -config config/rcond.yaml
|
bin/rcond-${ARCH} -config config/rcond.yaml
|
||||||
|
|
||||||
dev:
|
dev:
|
||||||
|
|||||||
22
README.md
22
README.md
@@ -1,9 +1,9 @@
|
|||||||
# rcond
|
# rcond
|
||||||
|
|
||||||
A simple daemon and REST API to manage:
|
A simple daemon and REST API designed to simplify the management of various system components, including:
|
||||||
- network connections through NetworkManager's D-Bus interface
|
- Network connections: Utilizing NetworkManager's D-Bus interface to dynamically configure and monitor network connections
|
||||||
- system hostname through the hostname1 service
|
- System hostname: Interacting with the hostname1 service to dynamically update the system's hostname
|
||||||
- authorized SSH keys through the user's authorized_keys file
|
- Authorized SSH keys: Directly managing the user's authorized_keys file to securely add, remove, or modify authorized SSH keys
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
@@ -15,23 +15,27 @@ A simple daemon and REST API to manage:
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
In order to install `rcond`as a systemd service, you need to specify the target architecture and then run the build and install make targets.
|
In order to install `rcond` as a systemd service, you need to specify the target architecture and then run the build and install make targets.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
export ARCH=arm64
|
export ARCH=arm64
|
||||||
make build
|
|
||||||
make install
|
make install
|
||||||
```
|
```
|
||||||
|
|
||||||
## Build and Run
|
## Run
|
||||||
|
|
||||||
```bash
|
The run target will build the binary for target architecture and runs it using the default configuration in `config/rcond.yaml`
|
||||||
make build
|
|
||||||
|
```sh
|
||||||
make run
|
make run
|
||||||
```
|
```
|
||||||
|
|
||||||
## Develop
|
## Develop
|
||||||
|
|
||||||
|
The dev target will run the main.go directly with environment variable configuration:
|
||||||
|
- RCOND_ADDR = 127.0.0.1:8080
|
||||||
|
- RCOND_API_TOKEN = 1234567890
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
make dev
|
make dev
|
||||||
```
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user