Skip to content

Commit

Permalink
doc: fix alphabetical order in env.md (#10542)
Browse files Browse the repository at this point in the history
closes: #XXXX
refs: #XXXX

## Description

Fix alphabetical order in env.md

Only moved the sections. No edits to the content within the sections.

### Security Considerations
none
### Scaling Considerations
none
### Documentation Considerations
Alphabetical order is good.
### Testing Considerations
none
### Upgrade Considerations
none
  • Loading branch information
erights authored Nov 20, 2024
1 parent 429a377 commit 721071e
Showing 1 changed file with 49 additions and 49 deletions.
98 changes: 49 additions & 49 deletions docs/env.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,55 +164,6 @@ for the Prometheus scrape endpoint to export telemetry.

Lifetime: until we decide not to support Prometheus for metrics export

## SOLO_BRIDGE_TARGET

Affects: solo

This enables a proxy so that the solo bridge interface (/wallet-bridge.html) is backed by the smart wallet (/wallet/bridge.html). Dapps designed for the solo bridge can enable this until they connect to the smart wallet directly.

```sh
BRIDGE_TARGET=http://localhost:3001 make BASE_PORT=8002 scenario3-run
```

Lifetime: smart wallet transition period

## SOLO_MNEMONIC

Affects: solo init

Seed phrase for HD key derivation.

## SOLO_OTEL_EXPORTER_PROMETHEUS_PORT

Affects: solo

Same as `OTEL_EXPORTER_PROMETHEUS_PORT`, but for solo instead of chain.

Lifetime: ?

## SOLO_SLOGFILE

Same as `SLOGFILE`, but for solo instead of chain.

Lifetime: ?

## SOLO_SLOGSENDER

Same as `SLOGSENDER`, but for solo instead of chain.

Lifetime: ?

## SOLO_MAX_DEBUG_LENGTH

Affects: solo

Purpose: reduce the size of each individual `console.debug` output

Description: defaults to no limit, set to a decimal byte count to reduce the
output

Lifetime: Until CI no longer balks on long output, or our source bundles aren't delivered via messages to the sim-chain

## SLOGFILE

Affects: cosmic-swingset
Expand Down Expand Up @@ -265,6 +216,55 @@ have any unexpected errors.

The default is `undefined`.

## SOLO_BRIDGE_TARGET

Affects: solo

This enables a proxy so that the solo bridge interface (/wallet-bridge.html) is backed by the smart wallet (/wallet/bridge.html). Dapps designed for the solo bridge can enable this until they connect to the smart wallet directly.

```sh
BRIDGE_TARGET=http://localhost:3001 make BASE_PORT=8002 scenario3-run
```

Lifetime: smart wallet transition period

## SOLO_MAX_DEBUG_LENGTH

Affects: solo

Purpose: reduce the size of each individual `console.debug` output

Description: defaults to no limit, set to a decimal byte count to reduce the
output

Lifetime: Until CI no longer balks on long output, or our source bundles aren't delivered via messages to the sim-chain

## SOLO_MNEMONIC

Affects: solo init

Seed phrase for HD key derivation.

## SOLO_OTEL_EXPORTER_PROMETHEUS_PORT

Affects: solo

Same as `OTEL_EXPORTER_PROMETHEUS_PORT`, but for solo instead of chain.

Lifetime: ?

## SOLO_SLOGFILE

Same as `SLOGFILE`, but for solo instead of chain.

Lifetime: ?

## SOLO_SLOGSENDER

Same as `SLOGSENDER`, but for solo instead of chain.

Lifetime: ?

## SWINGSET_WORKER_TYPE

Affects: solo, unit tests
Expand Down

0 comments on commit 721071e

Please sign in to comment.