Start a minimal project (hello-chillbox)

Run the chillbox init command again. Note that this time it will prompt for the 'current_user' to be set. Enter alice as the current user for this tutorial. After hitting enter it will show another message stating that the current_user has not been added to the chillbox configuration. Do that now by appending the below to the configuration file.

[[user]]
name = "alice" (1)
gpg-key = "alice@hello-chillbox.example" (2)

Run the chillbox init command again. This time it will see that a user has been defined and the current user matches it (alice is the current user at this step in the tutorial). Chillbox uses GnuPG to encrypt the private asymmetric key that chillbox will generate. Since your local machine most likely doesn’t already have a GPG key named 'alice@hello-chillbox.example'; it will prompt you to create a new GPG key and set a password on it.

Persist the password_hash and public_ssh_key that was created for alice. These are stored in the chillbox archive directory and can be viewed by using the jq command or just open the statefile.json in a text editor. Copy these from .chillbox/statefile.json and include them in the chillbox.toml for the alice user.

[[user]]
name = "alice"
gpg-key = "alice@hello-chillbox.example"
password_hash = "..." (1)
public_ssh_key = [
   "..." (2)
]

Add another user named bob to the chillbox.toml. Bob has shared his public ssh key with Alice, so it can also be set here.

[[user]]
name = "bob"
gpg-key = "bob@hello-chillbox.example"
public_ssh_key = "ssh-rsa AAAbbbCCCddd== bob@hello-chillbox.example" (1)

Alice has access to a secret value that will be needed on the server. Add a secret in the chillbox.toml like this.

[[secret]]
id = "favorite_color_for_alice"
name = "FAVORITE_COLOR"
prompt = "What... is your favorite color?"
owner = "alice"

Run the chillbox init command again. It will prompt Alice for that secret since she is the current user and the 'owner' is set to alice. After entering the secret value (no characters will be shown); the secret is encrypted and stored in the chillbox archive directory.

Bob also has access to a secret that will need to be used on a server. Alice will not need to ask Bob for that secret, but can add a prompt for it in the chillbox.toml. This time the 'owner' will be set to bob. This secret is only valid for a short time and so an 'expires' date is set.

[[secret]]
id = "level_3_lunch_code"
name = "SECRET_LUNCH_CODE"
prompt = "Enter the lunch code for next week:"
owner = "bob"
expires = 2023-11-02 (1)

Other values that are not so secretive can be added as environment variables. Add some now by adding an 'env' section and key/values to the chillbox configuration file.

[env]
MENU = "breakfast"
THEME = "funny hats"

Chillbox can be used to load up these env variables with the 'output-env' subcommand. The 'output-env' will print out the temporary file that is created. Run this command to display them.

# Show the environment variables set with chillbox.
chillbox output-env | xargs cat

# Show the environment variables and secrets set with chillbox.
chillbox output-env --sensitive | xargs cat

Show the help for more information: chillbox --help output-env

Now Alice needs a file to be uploaded to the server. The 'path' for it can be defined in the chillbox configuration file. Create a new directory named 'server-files' and add a file named the-menu.md with the below content.

Add that file as a 'path' to the configuration file.

[[path]]
id = "server-menu-md"
src = "server-files/the-menu.md"
dest = "/srv/files/the-menu.md"

Running chillbox init again will process all items in 'path' list. Each one will be gzipped and encrypted to the chillbox archive directory under the 'id' attribute. Include the id of the path item to the 'remote-files' of a server for it to be uploaded to that server. This step is not necessary for this tutorial since the server being used doesn’t need to exist.

[[server]]
# ... Existing hello-chillbox-example-server
remote-files = [
  "server-menu-md"
]

Path items can also be rendered from a template. Add this jinja file with the name breakfast-menu.md.jinja to the template-tutorial/ directory.

# Breakfast Menu for {{ event_name }}

Our theme for today is: {{ THEME }}.

## The Specials
- Spam
- Eggs

Add it as a 'path' with the id of 'breakfast-menu'. The 'src' attribute uses the 'tutorial:' prefix defined for that template entry, so it also needs to set the 'render' attribute to true.

## ... other 'path' items

[[path]]
id = "breakfast-menu"
src = "tutorial:breakfast-menu.md.jinja"
render = true
dest = "/srv/files/breakfast-menu.md"

Run the chillbox show breakfast-menu command to see the rendered file. This will print out the temporary directory that has the rendered file in it. Using chillbox show is useful to view the rendered file by the path id before uploading them to a server. These files are always stored in the chillbox archive directory as encrypted gzipped files.

# Show the rendered files for 'breakfast-menu' path id.
chillbox show breakfast-menu | xargs ls -R

Fix the breakfast-menu path to include event_name variable. This can be done for just this path by adding a 'context' to it. Update the chillbox configuration for the breakfast-menu path.

[[path]]
id = "breakfast-menu"
src = "tutorial:breakfast-menu.md.jinja"
render = true
dest = "/srv/files/breakfast-menu.md"
[path.context] (1)
event_name = "Alice and Bob" (2)

To create a file with a secret value; add the 'sensitive' and 'owner' attributes. Create a new file that Alice will include her 'FAVORITE_COLOR' color secret in.

Favorite color for {{ chillbox_path.owner | title }} is: {{ FAVORITE_COLOR }}.

And create a new 'path' item:

[[path]]
id = "alice-answers"
src = "tutorial:answers.txt.jinja"
render = true
owner = "alice" (1)
sensitive = true (2)
dest = "/srv/files/alice/answers.txt"

Preview it by using the chillbox show alice-answers --sensitive command. The output will be a temporary directory with the rendered answers.txt file in it.