Skip to content

Commit

Permalink
add information about user setup to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lreiher committed Jul 5, 2024
1 parent 8f2a004 commit f163309
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@
- [Extra System Dependencies (*pip*)](#extra-system-dependencies-pip)
- [Custom Installation Script](#custom-installation-script)
- [Extra Image Files](#extra-image-files)
- [Additional Information](#additional-information)
- [User Setup](#user-setup)
- [Configuration Variables](#configuration-variables)

We recommend to use *docker-ros* in combination with our other tools for Docker and ROS.
Expand Down Expand Up @@ -332,6 +334,19 @@ If you need to have additional files present in the deployment image, you can us
Create a folder `additional-files` in your `docker` folder (or configure a different `ADDITIONAL_FILES_DIR`) and place any files or directories in it. The contents will be copied to `/docker-ros/additional-files` in the image.
## Additional Information
### User Setup
Containers of the provided images start with `root` user by default. If the two environment variables `DOCKER_UID` and `DOCKER_GID` are passed, a new user with the corresponding UID/GID is created on the fly. Most importantly, this features allows to mount and edit files of the host user in the container without having to deal with permission issues.
```bash
docker run --rm -it -e DOCKER_UID=$(id -u) -e DOCKER_GID=$(id -g) -e DOCKER_USER=$(id -un) rwthika/ros:latest
```
The password of the custom user is set to its username (`dockeruser:dockeruser` by default).
## Configuration Variables
> **Note**
Expand Down

0 comments on commit f163309

Please sign in to comment.