Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add env descriptions to docs #1059

Merged
merged 5 commits into from
Sep 22, 2023
Merged

Add env descriptions to docs #1059

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
18697fe
Add env descriptions to docs
Lucais11 Sep 21, 2023
1b4059e
Made text stlying change
Lucais11 Sep 21, 2023
0575efa
small change on a word
Lucais11 Sep 21, 2023
7b1d405
Updated the docs based on what was suggested
Lucais11 Sep 22, 2023
30c52c8
Update reference/runtime-environment.html.md
Lucais11 Sep 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions reference/runtime-environment.html.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,21 @@ Not to be confused with the [HTTP header](/docs/reference/runtime-environment/#f
### `FLY_IMAGE_REF`
**Docker Image Reference**: The name of the Docker image running this container. Useful if your application needs to launch Machine instances of itself to scale up-or-down. Read about how [a Rails app runs Machines for scale-to-zero background workers](https://fly.io/ruby-dispatch/rails-background-jobs-with-fly-machines/). `registry.fly.io/my-app-name:deployment-01H9RK9EYO9PGNBYAKGXSHV0PH` is an example of the Docker Image Reference's format.

### `FLY_MACHINE_ID`
**Machine ID**: Each Fly Machine is identified by a unique Machine ID. This is the ID that `flyctl` and the `Machines API` use to identify that Machine, and you'll see it in the [logs](/docs/flyctl/logs/).
Lucais11 marked this conversation as resolved.
Show resolved Hide resolved

### `FLY_MACHINE_VERSION`
**Machine Configuration Version**: Every Machine configuration has an associated version. Whenever you update a Machine's configuration (including when you update its Docker image), it gets a new `FLY_MACHINE_VERSION`. The exception to this is that changing only the Machine's metadata doesn't trigger a new version.
Lucais11 marked this conversation as resolved.
Show resolved Hide resolved
Lucais11 marked this conversation as resolved.
Show resolved Hide resolved

### `FLY_PRIVATE_IP`
**Private IPv6 Address**: This is the `IPv6 address` of the Machine on its [6PN private network](/docs/reference/private-networking/).
Lucais11 marked this conversation as resolved.
Show resolved Hide resolved

### `FLY_PROCESS_GROUP`
**Process Group**: This is [the process group](/docs/apps/processes) associated with the Machine.
Lucais11 marked this conversation as resolved.
Show resolved Hide resolved

### `FLY_VM_MEMORY_MB`
**Machine Memory**: This is the memory allocated to the Machine, in MBs. It's the same value you'll find under https://fly.io/dashboard/personal/machines and VM Memory in the output of `fly machine status`. More information on sizing [here](/docs/machines/guides-examples/machine-sizing/)!
Lucais11 marked this conversation as resolved.
Show resolved Hide resolved

## _Request Headers_

### `Fly-Client-IP`
Expand Down