kvarnctl

Crates.iokvarnctl
lib.rskvarnctl
version0.2.1
sourcesrc
created_at2022-04-24 13:33:03.990778
updated_at2024-10-25 23:09:25.279198
descriptionCommunication with Kvarn from the command line.
homepagehttps://kvarn.org/ctl/
repositoryhttps://github.com/Icelk/kvarn/
max_upload_size
id573125
size41,117
Icelk (Icelk)

documentation

README

kvarnctl

Communication with Kvarn from the command line.

kvarnctl takes a command from you and sends it to Kvarn.

The Kvarn instance listening for commands may implement arbitrary commands through the plugin interface.

See the CI on GitHub for Linux downloads.

Custom ctl path

If you configured Kvarn to listen to a custom path, you can specify it using the -p flag. If the path is relative, its base is /run/user/<uid>/ for users and /run/ for root.

Common commands

  • kvarnctl shutdown - this gracefully shuts Kvarn down (if the Kvarn feature graceful-shutdown is enabled)
  • kvarnctl reload - handover to the new binary, located on the same path as the current was started on.
  • kvarnctl ping <message> - test if the Kvarn instance is responsive. It will return <message> and print it to the terminal.
  • kvarnctl wait - waits for Kvarn to shut down
  • kvarnctl clear <method> (<host> <file/URI>) - clears caches. Methods available are all, files, responses, and two which clear a specific resource, file and response.

Platform support

This isn't supported on Windows as it relies on UNIX socket. It's unfeasible we get this working on Windows, as handover isn't possible and the need for remote management on Windows is a very slim market. PRs to kvarn-socket with named pipe support is however welcome :)

Changelog

v0.1.1

  • Update to kvarn_utils = "0.5"
Commit count: 1435

cargo fmt