Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coreos/go-systemd
Go bindings to systemd socket activation, journal, D-Bus, and unit files
https://github.com/coreos/go-systemd
dbus go journald machined systemd
Last synced: 5 days ago
JSON representation
Go bindings to systemd socket activation, journal, D-Bus, and unit files
- Host: GitHub
- URL: https://github.com/coreos/go-systemd
- Owner: coreos
- License: apache-2.0
- Created: 2013-09-13T23:13:51.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2024-06-25T21:20:23.000Z (7 months ago)
- Last Synced: 2025-01-04T13:06:47.556Z (7 days ago)
- Topics: dbus, go, journald, machined, systemd
- Language: Go
- Homepage:
- Size: 713 KB
- Stars: 2,459
- Watchers: 51
- Forks: 309
- Open Issues: 68
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
- awesome-go-storage - go-systemd - Go bindings to systemd socket activation, journal, D-Bus, and unit files. (File System)
- go-awesome - go-systemd - bind systemd (Open source library / System Development)
- awesome-golang-repositories - go-systemd - Bus, and unit files (Repositories)
- awesome-go-storage - go-systemd - Go bindings to systemd socket activation, journal, D-Bus, and unit files. (File System)
README
# go-systemd
[](https://pkg.go.dev/mod/github.com/coreos/go-systemd/v22/?tab=packages)
Go bindings to systemd. The project has several packages:
- `activation` - for writing and using socket activation from Go
- `daemon` - for notifying systemd of service status changes
- `dbus` - for starting/stopping/inspecting running services and units
- `journal` - for writing to systemd's logging service, journald
- `sdjournal` - for reading from journald by wrapping its C API
- `login1` - for integration with the systemd logind API
- `machine1` - for registering machines/containers with systemd
- `unit` - for (de)serialization and comparison of unit files
## Socket Activation
An example HTTP server using socket activation can be quickly set up by following this README on a Linux machine running systemd:
https://github.com/coreos/go-systemd/tree/main/examples/activation/httpserver
## systemd Service Notification
The `daemon` package is an implementation of the [sd_notify protocol](https://www.freedesktop.org/software/systemd/man/sd_notify.html#Description).
It can be used to inform systemd of service start-up completion, watchdog events, and other status changes.
## D-Bus
The `dbus` package connects to the [systemd D-Bus API](http://www.freedesktop.org/wiki/Software/systemd/dbus/) and lets you start, stop and introspect systemd units.
[API documentation][dbus-doc] is available online.
[dbus-doc]: https://pkg.go.dev/github.com/coreos/go-systemd/v22/dbus?tab=doc
### Debugging
Create `/etc/dbus-1/system-local.conf` that looks like this:
```
```
## Journal
### Writing to the Journal
Using the pure-Go `journal` package you can submit journal entries directly to systemd's journal, taking advantage of features like indexed key/value pairs for each log entry.
### Reading from the Journal
The `sdjournal` package provides read access to the journal by wrapping around journald's native C API; consequently it requires cgo and the journal headers to be available.
## logind
The `login1` package provides functions to integrate with the [systemd logind API](http://www.freedesktop.org/wiki/Software/systemd/logind/).
## machined
The `machine1` package allows interaction with the [systemd machined D-Bus API](http://www.freedesktop.org/wiki/Software/systemd/machined/).
## Units
The `unit` package provides various functions for working with [systemd unit files](http://www.freedesktop.org/software/systemd/man/systemd.unit.html).