Skip to content

Commit ce0a093

Browse files
committed
doc: report script changes to readmes
Signed-off-by: Pierre-Etienne Bougué <bougue.pe@proton.me>
1 parent 488354a commit ce0a093

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ docker compose up -d --build
4949
xdg-open http://localhost:4000/
5050
```
5151

52-
(Linux or WSL users can use `scripts/host-compose.sh` instead of `docker compose` to enable host networking - useful to launch services in a debugger)
52+
(Linux or WSL users can use `./osrd-compose host` instead of `docker compose` to enable host networking - useful to launch services in a debugger)
5353

5454
## Deployment
5555

core/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -97,22 +97,22 @@ Using a specific script (just through `docker compose` CLI and a set of docker-c
9797
allows to run a single core worker for all infra on localhost network:
9898

9999
```sh
100-
./scripts/single-worker-compose.sh up -d
100+
./osrd-compose host sw up -d
101101

102102
# or exclude 'core' service straight away:
103-
./scripts/single-worker-compose.sh up -d --scale core=0
103+
./osrd-compose host sw up -d --scale core=0
104104
```
105105

106106
Then, it is easy to replace the desired component for debug purpose. \
107107
For core:
108108

109109
```sh
110-
./scripts/single-worker-compose.sh down core # if 'core' is running
110+
./osrd-compose host sw down core # if 'core' is running
111111
./gradlew shadowJar && ALL_INFRA=true java -jar -ea -Xmx12g -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=dump.hprof build/libs/osrd-all.jar worker --editoast-url http://localhost:8090/
112112
```
113113

114114
Clean or restart the whole stack can be necessary sometimes and is also available
115115
through docker compose CLI (the following wipes the database too):
116116
```sh
117-
./scripts/single-worker-compose.sh down -v
117+
./osrd-compose host sw down -v
118118
```

front/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ as `npm run e2e-tests` or `npx playwright test`.
5858
>
5959
> - Run all the components locally (you might keep Postgres and Valkey in containers)
6060
> - If on Linux, you can also launch all the containers on the host network: you can replace the
61-
> `docker compose <something>` above with `osrd/scripts/host-compose.sh <something>`
61+
> `docker compose <something>` above with `osrd/osrd-compose host <something>`
6262
6363
If the tests fail, a `front/test-results` folder will be created, containing videos and traces of
6464
the failed test executions. These files can help you understand what went wrong. Additionally, the

gateway/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This component is built around 3 crates:
1818
## Config
1919

2020
The gateway reads `gateway.toml` in its current working directory.
21-
Please refer to `gateway.prod.sample.toml` for a relevant example.
21+
Please refer to `gateway.bundled.toml` for a relevant example.
2222

2323
```toml
2424
# Address on which the gateway will listen

0 commit comments

Comments
 (0)