Refined instructions for local installation setup #38
Conversation
kdaud
force-pushed
the
BAM
branch
2 times, most recently
from
9904754
to
7c93a63
Compare
kdaud
changed the title
README.md
Outdated
| <p align="center"> | ||
| <img src="./readme/docker-compose-up-shadow.png" alt="docker-compose up" height="200"> | ||
| </p> | ||
|
|
||
| **Important:** This assumes that you run the `docker` command as the same user and in the same window in which you exported your variables. | ||
| If Docker is run as `sudo`, the variables won't have an effect. Make sure to either export them as root, or run `docker` with `sudo -E` option to preserve the user environment. See [Docker on Linux Post-install steps](https://docs.docker.com/engine/install/linux-postinstall/) | ||
| **Important:** This assumes that you run the `docker` command as the same user and in the same window in which you exported your variables. On Linux we advise to run `docker` with `sudo -E` option to preserve the user environment as `su`. See [Docker on Linux Post-install steps](https://docs.docker.com/engine/install/linux-postinstall/) |
There was a problem hiding this comment.
environment as
su
That piece I'm not sure to understand
README.md
Outdated
| <td> | ||
|
|
||
| ```bash | ||
| sudo -E docker compose -p $DISTRO_GROUP up |
There was a problem hiding this comment.
Well... If correctly set up Docker should run without sudo.
In general, we never see instructions run with sudo. That's why the point in the Important section.
Maybe we can create a "Prerequisites" section of the README that tells 1. Which version of Docker to run, 2. That it assumes Docker to be runnable as standard users.
What do you think @kdaud ?
There was a problem hiding this comment.
What do you think @kdaud ?
For normal users on Linux os the last installation step requires to prepend sudo or sudo -E to have a successful run otherwise it throws exceptions of this kind and other permission related logs.
Maybe we can create a "Prerequisites" section of the README that tells 1. Which version of Docker to run, 2. That it assumes Docker to be runnable as standard users.
After testing out different versions of docker, I noticed all docker versions >20.10.12 run well including the latest SNAPSHOT so I would think we should not restrict a particular version for users, may be we can recommend the minimum version to be used.
There was a problem hiding this comment.
For normal users on Linux os the last installation step requires to prepend sudo or sudo -E to have a successful run otherwise it throws exceptions of this kind and other permission related logs.
I don't think that's necessary true.
-
"Normal users" on Linux OS should have followed the complete installation options, which includes adding the current user to a docker group and with sudo access.
-
The first link you paste I think is actually due to an incorrect Docker Compose version. In older versions of Docker Compose, the expected format of the values of some of the keys have changed format (single value VS array for instance)
-
The second link you've shard is actually because running Maven as
sudo(root). Don't know why this person was runnning Maven as sudo...
After testing out different versions of docker, I noticed all docker versions >20.10.12 run well including the latest SNAPSHOT so I would think we should not restrict a particular version for users, may be we can recommend the minimum version to be used.
OK fair enough. I actually had rather in mind to advise the version of Docker Compose, not Docker itself.
That's because of the issue explained above. Plus, in older version you would run docker-compose. In newer version, docker compose
No description provided.