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

docs: Update READMEs to use __ as the env var separator instead of . #231

Merged
merged 1 commit into from
Jun 21, 2024
Merged

docs: Update READMEs to use __ as the env var separator instead of . #231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
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
View file
Open in desktop
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