Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation to start on boot as a user on desktop Linux #432

Open
wants to merge 2 commits into
base: gh-pages
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions serialosc/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,28 @@ If there are no precompiled packages available for your distribution, you can st

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

### Running at Boot

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`

```
[Unit]
Description=Starts serialoscd at system boot

[Service]
Type=simple
ExecStart=/usr/local/bin/serialoscd

```

Reload systemd with `sudo systemctl daemon-reload`

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.

To manually start and stop, this works like any other systemd unit, for example to start manually `systemctl --user start serialoscd.service` will do.

This is not needed if you install the binary package.

## Notes

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.
Expand Down