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
|
||||
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 /var/rcond
|
||||
sudo cp config/rcond.yaml /etc/rcond/config.yaml
|
||||
@@ -29,7 +29,7 @@ uninstall:
|
||||
sudo rm -rf /usr/local/bin/rcond
|
||||
sudo rm -rf /etc/systemd/system/rcond.service
|
||||
|
||||
run:
|
||||
run: build
|
||||
bin/rcond-${ARCH} -config config/rcond.yaml
|
||||
|
||||
dev:
|
||||
|
||||
22
README.md
22
README.md
@@ -1,9 +1,9 @@
|
||||
# rcond
|
||||
|
||||
A simple daemon and REST API to manage:
|
||||
- network connections through NetworkManager's D-Bus interface
|
||||
- system hostname through the hostname1 service
|
||||
- authorized SSH keys through the user's authorized_keys file
|
||||
A simple daemon and REST API designed to simplify the management of various system components, including:
|
||||
- Network connections: Utilizing NetworkManager's D-Bus interface to dynamically configure and monitor network connections
|
||||
- System hostname: Interacting with the hostname1 service to dynamically update the system's hostname
|
||||
- Authorized SSH keys: Directly managing the user's authorized_keys file to securely add, remove, or modify authorized SSH keys
|
||||
|
||||
## Requirements
|
||||
|
||||
@@ -15,23 +15,27 @@ A simple daemon and REST API to manage:
|
||||
|
||||
## 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
|
||||
export ARCH=arm64
|
||||
make build
|
||||
make install
|
||||
```
|
||||
|
||||
## Build and Run
|
||||
## Run
|
||||
|
||||
```bash
|
||||
make build
|
||||
The run target will build the binary for target architecture and runs it using the default configuration in `config/rcond.yaml`
|
||||
|
||||
```sh
|
||||
make run
|
||||
```
|
||||
|
||||
## 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
|
||||
make dev
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user