-
Notifications
You must be signed in to change notification settings - Fork 52
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update readme for readability, and extra help
- Loading branch information
1 parent
f6af6da
commit a34c50e
Showing
1 changed file
with
8 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,14 +5,19 @@ The Cube in a Box is a simple way to run the [Open Data Cube](https://www.openda | |
## How to use: | ||
|
||
### 1. Setup: | ||
_First time users of Docker should run:_ | ||
|
||
**Checkout the Repo:** | ||
> `git clone https://github.com/opendatacube/cube-in-a-box.git` or `git clone [email protected]:opendatacube/cube-in-a-box.git` | ||
**First time users of Docker should run:** | ||
* `bash setup.sh` - This will get your system running and install everything you need. | ||
* Note that after this step you will either need to logout/login, or run the next step with `sudo` | ||
|
||
*If you already have `make` , `docker` and `docker-compose` installed* | ||
**If you already have `make` , `docker` and `docker-compose` installed. For a custom bounding box append `BBOX=<left>,<bottom>,<right>,<top>` to the end of the command.** | ||
* `make setup` or `make setup-prod` (for speed) | ||
* Custom bounding box: `make setup BBOX=-2,37,15,47` or `make setup-prod BBOX=-2,37,15,47` | ||
|
||
*If you do not have `make` installed and would rather run the commands individually run the following:* | ||
**If you do not have `make` installed and would rather run the commands individually run the following:** | ||
|
||
* Build a local environment: `docker-compose build` | ||
* Start a local environment: `docker-compose up` | ||
|