Project

yetty

0.0
No commit activity in last 3 years
No release in over 3 years
Simple web TTY
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Runtime

>= 0
>= 0
>= 0
>= 0
>= 0
~> 3.0
 Project Readme

Yetty

With shelr.tv1 now defunct, I wanted an easy way to spin out my own to easily share terminal recordings. Yetty is a wrapper around shelr2 that removes some of the extra features it provids. It also has a very simple web UI builtin that hooks into an object store to persist dump files.

Is it secure?

No, not at all. This is configuration based and user uploads are simply prefixed within the bucket. But this is just a friendly tool, so if bad things happen, maybe your friends aren't so friendly.

Web UI?

Yep. It's a very simple sinatra application. It pulls information directly from the object store. So not built for speed or scale.

Private?

Kinda. Private pushes are simply not listed publicly. So you'll need the direct link to access them (much like private gists).

Configuration

Configuration is a JSON file. Locations checked in order of precedence:

  • ./yetty
  • ~/.yetty
  • /etc/yetty/config.json

File contents:

{
  "site": {
    "url": "http://localhost:4000"
  },
  "user": {
    "username": "YOUR_USERNAME",
    "storage": {
      "provider": "aws",
      "bucket": "my-yetty-bucket",
      "credentials": {
        "aws_access_key_id": "...",
        "aws_secret_access_key": "...",
        "aws_bucket_region": "..."
      }
    }
  }
}

The credentials section are the credentials expected by miasma3 based on the provider in use.

Thanks!

A big thanks to @antono for the shelr2 library. Also to @jeromeetienne for the beautiful nyancat4