Skip to content

Commit

Permalink
docs: Update READMEs to use __ as the env var separator instead of .
Browse files Browse the repository at this point in the history
  • Loading branch information
spencewenski committed Jun 21, 2024
1 parent b3789b8 commit 4a336c6
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,15 @@ git clone https://github.com/roadster-rs/roadster.git
cd roadster/examples/full
```

## Set the environment (production/development/test)

```shell
# Either set it as an environment variable
export ROADSTER__ENVIRONMENT=development
# Or add it to a `.env` file
echo ROADSTER__ENVIRONMENT=development >> .env
```

## Start your app

```shell
Expand All @@ -107,7 +116,7 @@ You can also view traces locally using, for example, Jaeger or SigNoz.
The easiest way to view OpenTelemetry Traces locally is by
running [Jaeger](https://www.jaegertracing.io/docs/1.54/getting-started/).

1. Set `ROADSTER.TRACING.OTLP_ENDPOINT="http://localhost:4317"` in your `.env` file, or in
1. Set `ROADSTER__TRACING__OTLP_ENDPOINT="http://localhost:4317"` in your `.env` file, or in
your `config/development.toml` or `config/test.toml` configs as appropriate.
2. Run the following command:
```shell
Expand All @@ -131,7 +140,7 @@ running [Jaeger](https://www.jaegertracing.io/docs/1.54/getting-started/).

Another option to view traces (and metrics) locally is to run [Signoz](https://signoz.io/docs/install/docker/).

1. Set `ROADSTER.TRACING.OTLP_ENDPOINT="http://localhost:4317"` in your `.env` file, or in
1. Set `ROADSTER__TRACING__OTLP_ENDPOINT="http://localhost:4317"` in your `.env` file, or in
your `config/development.toml` or `config/test.toml` configs as appropriate.
2. Install and run Signoz in a directory of your choice
```shell
Expand Down
2 changes: 1 addition & 1 deletion examples/full/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ An example of using all (most) of Roadster's features. Used as a reference imple

```shell
# Set the environment, example:
export ROADSTER.ENVIRONMENT=development
export ROADSTER__ENVIRONMENT=development
# Start the database and redis (for sidekiq). Note: change the credentials when deploying to prod
docker run -d -p 5432:5432 -e POSTGRES_USER=roadster -e POSTGRES_DB=full_dev -e POSTGRES_PASSWORD=roadster postgres:15.3-alpine
docker run -d -p 6379:6379 redis:7.2-alpine
Expand Down

0 comments on commit 4a336c6

Please sign in to comment.