Skip to content

Commit 97e3634

Browse files
committed
refactor: [#596] rename env vars
``` TORRUST_INDEX_CONFIG -> TORRUST_INDEX_CONFIG_TOML TORRUST_INDEX_PATH_CONFIG -> TORRUST_INDEX_CONFIG_TOML_PATH TORRUST_INDEX_TRACKER_API_TOKEN -> TORRUST_INDEX_CONFIG_OVERRIDE_TRACKER__TOKEN TORRUST_INDEX_AUTH_SECRET_KEY -> TORRUST_INDEX_CONFIG_OVERRIDE_AUTH__SECRET_KEY ```
1 parent 5910fda commit 97e3634

File tree

20 files changed

+57
-55
lines changed

20 files changed

+57
-55
lines changed

.env.local

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
DATABASE_URL=sqlite://storage/database/data.db?mode=rwc
2-
TORRUST_INDEX_CONFIG=
3-
TORRUST_INDEX_AUTH_SECRET_KEY=MaxVerstappenWC2021
2+
TORRUST_INDEX_CONFIG_TOML=
3+
TORRUST_INDEX_CONFIG_OVERRIDE_AUTH__SECRET_KEY=MaxVerstappenWC2021
44
USER_ID=1000
55
TORRUST_TRACKER_CONFIG_TOML=
66
TORRUST_TRACKER_CONFIG_OVERRIDE_DB_DRIVER=Sqlite3

Containerfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,13 +97,13 @@ FROM gcr.io/distroless/cc-debian12:debug as runtime
9797
RUN ["/busybox/cp", "-sp", "/busybox/sh","/busybox/cat","/busybox/ls","/busybox/env", "/bin/"]
9898
COPY --from=gcc --chmod=0555 /usr/local/bin/su-exec /bin/su-exec
9999

100-
ARG TORRUST_INDEX_PATH_CONFIG="/etc/torrust/index/index.toml"
100+
ARG TORRUST_INDEX_CONFIG_TOML_PATH="/etc/torrust/index/index.toml"
101101
ARG TORRUST_INDEX_DATABASE_DRIVER="Sqlite3"
102102
ARG USER_ID=1000
103103
ARG API_PORT=3001
104104
ARG IMPORTER_API_PORT=3002
105105

106-
ENV TORRUST_INDEX_PATH_CONFIG=${TORRUST_INDEX_PATH_CONFIG}
106+
ENV TORRUST_INDEX_CONFIG_TOML_PATH=${TORRUST_INDEX_CONFIG_TOML_PATH}
107107
ENV TORRUST_INDEX_DATABASE_DRIVER=${TORRUST_INDEX_DATABASE_DRIVER}
108108
ENV USER_ID=${USER_ID}
109109
ENV API_PORT=${API_PORT}

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -83,14 +83,14 @@ cp ./share/default/config/index.development.sqlite3.toml ./storage/index/etc/ind
8383
vim ./storage/index/etc/index.toml
8484

8585
# Run the index with the updated configuration:
86-
TORRUST_INDEX_PATH_CONFIG="./storage/index/etc/index.toml" cargo run
86+
TORRUST_INDEX_CONFIG_TOML_PATH="./storage/index/etc/index.toml" cargo run
8787
```
8888

8989
_Optionally, you may choose to supply the entire configuration as an environmental variable:_
9090

9191
```sh
9292
# Use a configuration supplied on an environmental variable:
93-
TORRUST_INDEX_CONFIG=$(cat "./storage/index/etc/index.toml") cargo run
93+
TORRUST_INDEX_CONFIG_TOML=$(cat "./storage/index/etc/index.toml") cargo run
9494
```
9595

9696
_For deployment, you __should__ override:
@@ -100,9 +100,9 @@ _For deployment, you __should__ override:
100100
```sh
101101
# Please use the secret that you generated for the torrust-tracker configuration.
102102
# Override secret in configuration using an environmental variable
103-
TORRUST_INDEX_CONFIG=$(cat "./storage/index/etc/index.toml") \
104-
TORRUST_INDEX_TRACKER_API_TOKEN=$(cat "./storage/tracker/lib/tracker_api_admin_token.secret") \
105-
TORRUST_INDEX_AUTH_SECRET_KEY="MaxVerstappenWC2021" \
103+
TORRUST_INDEX_CONFIG_TOML=$(cat "./storage/index/etc/index.toml") \
104+
TORRUST_INDEX_CONFIG_OVERRIDE_TRACKER__TOKEN=$(cat "./storage/tracker/lib/tracker_api_admin_token.secret") \
105+
TORRUST_INDEX_CONFIG_OVERRIDE_AUTH__SECRET_KEY="MaxVerstappenWC2021" \
106106
cargo run
107107
```
108108

compose.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ services:
99
tty: true
1010
environment:
1111
- USER_ID=${USER_ID}
12-
- TORRUST_INDEX_CONFIG=${TORRUST_INDEX_CONFIG}
12+
- TORRUST_INDEX_CONFIG_TOML=${TORRUST_INDEX_CONFIG_TOML}
1313
- TORRUST_INDEX_DATABASE=${TORRUST_INDEX_DATABASE:-e2e_testing_sqlite3}
1414
- TORRUST_INDEX_DATABASE_DRIVER=${TORRUST_INDEX_DATABASE_DRIVER:-sqlite3}
15-
- TORRUST_INDEX_TRACKER_API_TOKEN=${TORRUST_INDEX_TRACKER_API_TOKEN:-MyAccessToken}
16-
- TORRUST_INDEX_AUTH_SECRET_KEY=${TORRUST_INDEX_AUTH_SECRET_KEY:-MaxVerstappenWC2021}
15+
- TORRUST_INDEX_CONFIG_OVERRIDE_TRACKER__TOKEN=${TORRUST_INDEX_CONFIG_OVERRIDE_TRACKER__TOKEN:-MyAccessToken}
16+
- TORRUST_INDEX_CONFIG_OVERRIDE_AUTH__SECRET_KEY=${TORRUST_INDEX_CONFIG_OVERRIDE_AUTH__SECRET_KEY:-MaxVerstappenWC2021}
1717
networks:
1818
- server_side
1919
ports:
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#!/bin/bash
22

3-
TORRUST_INDEX_CONFIG=$(cat ./share/default/config/index.e2e.container.mysql.toml) \
3+
TORRUST_INDEX_CONFIG_TOML=$(cat ./share/default/config/index.e2e.container.mysql.toml) \
44
TORRUST_TRACKER_CONFIG_TOML=$(cat ./share/default/config/tracker.e2e.container.sqlite3.toml) \
55
docker compose down

contrib/dev-tools/container/e2e/mysql/e2e-env-up.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ TORRUST_INDEX_CONFIG=$(cat ./share/default/config/index.e2e.container.mysql.toml
44
docker compose build
55

66
USER_ID=${USER_ID:-1000} \
7-
TORRUST_INDEX_CONFIG=$(cat ./share/default/config/index.e2e.container.mysql.toml) \
7+
TORRUST_INDEX_CONFIG_TOML=$(cat ./share/default/config/index.e2e.container.mysql.toml) \
88
TORRUST_INDEX_DATABASE="torrust_index_e2e_testing" \
99
TORRUST_INDEX_DATABASE_DRIVER="mysql" \
10-
TORRUST_INDEX_TRACKER_API_TOKEN="MyAccessToken" \
10+
TORRUST_INDEX_CONFIG_OVERRIDE_TRACKER__TOKEN="MyAccessToken" \
1111
TORRUST_INDEX_MYSQL_DATABASE="torrust_index_e2e_testing" \
1212
TORRUST_TRACKER_CONFIG_TOML=$(cat ./share/default/config/tracker.e2e.container.sqlite3.toml) \
1313
TORRUST_TRACKER_DATABASE="e2e_testing_sqlite3" \

contrib/dev-tools/container/e2e/mysql/run-e2e-tests.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ docker ps
4040

4141
# Run E2E tests with shared app instance
4242
TORRUST_INDEX_E2E_SHARED=true \
43-
TORRUST_INDEX_PATH_CONFIG="./share/default/config/index.e2e.container.mysql.toml" \
43+
TORRUST_INDEX_CONFIG_TOML_PATH="./share/default/config/index.e2e.container.mysql.toml" \
4444
TORRUST_INDEX_E2E_DB_CONNECT_URL="mysql://root:root_secret_password@localhost:3306/torrust_index_e2e_testing" \
4545
cargo test ||
4646
{
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#!/bin/bash
22

3-
TORRUST_INDEX_CONFIG=$(cat ./share/default/config/index.e2e.container.sqlite3.toml) \
3+
TORRUST_INDEX_CONFIG_TOML=$(cat ./share/default/config/index.e2e.container.sqlite3.toml) \
44
TORRUST_TRACKER_CONFIG_TOML=$(cat ./share/default/config/tracker.e2e.container.sqlite3.toml) \
55
docker compose down

contrib/dev-tools/container/e2e/sqlite/e2e-env-up.sh

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
#!/bin/bash
22

3-
TORRUST_INDEX_CONFIG=$(cat ./share/default/config/index.e2e.container.sqlite3.toml) \
3+
TORRUST_INDEX_CONFIG_TOML=$(cat ./share/default/config/index.e2e.container.sqlite3.toml) \
44
docker compose build
55

66
USER_ID=${USER_ID:-1000} \
7-
TORRUST_INDEX_CONFIG=$(cat ./share/default/config/index.e2e.container.sqlite3.toml) \
7+
TORRUST_INDEX_CONFIG_TOML=$(cat ./share/default/config/index.e2e.container.sqlite3.toml) \
88
TORRUST_INDEX_DATABASE="e2e_testing_sqlite3" \
99
TORRUST_INDEX_DATABASE_DRIVER="sqlite3" \
10-
TORRUST_INDEX_TRACKER_API_TOKEN="MyAccessToken" \
11-
TORRUST_INDEX_AUTH_SECRET_KEY="MaxVerstappenWC2021" \
10+
TORRUST_INDEX_CONFIG_OVERRIDE_TRACKER__TOKEN="MyAccessToken" \
11+
TORRUST_INDEX_CONFIG_OVERRIDE_AUTH__SECRET_KEY="MaxVerstappenWC2021" \
1212
TORRUST_TRACKER_CONFIG_TOML=$(cat ./share/default/config/tracker.e2e.container.sqlite3.toml) \
1313
TORRUST_TRACKER_DATABASE="e2e_testing_sqlite3" \
1414
TORRUST_TRACKER_CONFIG_OVERRIDE_DB_DRIVER="Sqlite3" \

contrib/dev-tools/container/e2e/sqlite/run-e2e-tests.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ docker ps
3838

3939
# Run E2E tests with shared app instance
4040
TORRUST_INDEX_E2E_SHARED=true \
41-
TORRUST_INDEX_PATH_CONFIG="./share/default/config/index.e2e.container.sqlite3.toml" \
41+
TORRUST_INDEX_CONFIG_TOML_PATH="./share/default/config/index.e2e.container.sqlite3.toml" \
4242
TORRUST_INDEX_E2E_DB_CONNECT_URL="sqlite://./storage/index/lib/database/e2e_testing_sqlite3.db?mode=rwc" \
4343
cargo test ||
4444
{

0 commit comments

Comments
 (0)