Skip to content

Commit 328e71c

Browse files
Add persistantDockerImages mention to server doc (cyberbotics#5818)
In PR cyberbotics/webots-server#15 we added a `persistantDockerImages` list that protects the Docker images in it from being removed by the garbage collection after a simulation ends. In this PR I added this mechanism to Webots' documentation
1 parent ddc302d commit 328e71c

1 file changed

Lines changed: 17 additions & 16 deletions

File tree

docs/guide/simulation-server.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,23 @@ The simulation server creates and starts a Webots instance with the desired simu
1212

1313
These are the configuration parameters for the simulation server:
1414
```
15-
# server: fully qualilified domain name of simulation server
16-
# ssl: for https/wss URL (true by default)
17-
# port: local port on which the server is listening
18-
# portRewrite: port rewritten in the URL by apache (true by default)
19-
# docker: launch webots inside a docker (false by default)
20-
# allowedRepositories: list of allowed GitHub simulation repositories
21-
# blockedRepositories: list of blocked GitHub simulation repositories
22-
# shareIdleTime: maximum load for running non-allowed repositories (50% by default)
23-
# notify: webservices to be notified about the server status (https://webots.cloud by default)
24-
# projectsDir: directory in which projects are located
25-
# webotsHome: directory in which Webots is installed (WEBOTS_HOME)
26-
# maxConnections: maximum number of simultaneous Webots instances
27-
# logDir: directory where the log files are written
28-
# monitorLogEnabled: store monitor data in a file (true by default)
29-
# debug: output debug information to stdout (false by default)
30-
# timeout: number of seconds after which a simulation is automatically closed (two hours by default, minimum six minutes)
15+
# server: fully qualilified domain name of simulation server
16+
# ssl: for https/wss URL (true by default)
17+
# port: local port on which the server is listening
18+
# portRewrite: port rewritten in the URL by apache (true by default)
19+
# docker: launch webots inside a docker (false by default)
20+
# allowedRepositories: list of allowed GitHub simulation repositories
21+
# blockedRepositories: list of blocked GitHub simulation repositories
22+
# persistantDockerImages: list of Docker images that shouldn't be removed from the cache
23+
# shareIdleTime: maximum load for running non-allowed repositories (50% by default)
24+
# notify: webservices to be notified about the server status (https://webots.cloud by default)
25+
# projectsDir: directory in which projects are located
26+
# webotsHome: directory in which Webots is installed (WEBOTS_HOME)
27+
# maxConnections: maximum number of simultaneous Webots instances
28+
# logDir: directory where the log files are written
29+
# monitorLogEnabled: store monitor data in a file (true by default)
30+
# debug: output debug information to stdout (false by default)
31+
# timeout: number of seconds after which a simulation is automatically closed (two hours by default, minimum six minutes)
3132
```
3233

3334
HTTP request handlers:

0 commit comments

Comments
 (0)