mirror of
https://github.com/0x1d/rcond.git
synced 2025-12-14 18:25:21 +01:00
docs: update readme
This commit is contained in:
14
README.md
14
README.md
@@ -2,10 +2,10 @@
|
|||||||
|
|
||||||
[](https://github.com/0x1d/rcond/actions/workflows/main.yaml)
|
[](https://github.com/0x1d/rcond/actions/workflows/main.yaml)
|
||||||
|
|
||||||
A simple daemon and REST API designed to simplify the management of various system components, including:
|
A distributed management daemon designed to remotely configure system components, including:
|
||||||
- Network connections: Utilizing NetworkManager's D-Bus interface to dynamically configure network connections
|
- Network connections: Manage network connections through NetworkManager's D-Bus interface
|
||||||
- System hostname: Dynamically update the system's hostname
|
- System hostname: 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
|
- Authorized SSH keys: Manage the user's authorized_keys file to add, remove, or modify authorized SSH keys
|
||||||
- System state: Restart and shutdown the system
|
- System state: Restart and shutdown the system
|
||||||
- Cluster: Join and manage a cluster of rcond nodes
|
- Cluster: Join and manage a cluster of rcond nodes
|
||||||
|
|
||||||
@@ -19,7 +19,7 @@ A simple daemon and REST API designed to simplify the management of various syst
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
In order to install `rcond` as a systemd service, you need to specify the target architecture and then run the install make target.
|
In order to build and install `rcond` as a systemd service, you need to specify the target architecture and then run the install make target.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
export ARCH=arm64
|
export ARCH=arm64
|
||||||
@@ -36,9 +36,7 @@ make run
|
|||||||
|
|
||||||
## Develop
|
## Develop
|
||||||
|
|
||||||
The dev target will run the main.go directly with environment variable configuration:
|
The dev target will run the main.go using the default configuration in `config/rcond.yaml`
|
||||||
- RCOND_ADDR = 127.0.0.1:8080
|
|
||||||
- RCOND_API_TOKEN = 1234567890
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
make dev
|
make dev
|
||||||
|
|||||||
Reference in New Issue
Block a user