Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Linux/Mac

docker run --rm --name cm-shell --volume /tmp/dumps:/work:z --env -file /home/user/.cleverMaps/credentials CM_ACCESS_TOKEN=8HZP...WE -ti clevermaps/shell:latest

Windows

docker run --rm --name cm-shell --volume C:\dumps:/work:z --env -file C:\Users\user\.cleverMaps\credentials CM_ACCESS_TOKEN=8HZP...WE -ti clevermaps/shell:latest

...

  • --rm tells Docker to not persist the container for later use
  • --name specifies the name of the container
  • --volume bind mounts a volume, where /tmp/dumps is the local directory the image will use, and /work is the path inside of the container
    • all dumped metadata and data will be located here (though Shell will indicate that the files were dumped to the /work directory)
    • you can specify whatever path you want, e.g.: C:\dumps on Windows
  • --env-file specifies the path to an environment variables filein our case this is the credentials file with your email and password we've created in the Configuration section aboveenvironment variables with credentials. Docker image accepts following environment variables:
    • CM_ACCESS_TOKEN - user access token for authentification
    • AWS_ACCESS_KEY_ID - AWS access key (required only for loading CSV files from AWS S3)
    • AWS_SECRET_ACCESS_KEY - AWS secret key (required only for loading CSV files from AWS S3)
  • -ti allocates a terminal so you can directly interact with the container, and also keeps the standard input open
  • clevermaps/shell:latest is the name of the latest image

...