Skip to content

Commit 337d954

Browse files
committed
docs: mention that user creation is part of setup in readme
1 parent bcaf732 commit 337d954

File tree

1 file changed

+8
-15
lines changed

1 file changed

+8
-15
lines changed

README.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88

99
Keep track of your internet connection with a daemon
1010

11-
* [GitHub](https://github.com/PlexSheep/netpulse)
12-
* [crates.io](https://crates.io/crates/netpulse)
13-
* [docs.rs](https://docs.rs/crate/netpulse/)
11+
- [GitHub](https://github.com/PlexSheep/netpulse)
12+
- [crates.io](https://crates.io/crates/netpulse)
13+
- [docs.rs](https://docs.rs/crate/netpulse/)
1414

1515
## Why?
1616

@@ -42,14 +42,7 @@ your system shuts down. Root privileges are required for starting and setup,
4242
but privileges will be dropped to the user `netpulse` with the group
4343
`netpulse`.
4444

45-
Therefore, you need to create a user `netpulse` on your system to use the
46-
daemon:
47-
48-
```bash
49-
useradd -r -s /usr/sbin/nologin netpulse
50-
```
51-
52-
To set everything up, including a systemd unit file and copying the `netpulsed`
45+
To set everything up, including a systemd unit file, a user, and copying the `netpulsed`
5346
executable to `/usr/local/bin/`, do the following:
5447

5548
```bash
@@ -71,10 +64,10 @@ and analyze the store.
7164

7265
`netpulsed` will try to create a few directories / files:
7366

74-
* `/run/netpulse/netpulse.pid` – lockfile with the PID of the daemon to make sure it doesn't run multiple times
75-
* `/var/lib/netpulse/netpuse.store` – the database where your checks are stored
76-
* `/var/log/netpulse.log` – contains the stdout of the daemon
77-
* `/var/log/netpulse.err` – contains the stderr of the daemon
67+
- `/run/netpulse/netpulse.pid` – lockfile with the PID of the daemon to make sure it doesn't run multiple times
68+
- `/var/lib/netpulse/netpuse.store` – the database where your checks are stored
69+
- `/var/log/netpulse.log` – contains the stdout of the daemon
70+
- `/var/log/netpulse.err` – contains the stderr of the daemon
7871

7972
### Targets
8073

0 commit comments

Comments
 (0)