fixed bugs + rewritten docs + made zinit proxy available through zinit proxy -a <ADDR> command

Author: maximevanhees

Cargo.toml

@@ -44,10 +44,10 @@ path = "src/lib.rs"
 [[bin]]
 name = "zinit"
 path = "src/main.rs"
-[[bin]]
-name = "testapp"
-path = "src/bin/testapp.rs"
-[[bin]]
-name = "zinit-http"
-path = "src/bin/zinit-http.rs"
+# [[bin]]
+# name = "testapp"
+# path = "src/bin/testapp.rs"
+# [[bin]]
+# name = "zinit-http"
+# path = "src/bin/zinit-http.rs"
 

README.md

@@ -1,15 +1,18 @@
-# Zinit - A Process Manager
+# Zinit [![Rust](https://github.com/threefoldtech/zinit/actions/workflows/rust.yml/badge.svg)](https://github.com/threefoldtech/zinit/actions/workflows/rust.yml)
 
-Zinit is a process manager designed to manage services and their lifecycle. It provides both a Unix socket interface and an HTTP API for interacting with the process manager.
+Zinit is a lightweight PID 1 replacement inspired by runit, written in Rust using Tokio for async I/O. It provides both a Unix socket interface and an HTTP API for interacting with the process manager.
 
-## Components
+### Key Features
 
-Zinit now consists of two separate binaries:
+- **Service Management**: Ensures configured services are up and running at all times
+- **Dependency Handling**: Supports service dependencies for proper startup ordering
+- **Simple Control Interface**: Provides an intuitive CLI to add, start, stop, and monitor services
+- **Container Support**: Can run in container mode with appropriate signal handling
+- **Configurable Logging**: Multiple logging options including ringbuffer and stdout
 
-1. **zinit** - The core process manager that handles service lifecycle management
-2. **zinit-http** - An HTTP proxy that forwards JSON-RPC requests to the Zinit Unix socket
+## Installation
 
-This separation allows for more flexibility and reduced resource usage when the HTTP API is not needed.
+Click [here](docs/installation.md) for more information on how to install Zinit.
 
 ## Usage
 
@@ -29,100 +32,38 @@ zinit start <service-name>
 zinit stop <service-name>
 ```
 
-### HTTP Proxy (zinit-http)
-
 ```bash
 # Start the HTTP proxy on the default port (8080)
-zinit-http --socket /var/run/zinit.sock
-
-# Start the HTTP proxy on a custom port
-zinit-http --socket /var/run/zinit.sock --port 3000
+zinit proxy
 ```
 
-## JSON-RPC API
-
-The HTTP proxy provides a JSON-RPC 2.0 API for interacting with Zinit. You can send JSON-RPC requests to the HTTP endpoint:
-
-```bash
-curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","id":1,"method":"service.list","params":{}}' http://localhost:8080/
-```
+More information about all the available commands can be found [here](docs/cmd.md).
 
-## Building from Source
+### Service Configuration
 
-```bash
-# Build both binaries
-cargo build --release
+Zinit uses YAML files for service configuration. Here's a basic example:
 
-# The binaries will be available in target/release/
+```yaml
+# Service configuration (e.g., /etc/zinit/myservice.yaml)
+exec: "/usr/bin/myservice --option value"   # Command to run (required)
+test: "/usr/bin/check-myservice"            # Health check command (optional)
+oneshot: false                              # Whether to restart on exit (default: false)
+after:                                      # Services that must be running first (optional)
+  - dependency1
+  - dependency2
 ```
 
-# Zinit [![Rust](https://github.com/threefoldtech/zinit/actions/workflows/rust.yml/badge.svg)](https://github.com/threefoldtech/zinit/actions/workflows/rust.yml)
-
-A lightweight PID 1 replacement inspired by runit, written in Rust using Tokio for async I/O.
-
-## Overview
-
-Zinit is a service manager designed to be simple, lightweight, and reliable for both system services and container environments. It acts as an init system (PID 1) but focuses only on essential service management functionality.
-
-### Key Features
-
-- **Service Management**: Ensures configured services are up and running at all times
-- **Dependency Handling**: Supports service dependencies for proper startup ordering
-- **Simple Control Interface**: Provides an intuitive CLI to add, start, stop, and monitor services
-- **Container Support**: Can run in container mode with appropriate signal handling
-- **Configurable Logging**: Multiple logging options including ringbuffer and stdout
-
-## Documentation
-
-Comprehensive documentation is available in the [docs](docs) directory:
-
-- [Command Line Interface](docs/README.md)
-- [Implementation Details](docs/implementation.md)
-- [API Protocol](docs/protocol.md)
-
-## Quick Start
-
-### Installation
-
-```bash
-# Build from source
-make
-
-# Install the binary
-sudo cp target/x86_64-unknown-linux-musl/release/zinit /usr/local/bin/
-```
+For more information on how to configure service files, see the [service file reference](docs/services.md) documentation.
 
-### Testing with Docker
+### JSON-RPC API
 
-To quickly try zinit in a container environment:
+The HTTP proxy provides a JSON-RPC 2.0 API for interacting with Zinit. You can send JSON-RPC requests to the HTTP endpoint you provided to the proxy:
 
 ```bash
-# Build the test docker image
-make docker
-
-# Run the container
-docker run -dt --device=/dev/kmsg:/dev/kmsg:rw zinit
+curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","id":1,"method":"service_list","params":{}}' http://localhost:8080/
 ```
 
-The test image automatically starts Redis and OpenSSH services.
-
-## Building from Source
-
-### Requirements
-
-- Rust (cargo) - version 1.46.0 or later
-- musl and musl-tools packages
-- GNU Make
-
-### Build Instructions
-
-```bash
-# Standard build
-make
-
-# For development/debug
-make dev
-```
+See the [OpenRPC specs](openrpc.json) for more information about available RPC calls to interact with Zinit.
 
 ## License
 

docker/Dockerfile

@@ -2,6 +2,6 @@ FROM ubuntu:18.04
 
 RUN mkdir -p /etc/zinit
 ADD zinit /sbin/zinit
-ADD zinit-http /sbin/zinit-http
+# ADD zinit-http /sbin/zinit-http
 
 ENTRYPOINT ["/sbin/zinit", "init"]