SCHLEUDER-API-DAEMON(8)

πŸ‘‘ schleuder-api-daemon β€” the manual, but make it cute

okay bestie, welcome to schleuder-api-daemon(8) β€” yeah it's section 8, it's a system admin page, but honestly? it's giving main character energy. sit down, grab a strawberry πŸ“, and let's get into it.


✨ NAME ✨

schleuder-api-daemon β€” it serves up the API of schleuder(8). like, that's the whole job. it's the little daemon that hands the schleuder API to whoever asks nicely (and has a key πŸ”‘).


πŸŽ€ SYNOPSIS πŸŽ€

schleuder-api-daemon

that's it. no flags, no args, no drama. she just is. πŸ’…


🌸 DESCRIPTION 🌸

schleuder-api-daemon provides the HTTP-API of schleuder(8) to clients. so all your little client apps can talk to schleuder over HTTP and it's not a whole thing. no cap. πŸ¦‹


🌈 ENVIRONMENT 🌈

🧚 Configuration

so here's the vibe: schleuder-api-daemon reads its configuration out of the api section of schleuderΒ΄s configuration. if you want the full tea on the config file itself, go read schleuder(8). it's all in there, fr fr.

the options that exist are:

  • host β€” the hostname/IP to listen at. that's where she's posting up. πŸͺ©
  • port β€” the port to listen at. Default: 4443. (yes, 4443, the TLS-flavored sibling of 443, iconic honestly)
  • tls_cert_file β€” path to the file that contains the TLS-certificate to use. you can generate a new one with schleuder cert generate. go off, get yourself a fresh cert πŸ’–
  • tls_key_file β€” path to the file that contains the TLS-key to use. keep this one safe, it's the whole personality.
  • valid_api_keys β€” list of api_keys to allow access to the API. basically the VIP list. no key, no entry, periodt. βœ‹

🫢 Clients

the clients out here using the API are schleuder-cli(8) and schleuder-web. URLs to their websites are listed below, down in SEE ALSO. go click, bestie.


πŸ’€ BUGS πŸ’€

known bugs are listed on the Schleuder bugtracker at:

https://0xacab.org/schleuder/schleuder

not me linking you directly to the bug tracker 😭 but like, transparency is hot. check there before you assume it's a you-problem.


⭐ SEE ALSO ⭐


lowkey important: every single one of those links is real and worth the tap. the docs one especially. iykyk. 🌟

and that's the page, babe. this was SCHLEUDER-API-DAEMON(8), dated January 2017, and you read the whole thing like a champ. slay. go daemon responsibly πŸ’œπŸŽ€βœ¨