Skip to content

Commit

Permalink
docs: use which for root in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
PlexSheep committed Jan 7, 2025
1 parent 4cf97e3 commit ceedeaa
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ This will install both the `netpulse` and `netpulsed` executables.
After installing the binaries, you'll need to set up the daemon environment:

```bash
sudo netpulsed --setup
sudo $(which netpulsed) --setup
```

This will:
Expand All @@ -67,6 +67,10 @@ This will:
- Install a systemd unit file
- Configure logging

Note: `cargo` usually installs the binary for your local user, not for the whole
program. If executing as root, you will need to specify the full path. That's
what the `$(which netpulsed)` is for, it just returns the absolute path.

## Usage

Netpulse has two parts:
Expand All @@ -88,7 +92,7 @@ The `netpulsed` daemon can be run either through systemd (recommended) or as a s

#### Using Systemd (Recommended)

After running the setup (`sudo netpulsed --setup`), you can manage the daemon using standard systemd commands:
After running the setup (`sudo $(which netpulsed) --setup`), you can manage the daemon using standard systemd commands:

```bash
sudo systemctl start netpulsed.service # Start the daemon
Expand Down

0 comments on commit ceedeaa

Please sign in to comment.