spel
v0.0.13
Published
heavily based on the code from [streisand](https://github.com/StreisandEffect/streisand).
Downloads
16
Readme
space elevator
heavily based on the code from streisand.
space elevator sets up a remote server that acts as your SSB identity. this allows you to run some of the SSB apps over SSH and the database is kept on the remote host. space elevator might be for people who fall into these categories:
- not enough space/power on personal computer to keep SSB running
- only computer is provided by work and don't want to (aren't allowed) to install SSB
usage
before anything, you need to have git
, nvm
(node version manager), pip
, and python
(2.7)
you also need your ssh key present in ~/.ssh/id_rsa.pub
.
then, to provision a new space elevator server, run:
npx spel provision
it will ask about what platform to setup on and necessary auth keys, etc.
after it's done, you can run a supported ssb app (like patchbay) with this command:
npx spel <appname>
(see below for support apps). after you exit the SSB app, space elevator deletes the local ~/.ssb folder, but keeps the app files for quicker startup next run.
for debugging purposes, you can access your server with:
ssh spaceman@<public ip>
the public IP of the server is saved in ~/.space-elevator/ip
.
supported cloud providers
- amazon
- linode
supported ssb apps
cleanup
if you want to delete local remnants of a provisioning, run npx spel cleanup
. this will not delete entities in the cloud -- that has to be done manually.
agnostic
mostly for testing purposes, npx spel agnostic
is also a valid command (after provisioning), which does the following:
- copy down secret and manifest.json from space elevator
- establish SSH tunnel on 8008 and 8989 (blobs) to space elevator
- wait for user input to close
- on close, terminates the SSH tunnel and deletes the local secret and manifest files
this way you could potentially spin up an unsupported app and it should connect properly to the space elevator ssb instance on 8008.
license
MIT