Skip to content

Commit f098b15

Browse files
committed
added CLI changes
1 parent 38112b2 commit f098b15

File tree

4 files changed

+59
-2
lines changed

4 files changed

+59
-2
lines changed

src/SUMMARY.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Summary
22

3-
---
3+
---
44

55
- [Getting Started](./getting-started/index.md)
66
- [Configuration](./config/index.md)
@@ -9,4 +9,5 @@
99
- [Languages](./config/languages.md)
1010
- [Account](./config/account.md)
1111
- [Packet](./config/packet.md)
12-
- [Basalt CLI]()
12+
- [Hashing](./config/hashing.md)
13+
- [Basalt CLI](./cli/index.md)

src/cli/index.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Basalt CLI
2+
3+
The Basalt CLI is a tool for packet designers and competition administrators
4+
for provisioning servers, generating packet PDF documents, and verifying
5+
server configurations.
6+
7+
The Basalt CLI is [Open Source](https://github.com/basalt-rs/basalt-cli).
8+
9+
## Provisioning a Server
10+
11+
To build a server, you first must have a valid server configuration. By
12+
default this is a `basalt.toml` file in the current working directory, but
13+
any other valid file can be supplied.
14+
15+
*NOTE: The Basalt Server leverages docker for security and portability*
16+
17+
```
18+
basalt build
19+
```
20+
21+
With no arguments provided, the Basalt CLI will attempt to build a docker
22+
image using `basalt.toml` as the configuration. This docker image will be
23+
tagged with "bslt" prepended to the hash of the configuration.
24+
25+
*NOTE: Not all changes have any affect on the hash [More Info](../config/hashing.md)*
26+
27+
You can now run your container:
28+
29+
```
30+
docker run -p <outer port>:9090 <conatiner name>
31+
```
32+
33+
Soon, you will be able to simply run `basalt run` to run your server.

src/config/hashing.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Hashing
2+
3+
There are reasons you may want to compute the hash of your configuration. There
4+
are some nuances to this calculation.
5+
6+
Firstly, it is not based on the file itself. It is based a subset of on the
7+
parsed configuration. This means that whitespace changes and a handful of
8+
properties will have no impact on the hash.

src/getting-started/index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,16 @@
11
# Getting Started
2+
3+
To *administer* a competition, check out the [Basalt CLI docs](../cli/index.md).
4+
5+
To *participate* in a competition, download the
6+
[Basalt desktop](https://github.com/basalt-rs/basalt/releases/latest).
7+
Be sure to download the release appropriate for your OS and architecture.
8+
You can also check our [install page](./install.md) to see whether Basalt
9+
is in your OS's package repository.
10+
11+
Once you've installed and opened the application, you will be prompted to
12+
provide the IP address of the server. After you've provided the IP, click
13+
_next_ to continue to login.
14+
15+
Your login credentials will be provided to you by the competition
16+
administrator. Once you've logged in, you're ready to begin competing!

0 commit comments

Comments
 (0)