Skip to content

Commit 8ae2fd1

Browse files
authored
Documentation to start on boot as a user on desktop Linux (#432)
* systemd unit info * avaiability details
1 parent f8fd72e commit 8ae2fd1

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

serialosc/linux.md

+22
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,28 @@ If there are no precompiled packages available for your distribution, you can st
2525

2626
- [compiling from source](/docs/serialosc/source)
2727

28+
### Running at Boot
29+
30+
If you are compiling from source and would like the service to start automatically, add the following systemd unit to `.config/systemd/user/serialoscd.service`
31+
32+
```
33+
[Unit]
34+
Description=Starts serialoscd at system boot
35+
36+
[Service]
37+
Type=simple
38+
ExecStart=/usr/local/bin/serialoscd
39+
40+
```
41+
42+
Reload systemd with `sudo systemctl daemon-reload`
43+
44+
Install to a different path? Change the above to match your preference. You can enable serialoscd to start at boot by running `systemctl --user enable serialoscd.service` which will start the daemon at each login.
45+
46+
To manually start and stop, this works like any other systemd unit, for example to start manually `systemctl --user start serialoscd.service` will do.
47+
48+
This is not needed if you install the binary package.
49+
2850
## Notes
2951

3052
You'll need to have the `usbserial` and `ftdi_sio` kernel modules loaded before connecting your grid. Most Linux distributions include these modules by default, and should load them as soon as they detect your grid being plugged in. If these USB and serial modules are not available in your kernel, follow your distribution's documentation for configuring, compiling, and installing a custom kernel.

0 commit comments

Comments
 (0)