27 lines
1.4 KiB
Markdown
27 lines
1.4 KiB
Markdown
|
# Getting Started Guide - tfcli
|
||
|
|
|
||
|
|
This guide will walk you through the process of setting up a new `trifid-api` organization and enrolling your first host, from scratch, using the `trifid` stack and a `trifid-api` server.
|
||
|
|
|
||
|
|
This guide assumes you already have a `trifid-api` server set up, but you have *not* created a user account or organization yet. If you have, the [Quick Reference Handbook](./qrh.md) may be of more use to you.
|
||
|
|
|
||
|
|
If you don't have a `trifid-api` server set up, or need help configuring it, consider checking out the [`trifid-api` Getting Started Guide](../trifid-api/getting_started.md) or the [`trifid-api` Quick Reference Handbook](../trifid-api/qrh.md).
|
||
|
|
|
||
|
|
## Installing `tfcli`
|
||
|
|
|
||
|
|
The first step to using `tfcli` is installing it. We recommend you do this via `cargo`, rust's package manager, as it is the most fool-proof way to quickly ensure that the program is installed correctly.
|
||
|
|
|
||
|
|
Run the following command:
|
||
|
|
|
||
|
|
```shell
|
||
|
|
cargo install tfcli
|
||
|
|
```
|
||
|
|
|
||
|
|
This will install the `tfcli` binary to your Cargo `bin/` directory. You'll need to ensure that this directory is on your `PATH` - doing so is outside the scope of this guide.
|
||
|
|
|
||
|
|
## Creating your account
|
||
|
|
|
||
|
|
The first step in setting up your `trifid-api` account is creating it! This, like all other tasks, can be done via the `tfcli` program. You'll need the following on hand:
|
||
|
|
|
||
|
|
- An email address (you don't need access to the mailbox though)
|
||
|
|
- Access to the `trifid-api` server logs to get the login token
|
||
|
|
-
|