forge/README.md

24 lines
706 B
Markdown

# forge
A simple remote build system. Consists of a client (`forge-client`) and server (`forge-server`).
## Server
On first run, `forge-server` will create a configuration file for you in the default location (e.g. `~/.config/forge/config.toml`).
Use this to configure options, such as the IP & port to bind on, and whether to use authentication (along with a password).
Authentication will use *Argon2id* to hash and verify passwords.
Right now it only supports building `cargo` projects.
### Build
```bash
cargo run -p forge-server
$EDITOR ~/.config/forge/config.toml
cargo run -p forge-server
```
## Client
Sends data to the server specified via commandline options.
```bash
cargo run -p forge
```