Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/assemblycapital/houston
urbit moon manager
https://github.com/assemblycapital/houston
Last synced: 7 days ago
JSON representation
urbit moon manager
- Host: GitHub
- URL: https://github.com/assemblycapital/houston
- Owner: assemblycapital
- Created: 2022-07-18T15:36:54.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-11T18:32:19.000Z (8 months ago)
- Last Synced: 2024-08-03T01:12:51.999Z (4 months ago)
- Language: TypeScript
- Size: 950 KB
- Stars: 16
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-urbit - houston
README
# houston
urbit moon dashboard
houston exposes a poke api for your moon utilities:
- |moon
- |moon-breach
- |moon-cycle-keys
houston only accepts pokes from our.bowl
jael is still the source of truth for each moons pubkey, life, and rift.
when a moon is created or rekeyed through houston, houston keeps a copy of the private key.
the private key / seed is needed when launching the moon for the first time or after a breach.
moons can be initially booted using the following command:
`./urbit -w -G `
or
`/urbit -w sampel-sampel-palnet -G 0wm4W1E.ees11.MtSXj.-51oT.NN-7E.O1uch.2eM0g.2QhRf.KyiER.ke7cN.qynND.qAkrn.sJUOr.CkbEC.JRtiD.gqwz7.DDDYf.Q82M0.ecoac.ag000.1rwg1`
or
`./urbit -w sampel-sampel-palnet -k ./sampel-sampel-palnet.key`
the next time you boot, just run:
`./urbit `
or
`./urbit sampel-sampel-palnet`
## Using The Frontend
the `create` button spawns a new moon. this maps to |moon.
it can optionally be given a @p. if not, it will create a random moon.
each moon has a `breach` button and a `cycle keys` button. these correspond with |moon-breach and |moon-cycle-keys respectively.
moons also have a `forget` button. this simply removes the moon from houstons agent state. it doesnt affect the actual moon.
users can `import` a moon, which just adds the moon @p into houston without any metadata.
this allows existing moons to be tracked and tagged as part of the same database.
imported moons can still be breached and can still have their keys reset from the houston UI.
when an imported moon has its keys reset, the new data will be stored in houston.
moons can be given `tags` which are just arbitrary text. this should be useful to track:
- what services the moon is responsible for
- what machine the moon is running on
- who operates the moon
## Using The API
houston can be poked by other apps to create / breach / rekey moons. previously, this was only possible through dojo.
for a spec of the poke API, refer to the source code.
to get a moons data from houston:
```hoon
+houston!get ~sampel-sampel-palnet
```
this is a generator that wraps a scry endpoint.
more cli tools for houston
```hoon
:houston|create
:houston|create ~sampel-sampel-palnet
:houston|tag ~sampel-sampel-palnet 'best moon ever'
:houston|rekey ~sampel-sampel-palnet
:houston|breach ~sampel-sampel-palnet
```
## Installing the Desk From Source
in dojo:
```
|merge %houston our %base
|mount %houston
```
in unix:
```
cd
rm -r ./*
cp -rL <(urbit)/pkg/base-dev>/* .
cp -rL <(urbit)/pkg/garden-dev>/* .
cd /desk/
./install.sh -w
```
in dojo:
```
|commit %houston
|install our %houston
```
## UI
houston is built primarily using [React], [Typescript], and [Tailwind CSS]. [Vite] ensures that all code and assets are loaded appropriately, bundles the application for distribution and provides a functional dev environment.
### Getting Started
To get started using houston first you need to run `npm install` inside the `ui` directory.
To develop you'll need a running ship to point to. To do so you first need to add a `.env.local` file to the `ui` directory. This file will not be committed. Adding `VITE_SHIP_URL={URL}` where **{URL}** is the URL of the ship you would like to point to, will allow you to run `npm run dev`. This will proxy all requests to the ship except for those powering the interface, allowing you to see live data.
Regardless of what you run to develop, Vite will hot-reload code changes as you work so you don't have to constantly refresh.
### Deploying
To deploy, run `npm run build` in the `ui` directory which will bundle all the code and assets into the `dist/` folder. This can then be made into a glob, and linked to from the desk.docket-0 file
[urbit.org glob docs](https://developers.urbit.org/reference/additional/dist/glob)