nexus-sync

a utility that allows you to manage your computers.

Main Idea server can send to every client "what to do". Centralized control for all clients.

Development

pip install -e .[dev]

Client config

The client reads YAML config files. The server still use .env for server-side settings such as NEXUS_SYNC_CLIENT_TOKENS.

Client config is searched in this order:

$(pwd)/nexus.yml
$(pwd)/nexus.yaml
$XDG_CONFIG_HOME/nexus.yml
$XDG_CONFIG_HOME/nexus.yaml
~/.config/nexus.yml
~/.config/nexus.yaml
~/.config/nexus/config.yml
~/.config/nexus/config.yaml

Example:

server_url: "http://127.0.0.1:5852"
client_id: "linux-client"
client_token: "change-me-client-token"
allowed_commands:
  - name: hostname
    description: "Get the hostname of the client machine"
    cmd: "hostname"
  - name: network_interfaces
    description: "Get network interface information"
    cmd: "ip addr show"
logging_level: "INFO"

Template examples are available in template/ for Linux, Windows, and Darwin. The client reports only command name and description to the server; cmd stays local to the client config.

Current design

API contract: docs/api.md
Client behavior notes: docs/client.md
Server behavior notes: docs/server.md

To build

make [client|server]

To test

pytest

1.4 KiB Raw Blame History