Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve doc for CLI project creation: with Docker, we need a "volume" to add local files to project input files #362

Closed
pombredanne opened this issue Nov 22, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@pombredanne
Copy link
Contributor

The doc recommends using Docker for installation, but all the CLI examples assume that the runs are not done with a Docker installation.

  1. we should separate non-Docker, debug and development-style CLI runs from the regular production CLI runs where the installation was done with Docker
  2. in order to add local input files to a project using the CLI, extra arguments needs to be passed to docker-compose

For instance with --volume /absolute/source/path/on/host:/absolute/target/path/in/container:ro this mounts and makes available /absolute/source/path/on/host on host to the /absolute/target/path/in/container path inside the container (and :ro means read only)

For instance a full command to create a project with my local file at /home/foo/code/image.tar could be:

$ docker-compose run \
    --volume /home/foo/code:/foo:ro web \
    ./manage.py create-project my-project \
    --pipeline docker \
    --input-file="/foo/image.tar" 
@pombredanne pombredanne added the documentation Improvements or additions to documentation label Nov 22, 2021
tdruez added a commit that referenced this issue Dec 14, 2021
@tdruez
Copy link
Contributor

tdruez commented Mar 3, 2023

The docs were improved. The rewriting of the tutorials base don Docker is happening in #440

@tdruez tdruez closed this as completed Mar 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants