Skip to content
This repository was archived by the owner on Oct 12, 2020. It is now read-only.

Commit

Permalink
Improve the docker command in README
Browse files Browse the repository at this point in the history
* No need to run the pull command first, as the run command will take care of this -> decrease number of commands to run by 50% :p 
* Use `--rm` flag to remove the container after use
* Make the command slightly shorter
* Use bash syntax coloration
  • Loading branch information
NicolasCARPi authored and Ullaakut committed Jul 19, 2019
1 parent ddf08ee commit 8fda372
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,11 @@ In order to use Astronomer, you'll need a GitHub token with `repo` read rights.

### Docker image

Run `docker pull ullaakut/astronomer`.
Run the astronomer docker image like such:

Then, use the astronomer docker image like such: `docker run -t -e GITHUB_TOKEN=$GITHUB_TOKEN -v "/path/to/your/cache/folder:/data/" ullaakut/astronomer repositoryOwner/repositoryName`
~~~bash
docker run --rm -t -e GITHUB_TOKEN=$TOKEN -v "/path/to/cache:/data" ullaakut/astronomer repositoryOwner/repositoryName
~~~

* The `-t` flag allows you to get a colored output. You can remove it from the command line if you don't care about this.
* The `-e GITHUB_TOKEN=<your_token>` option is mandatory. The GitHub API won't authorize any requests without it.
Expand Down

0 comments on commit 8fda372

Please sign in to comment.