Merged readme, added configuration file instructions

pull/1/head
Piero Toffanin 2016-08-02 11:25:52 -05:00
commit 5843db4ac6
2 zmienionych plików z 37 dodań i 5 usunięć

Wyświetl plik

@ -1,11 +1,15 @@
# Open Source Drone Aerial Imagery Processing
node-OpenDroneMap is a Node.js App and REST API to access [OpenDroneMap](https://github.com/OpenDroneMap/OpenDroneMap)
[http://nodeodm.masseranolabs.com](http://nodeodm.masseranolabs.com)
![Alt text](/screenshots/main.png?raw=true "Node-OpenDroneMap")
## Getting Started
The quickest way is to use [Docker](https://www.docker.com/).
For a quick taste of the application, we have setup a test environment at [http://nodeodm.masseranolabs.com](http://nodeodm.masseranolabs.com). Please note that **this is not a production environment**, and that processing on this server will be slow (you are sharing the server's resources with everyone else in the world).
If you want to do your own imagery processing, we recommend that you setup your own instance via [Docker](https://www.docker.com/).
* From the Docker Quickstart Terminal (Windows / OSX) or from the command line (Linux) type:
```
@ -41,6 +45,32 @@ npm install
node index.js
```
You may need to specify your ODM project path to start the server:
```
node index.js --odm_path /home/username/OpenDroneMap
```
If you want to start node ODM on a different port you can do the following:
```
node index.js --port 8000 --odm_path /home/username/OpenDroneMap
```
For other command line options you can run:
```
node index.js --help
```
You can also specify configuration values via a JSON file:
```
node index.js --config config.default.json
```
Command line arguments always take precedence over the configuration file.
### Run it using PM2
The app can also be run as a background process using the [pm2 process manager](https://github.com/Unitech/pm2), which can also assist you with system startup scripts and process monitoring.
@ -69,12 +99,14 @@ You can find some test drone images from [OpenDroneMap's Test Data Folder](https
## Contributing
Make a pull request for small contributions. For big contributions, please open a discussion first.
Make a pull request to the dev branch for small contributions. For big contributions, please open a discussion first. Please use ES6 syntax while writing new Javascript code so that we can keep the code base uniform.
## Roadmap
- [ ] Command line options for OpenDroneMap (in progress)
- [ ] Cluster tasks distribution to multiple servers
- [X] Command line options for OpenDroneMap
- [X] GPC List support
- [ ] Autoremove Abandoned Tasks
- [ ] Continuous Integration Setup
- [ ] Documentation
- [ ] Unit Testing

Wyświetl plik

@ -43,7 +43,7 @@
<label for="taskName">Project Name:</lable> <input type="text" class="form-control" value="" id="taskName" />
</div>
<div class="form-group">
<label for="images">Aerial Imageries and GCP List (optional):</label> <input id="images" name="images" multiple type="file">
<label for="images">Aerial Images and GCP List (optional):</label> <input id="images" name="images" multiple type="file">
<div id="errorBlock" class="help-block"></div>
</div>
<div class="text-right"><input type="submit" class="btn btn-success" value="Start Task" id="btnUpload" /></div>