README
¶
Gesedels
Gesedels is a stack-based API-only value store written in Go 1.19 by Stephen Malone. It's designed to be a rock-solid dumpster for plaintext, public, ephemeral data.
- Visit
https://gesedels.comfor the live service. - See
changes.mdfor the complete changelog. - See
license.mdfor licensing information (BSD-3). - See the issue tracker for current bugs and feature requests.
The Basics
Terms of Use
- All endpoints send and receive plaintext strings over SSL.
- All data is public and can be accessed by anyone with your token.
- All data is ephemeral and has a finite time-to-live.
Privacy Policy
- Gesedels only tracks the data you explicitly transmit to us.
- You can delete your data any time using the
DELETE /{token}endpoint. - We reserve the right to delete anything nefarious, offensive or illegal.
The Endpoints
- Endpoints use HTTP codes to indicate their response status.
- See
errors.gofor all possible error messages.
GET a New Token
Create and return a new API token.
- The return value is the created token or an error message.
- ⚠️ This token is your only method of authentication, so keep it secret.
$ GET https://gesedels.com/register
▸ 200 "2F4wx8Yu8VlwJAGg2rPrpWBo8LR"
DELETE an Existing Token
Delete an existing token and its entire stack.
- The return value is
successor an error message. - Deleting a token that does not exist also returns
success. - ⚠️ Use this wisely, as there is no confirmation and no backup.
$ DELETE https://gesedels.com/2F4wx8Yu8VlwJAGg2rPrpWBo8LR
▸ 200 "success"
PUSH a New Item
Push an item onto a token's stack.
- The return value is the length of the pushed item or an error message.
- The item must be between one and ten thousand bytes.
- The stack may have up to one thousand items on it.
- ⚠️ If a stack goes seven days without a
PUSH, it is deleted.
$ POST https://gesedels.com/2F4wx8Yu8VlwJAGg2rPrpWBo8LR "ah, push it!"
▸ 200 "12"
GET the Top Item
Pop the top item on a token's stack.
- The return value is the popped item or an error message.
- Popping an empty stack will return an empty string.
- ⚠️ Tokens with empty stacks are periodically purged.
$ GET https://gesedels.com/2F4wx8Yu8VlwJAGg2rPrpWBo8LR
▸ 200 "ah, push it!"
Contributions
Please submit all bugs and feature requests to the issue tracker, thank you.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package main implements the main program function.
|
Package main implements the main program function. |
|
core/args
Package args implements the Args type and methods.
|
Package args implements the Args type and methods. |
|
proto/hpio
Package hpio implements HTTP protocol input/output functions.
|
Package hpio implements HTTP protocol input/output functions. |
|
proto/redis
Package redis implements Redis database variables and functions.
|
Package redis implements Redis database variables and functions. |
|
tools/logs
Package logs implements logging functions.
|
Package logs implements logging functions. |
|
tools/test
Package test implements unit-testing functions.
|
Package test implements unit-testing functions. |
|
tools/tpls
Package tpls implements template rendering functions.
|
Package tpls implements template rendering functions. |
|
urls
Package urls implements URL handler functions.
|
Package urls implements URL handler functions. |
Click to show internal directories.
Click to hide internal directories.