Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ErisMik committed Sep 29, 2020
1 parent 574a532 commit db1237b
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,15 @@ docker pull ubcuas/uasitl:latest
The image can also be built locally:
```
./configure.sh
docker build --tag ubcuas/uasitl:latest x86/
docker build --tag ubcuas/uasitl:latest uasitl/
```
The image can be built using a custom `Ardupilot` repository:
```
./configure.sh
[email protected]:ubcuas/accupilot.git docker build --build-arg SSH_PRIVATE_KEY="$SSH_PRIVATE_KEY" --tag ubcuas/uasitl:accupilot x86/
[email protected]:ubcuas/accupilot.git docker build --build-arg SSH_PRIVATE_KEY="$SSH_PRIVATE_KEY" --tag ubcuas/uasitl:accupilot uasitl/
```
Please note the bash variable `$SSH_PRIVATE_KEY` needs to be a valid ssh private key. If you are building on command line you can do this in one shot like so: `--build-arg SSH_PRIVATE_KEY="$(cat ~/.ssh/id_rsa)"`.
`ARDUPILOT_REPO` is an ssh git url to an ardupilot repository.
**WARNING: Building locally bakes your private SSH key into the docker image, do NOT share this image with others.**

## Usage
To launch a single ArduCopter SITL on host TCP port 5760:
Expand All @@ -35,7 +34,7 @@ docker run --rm -p 5760-5780:5760-5780 -it ubcuas/uasitl:latest
```
To start 3 ArduCopter SITLs on host TCP ports 5760, 5770 and 5780:
```
docker run --rm -p 5760-5780:5760-5780 --env NUMCOPTERS=3 -it uasitl
docker run --rm -p 5760-5780:5760-5780 --env NUMCOPTERS=3 -it ubcuas/uasitl:latest
```

## Troubleshooting
Expand Down

0 comments on commit db1237b

Please sign in to comment.