github.com/mysteriumnetwork/node@v0.0.0-20240516044423-365054f76801/cmd/supervisor/README.md (about)

     1  # node-supervisor
     2  
     3  Supervisor is a system background service that allows seamless installation/running of [Mysterium node](https://github.com/mysteriumnetwork/node) under elevated permissions.
     4  Clients (e.g. desktop applications) can ask the supervisor to RUN or KILL the node instance via OS dependent mechanism.
     5  
     6  Currently, only macOS and Windows are supported and it is using unix domain sockets or named pipes for communication.
     7  
     8  For usage see:
     9  
    10  ```
    11  myst_supervisor -help
    12  ```
    13  
    14  ## Elevated command support table
    15  
    16  | Command                           | OS           | Args | Output | Implemented | Notes |
    17  | --------------------------------- | ------------ | ---- | ------ | ----------- | ----- |
    18  | ping                              | macOS, Win   |      | ok     | ✅           | Ping supervisor |
    19  | kill                              | macOS, Win   |      | ok     | ✅          | Kill myst process gracefully |
    20  | bye                               | macOS   |      | ok     | ✅            | Kill supervisor |
    21  | wg-up                             | macOS, Win   | -uid, -config    | ok     | ✅           | Setup WireGuard device with given configuration in JSON string encoded as base64 |
    22  | wg-down                           | macOS, Win   | -iface     | ok     | ✅           | Destroy WireGuard device |
    23  | wg-stats                          | macOS, Win   | -iface     | `{"bytes_send": 100, "bytes_received": 200, "last_handshake": "2020-06-02T13:42:55.786Z"}`     | ✅           | Get WireGuard device peer statistics |
    24  | ta-set-port                       | macOS, Win   | port     | ok     | ✅           | Set tequilapi port for supervisor |
    25  
    26  
    27  ## Logs
    28  
    29  On Windows logs could be found at `C:\ProgramData\MystSupervisor\myst_supervisor.log`
    30  
    31  On macOS logs could be found at `/var/log/myst_supervisor.log`