diff --git a/README.md b/README.md index 85dd1bd7..eb28b779 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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 diff --git a/examples/full/README.md b/examples/full/README.md index 8b6786b9..78721f32 100644 --- a/examples/full/README.md +++ b/examples/full/README.md @@ -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