Versions Compared

Key

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

...

Linux/Mac

docker run --rm --name cm-shell shell --pull always --volume /tmp/dumps:/work:z --env CM_ACCESS_TOKEN=8HZP...WE -ti clevermaps/shell:latest

Windows

docker run --rm --name cm-shell -shell -pull always --volume C:\dumps:/work:z --env 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
  • --pull a newest version of image if available
  • --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 specifies the environment 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

...

Info
titleInfo for Linux/Mac OS

Depending on your Docker system configuration, you may be required to preface the docker run command with sudo.

In that case, all files saved to the directory you specified in --volume have to be edited by the root user. Make sure you run your text editor under root user as well, or change the dump directory file permissions accordingly, e.g.: by using sudo chmod -R 777 /tmp/dumps/.

If you've already pulled the image and Shell tells you that you're using an old version during startup, update it by using:

...


Usage tips

Shell Docker images are hosted in this DockerHub repository.

...