weird Go thing that's just an API that returns a few words.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
gryffyn e17f17d05b
updated readme
8 months ago
cmd Ability to change location 8 months ago
example-config Added proper readme, fixed configs, and added systemd service 8 months ago
.gitignore init 8 months ago
LICENSE Initial commit 8 months ago
README.md updated readme 8 months ago
go.mod init 8 months ago

README.md

gfn-status

weird Go thing that's just an API that returns a few words.

Install

Get the server by running go get git.neveris.one/gryffyn/gfn-status/server. The bin can be found in your $GOPATH.
Copy the bin to somewhere in $PATH or leave it as is.

Get the client by running go get git.neveris.one/gryffyn/gfn-status/client.
The bin can be found in your $GOPATH.

Config

Example configuration files are provided in /example-config.
The configuration for gfn-status-server should be copied to /etc/gfn-status/server.yml and edited accordingly.

The configuration for gfn-status-client should be copied to the config directory of the user you intend to run it as, so ~/.config/gfn-status/client.yml

Running

An example systemd service file has been included in /example-config. Copy it to /etc/systemd/system, edit to set the path of your executable, and run with

systemctl start gfn-status.service, or to enable it,
systemctl enable --now gfn-status.service

Client usage --

Usage: gfn-status [options...] COMMAND [options...]

get/set status

Options:
  -h, --help    	Display usage
  -v, --version 	Display version

Commands:
  get           	Get status
  set           	Set status