Skip to content
This repository has been archived by the owner on Oct 28, 2024. It is now read-only.

Commit

Permalink
add README documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Matthew Fisher <[email protected]>
  • Loading branch information
bacongobbler committed Apr 13, 2022
1 parent 759df5a commit ed7ef4e
Showing 1 changed file with 62 additions and 2 deletions.
64 changes: 62 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,84 @@ Users seeking to build, deploy, and run applications should look at

## Using the Hippo Client

### Logging in

```console
$ hippo login
Enter username: bacongobbler
Enter password: [hidden]
Logged in as bacongobbler
```

Authentication is handled through `hippo login`, which logs into Hippo. With
`hippo login`, the Hippo URL is specified in the `--url` flag. Hippo requires
authentication: if `--username` or `--password` are not provided, the CLI will
prompt for that information.

Logging out can be performed with `hippo logout`, which logs out of Hippo.

```console
$ hippo logout
$
```

If you want to skip server TLS verification, pass the `-k` flag to `hippo
login`. This can be useful if you are running development services with
self-signed certificates.

**Note: the `-k` and `--danger-accept-invalid-certs` flags are a security risk.
Do not use them in production.**

### Creating an Application

```console
$ hippo app add helloworld helloworld
Added App helloworld (ID = 'e4a30d14-4536-4f4a-81d5-80e961e7710c')
IMPORTANT: save this App ID for later - you will need it to update and/or delete the App
```

### Creating a Channel

```console
$ hippo channel add latest e4a30d14-4536-4f4a-81d5-80e961e7710c
Added Channel latest (ID = '685ff7d8-7eef-456f-ad5a-4c5c39975588')
IMPORTANT: save this Channel ID for later - you will need it to update and/or delete the Channel
```

If not specified, Hippo to deploys the latest revision. This can be changed by
either providing a different `--range-rule`, or by specifying a `--revision-id`.

By default, Hippo will bind the channel to a domain with the address
`<channel_name>.<app_name>.<platform_domain>`. In this case,
`latest.helloworld.hippofactory.local`. If you want to change this domain,
use the `--domain` flag.

### Creating a Revision

If you pushed a bindle to bindle-server called `helloworld/1.0.0`:

```console
$ hippo revision add helloworld 1.0.0
Added Revision 1.0.0
```

If any applications use that storage ID, all its channels will be re-evaluated
to determine if they need to be re-schedule the new revision to the job
scheduler.

### Adding an Environment Variable

```console
$ hippo env add HELLO world 685ff7d8-7eef-456f-ad5a-4c5c39975588
Added Environment Variable HELLO (ID = 'c97f9855-d998-4dac-889b-11b553f53bea')
IMPORTANT: save this Environment Variable ID for later - you will need it to update and/or delete the Environment Variable
```

## Building from source

* Known link failure on WSL: workaround is to build once with `RUSTFLAGS='-C
opt-level=0' cargo build` (after which plain `cargo build` seems to work)
```console
cargo build --release
```

## Contributing

Expand Down

0 comments on commit ed7ef4e

Please sign in to comment.