GitHub - OpenDroneMap - WebODM - User-Friendly, Commercial-Grade Software For Processing Aerial Imagery. ?
GitHub - OpenDroneMap - WebODM - User-Friendly, Commercial-Grade Software For Processing Aerial Imagery. ?
GitHub - OpenDroneMap - WebODM - User-Friendly, Commercial-Grade Software For Processing Aerial Imagery. ?
🛩
OpenDroneMap / WebODM Public
AGPL-3.0 license
Star Notifications
pierotofy Merge pull request #1561 from pierotofy/bigfix eaf0db9 · 3 weeks ago
https://github.com/OpenDroneMap/WebODM 1/14
20/10/24, 12:28 GitHub - OpenDroneMap/WebODM: User-friendly, commercial-grade software for processing aerial imagery. 🛩
README.md Update README.md 3 weeks ago
docker-compose.dev.yml Expose livereload port in dev mode, auto incl… 5 years ago
https://github.com/OpenDroneMap/WebODM 2/14
20/10/24, 12:28 GitHub - OpenDroneMap/WebODM: User-friendly, commercial-grade software for processing aerial imagery. 🛩
Getting Started
Recommended Machine Specs
Manual installation (Docker)
Requirements
Installation with Docker
Manage Processing Nodes
Enable MicMac
Enable SSL
Where Are My Files Stored?
https://github.com/OpenDroneMap/WebODM 3/14
20/10/24, 12:28 GitHub - OpenDroneMap/WebODM: User-friendly, commercial-grade software for processing aerial imagery. 🛩
Common Troubleshooting
Images Missing from Lightning Assets
Backup and Restore
Reset Password
Manage Plugins
Update
Run the docker version as a Linux Service
Run it natively
Run it on the cloud (Google Compute, Amazon AWS)
Customizing and Extending
API Docs
Roadmap
Getting Help
Support the Project
Translations
Become a Contributor
Architecture Overview
License
Trademark
https://github.com/OpenDroneMap/WebODM 4/14
20/10/24, 12:28 GitHub - OpenDroneMap/WebODM: User-friendly, commercial-grade software for processing aerial imagery. 🛩
Getting Started
Windows and macOS users can purchase an automated installer, which makes the installation process easier.
To run a standalone installation of WebODM (the user interface), including the processing component (NodeODM), we recommend at
a minimum:
WebODM runs best on Linux, but works well on Windows and Mac too. If you are technically inclined, you can get WebODM to run
natively on all three platforms.
WebODM by itself is just a user interface (see below) and does not require many resources. WebODM can be loaded on a machine with
just 1 or 2 GB of RAM and work fine without NodeODM. You can then use a processing service such as the lightning network or run
NodeODM on a separate, more powerful machine.
Requirements
Git
Docker
Docker-compose
Python
Pip
https://github.com/OpenDroneMap/WebODM 5/14
20/10/24, 12:28 GitHub - OpenDroneMap/WebODM: User-friendly, commercial-grade software for processing aerial imagery. 🛩
i. make sure Linux containers are enabled (Switch to Linux Containers...)
ii. give Docker enough CPUs (default 2) and RAM (>4Gb, 16Gb better but leave some for Windows) by going to Settings --
Advanced
iii. select where on your hard drive you want virtual hard drives to reside (Settings -- Advanced -- Images & Volumes).
iv. If you want to run the processing component (NodeODM) with GPU acceleration, install WSL and set up GPU acceleration. It's
supported on Windows 11 or Windows 10, version 21H2 or higher.
If you face any issues at the last step on Linux, make sure your user is part of the docker group:
Open a Web Browser to http://localhost:8000 (unless you are on Windows using Docker Toolbox, see below)
Docker Toolbox users need to find the IP of their docker machine by running this command from the Docker Quickstart Terminal:
docker-machine ip
192.168.1.100 (your output will be different)
./webodm.sh stop
./webodm.sh update
Adding more processing nodes will allow you to run multiple jobs in parallel.
You can also setup a ClusterODM node to run a single task across multiple machines with distributed split-merge and process dozen of
thousands of images more quickly, with less memory.
If you don't need the default "node-odm-1" node, simply pass --default-nodes 0 flag when starting WebODM:
Then from the web interface simply manually remove the "node-odm-1" node.
Enable MicMac
WebODM can use MicMac as a processing engine via NodeMICMAC. To add MicMac, simply run:
This will create a "node-micmac-1" processing node on the same machine running WebODM. Please note that NodeMICMAC is in
active development and is currently experimental. If you find issues, please report them on the NodeMICMAC repository.
https://github.com/OpenDroneMap/WebODM 6/14
20/10/24, 12:28 GitHub - OpenDroneMap/WebODM: User-friendly, commercial-grade software for processing aerial imagery. 🛩
Enable SSL
WebODM has the ability to automatically request and install a SSL certificate via Let’s Encrypt, or you can manually specify your own
key/certificate pair.
If you want to specify your own key/certificate pair, simply pass the --ssl-key and --ssl-cert option to ./webodm.sh . See
./webodm.sh --help for more information.
Note! You cannot pass an IP address to the hostname parameter! You need a DNS record setup.
1. Media (called webodm_appmedia): This is where all files related to a project and task are stored.
2. Postgres DB (called webodm_dbdata): This is what Postgres database uses to store its data.
For more information on how these two volumes are used and in which containers, please refer to the docker-compose.yml file.
For various reasons such as ease of backup/restore, if you want to store your files on the host filesystem instead of a docker volume,
you need to pass a path via the --media-dir and/or the --db-dir options:
Note that existing task results will not be available after the change. Refer to the Migrate Data Volumes section of the Docker
documentation for information on migrating existing task results.
Common Troubleshooting
Make sure that your Docker environment has enough RAM allocated: MacOS
Run out of memory
Instructions, Windows Instructions
Getting a No space left on device error, but Docker on Windows by default will allocate only 20GB of space to the default
hard drive has enough space left docker-machine. You need to increase that amount. See this link and this link
Cannot start WebODM via ./webodm.sh You could be running out of memory. Make sure you have enough RAM
start , error messages are different at each available. 2GB should be the recommended minimum, unless you know what
retry you are doing
While running WebODM with Docker Toolbox As Administrator, run cmd.exe and then type "C:\Program
(VirtualBox) you cannot access WebODM from Files\Oracle\VirtualBox\VBoxManage.exe" controlvm "default" natpf1 "rule-
another computer in the same network. name,tcp,,8000,,8000"
On Windows, the storage space shown on the From Hyper-V Manager, right-click “DockerDesktopVM”, go to Edit Disk, then
WebODM diagnostic page is not the same as choose to expand the disk and match the maximum size to the settings specified
what is actually set in Docker's settings. in the docker settings. Upon making the changes, restart docker.
https://github.com/OpenDroneMap/WebODM 7/14
20/10/24, 12:28 GitHub - OpenDroneMap/WebODM: User-friendly, commercial-grade software for processing aerial imagery. 🛩
Symptoms Possible Solutions
When you use Lightning to process your task, you will need to download all assets to your local instance of WebODM. The all assets zip
does not contain the images which were used to create the orthomosaic. This means that, although you can visualise the cameras
layer in your local WebODM, when you click on a particular camera icon the image will not be shown.
The fix if you are using WebODM with Docker is as follows (instructions are for MacOS host):
1. Ensure that you have a directory which contains all of the images for the task and only the images;
2. Open Docker Desktop and navigate to Containers. Identify your WebODM instance and navigate to the container that is named
worker . You will need the Container ID. This is a hash which is listed under the container name. Click to copy the Container ID
using the copy icon next to it.
3. Open Terminal and enter docker cp <sourcedirectory>/.
<dockercontainerID>:/webodm/app/media/project/<projectID>/task/<taskID> . Paste the Container ID to replace the location titled
<dockercontainerID> . Enter the full directory path for your images to replace <sourcedirectory> ;
4. Go back to Docker Desktop and navigate to Volumes in the side bar. Click on the volume called webodm_appmedia , click on
project , identify the correct project and click on it, click on task and identify the correct task.
5. From Docker Desktop substitute the correct <projectID> and <taskID> into the command in Terminal;
6. Execute the newly edited command in Terminal. You will see a series of progress messages and your images will be copied to
Docker;
7. Navigate to your project in your local instance of WebODM;
8. Open the Map and turn on the Cameras layer (top left);
9. Click on a Camera icon and the relevant image will be shown
Have you had other issues? Please report them so that we can include them in this document.
mkdir -v backup
docker run --rm --volume webodm_dbdata:/temp --volume `pwd`/backup:/backup ubuntu tar cvf /backup/dbdata.tar /temp
docker run --rm --volume webodm_appmedia:/temp --volume `pwd`/backup:/backup ubuntu tar cvf /backup/appmedia.tar /tem
Your backup files will be stored in the newly created backup directory. Transfer the backup directory to the new system, then on the
new system:
In case when recovery .tar is missed, or corrupted you can conduct Hard Recovery
Reset Password
If you forgot the password you picked the first time you logged into WebODM, to reset it just type:
The password will be reset to newpass . The command will also tell you what username you chose.
Manage Plugins
https://github.com/OpenDroneMap/WebODM 8/14
20/10/24, 12:28 GitHub - OpenDroneMap/WebODM: User-friendly, commercial-grade software for processing aerial imagery. 🛩
Plugins can be enabled and disabled from the user interface. Simply go to Administration -- Plugins.
Update
If you use docker, updating is as simple as running:
./webodm.sh update
cd /webodm
sudo su odm # Only in case you are running WebODM with a different user
git pull origin master
source python3-venv/bin/activate # If you are running a virtualenv
npm install
pip install -r requirements.txt
webpack --mode production
python manage.py collectstatic --noinput
python manage.py migrate
If you wish to run the docker version with auto start/monitoring/stop, etc, as a systemd style Linux Service, a systemd unit file is
included in the service folder of the repo.
This should work on any Linux OS capable of running WebODM, and using a SystemD based service daemon (such as Ubuntu 16.04
server for example).
This has only been tested on Ubuntu 16.04 server and Red Hat Enterprise Linux 9.
If all pre-requisites have been met, and repository is checked out/cloned to /opt/WebODM folder, then you can use the following steps
to enable and manage the service:
First, to install the service, and enable the services to run at startup from now on:
For the adventurous, the repository can be put anyplace you like by editing the ./WebODM/service/webodm-docker.service file before
enabling the service the reflect your repository location, and modifying the systemctl enable command to that directiory.
Run it natively
WebODM can run natively on Windows, MacOS and Linux. We don't recommend to run WebODM natively (using docker is easier), but
it's possible.
Ubuntu 16.04 LTS users can refer to this community script to install WebODM natively on a new machine.
https://github.com/OpenDroneMap/WebODM 9/14
20/10/24, 12:28 GitHub - OpenDroneMap/WebODM: User-friendly, commercial-grade software for processing aerial imagery. 🛩
To run WebODM, you will need to install:
On Windows use the OSGeo4W installer to install GDAL. MacOS users can use:
DATABASES = {
'default': {
'ENGINE': 'django.contrib.gis.db.backends.postgis',
'NAME': 'webodm_dev',
'USER': 'postgres',
'PASSWORD': 'postgres',
'HOST': 'localhost',
'PORT': '5432',
}
}
From psql or pgadmin, connect to PostgreSQL, create a new database (name it webodm_dev ), connect to it and set the
postgis.enable_outdb_rasters and postgis.gdal_enabled_drivers settings:
redis-server
Then:
./worker.sh start
The start.sh script will use Django's built-in server if you pass the --no-gunicorn parameter. This is good for testing, but bad for
production.
https://github.com/OpenDroneMap/WebODM 10/14
20/10/24, 12:28 GitHub - OpenDroneMap/WebODM: User-friendly, commercial-grade software for processing aerial imagery. 🛩
In production, if you have nginx installed, modify the configuration file in nginx/nginx.conf to match your system's configuration and
just run start.sh without parameters.
Windows users should refer to this guide to install Apache + mod_wsgi and run gunicorn:
If you are getting a rt_raster_gdal_warp: Could not create GDAL transformation object for output dataset creation , make sure
that your PostGIS installation has PROJ support:
SELECT PostGIS_Full_Version();
You may also need to set the environment variable PROJSO to the .so or .dll projection library your PostGIS is using. This just needs to
have the name of the file. So for example on Windows, you would in Control Panel -> System -> Environment Variables add a system
variable called PROJSO and set it to libproj.dll (if you are using proj 4.6.1). You'll have to restart your PostgreSQL service/daemon after
this change. http://postgis.net/docs/manual-2.0/RT_ST_Transform.html
If you are using Windows and are unable to go past the pip install -r requirements.txt command because of an error regarding
zlib and Pillow, manually edit the requirements.txt file, remove the Pillow requirement and run:
easy_install pillow
pip install -r requirements.txt
On Windows make sure that all of your PATH environment variables are set properly. These commands:
python --version
pip --version
npm --version
gdalinfo --version
redis-server --version
These steps are for Google Cloud, but can also be used for Amazon AWS, and other cloud platforms with small modifications:
To setup the firewall on Google Cloud, open the instance, on the middle of the instance settings page find NIC0. Open it, and then add
the TCP Port 8000 for ingress, and egress on the Firewall.
https://github.com/OpenDroneMap/WebODM 11/14
20/10/24, 12:28 GitHub - OpenDroneMap/WebODM: User-friendly, commercial-grade software for processing aerial imagery. 🛩
More advanced customizations can be achieved by writing plugins. This is the preferred way to add new functionality to WebODM
since it requires less effort than maintaining a separate fork. The plugin system features server-side signals that can be used to be
notified of various events, a ES6/React build system, a dynamic client-side API for adding elements to the UI, a built-in data store, an
async task runner, a GRASS engine, hooks to add menu items and functions to rapidly inject CSS, Javascript and Django views.
For plugins, the best source of documentation currently is to look at existing code. If a particular hook / entrypoint for your plugin
does not yet exist, request it. We are adding hooks and entrypoints as we go.
To create a plugin simply copy the plugins/test plugin into a new directory (for example, plugins/myplugin ), then modify
manifest.json , plugin.py and issue a ./webodm.sh restart .
API Docs
See the API documentation page.
Roadmap
We follow a bottom-up approach to decide what new features are added to WebODM. User feedback guides us in the decision making
process and we collect such feedback via improvement requests.
Don't see a feature that you want? Open a feature request or help us build it.
Sometimes we also prioritize work that has received financial backing. If your organization is in the position to financially support the
development of a particular feature, get in touch and we'll make it happen.
Getting Help
We have several channels of communication for people to ask questions and to get involved with the community:
Help us test new and existing features and report bugs and feedback.
Share your aerial datasets.
Help answer questions on the community forum and chat.
⭐️ us on GitHub.
Help us translate WebODM in your language.
Help us classify point cloud datasets.
Spread the word about WebODM and OpenDroneMap on social media.
While we don't accept donations, you can purchase an installer, a book or a sponsor package.
You can pledge funds for getting new features built and bug fixed.
Become a contributor 🤘
Translations
It's easy to translate WebODM in a different language!
If you want to preview your translation work, start WebODM in developer mode:
https://github.com/OpenDroneMap/WebODM 12/14
20/10/24, 12:28 GitHub - OpenDroneMap/WebODM: User-friendly, commercial-grade software for processing aerial imagery. 🛩
Then edit the LOCALES file to include your translation locale code. Finally, visit the Developer Tools panel from WebODM's dashboard
and press the Download and Replace Translation Files button:
The latest translation files from weblate.org will be downloaded and applied to the installation of WebODM.
Become a Contributor
The easiest way to get started is to take a look at our list of outstanding issues and pick one. You can also fix/improve something
entirely new based on your experience with WebODM. All ideas are considered and people of all skill levels are welcome to contribute.
You don't necessarily need to be a developer to become a contributor. We can use your help to write better documentation and
improve the user interface texts and visuals.
If you know how to code, we primarily use Python (Django), Javascript (React), HTML and SCSS. See the Development Quickstart and
Contributing documents for more information.
To make a contribution, you will need to open a pull request (here's how). To make changes to WebODM, make a clone of the
repository and run ./webodm.sh start --dev .
If you have questions visit us on the forum and we'll be happy to help you out with your first contribution.
Architecture Overview
The OpenDroneMap project is composed of several components.
ODM is a command line toolkit that processes aerial images. Users comfortable with the command line are probably OK using this
component alone.
NodeODM is a lightweight interface and API (Application Program Interface) built directly on top of ODM. Users not comfortable
with the command line can use this interface to process aerial images and developers can use the API to build applications.
Features such as user authentication, map displays, etc. are not provided.
WebODM adds more features such as user authentication, map displays, 3D displays, a higher level API and the ability to
orchestrate multiple processing nodes (run jobs in parallel). Processing nodes are simply servers running NodeODM.
https://github.com/OpenDroneMap/WebODM 13/14
20/10/24, 12:28 GitHub - OpenDroneMap/WebODM: User-friendly, commercial-grade software for processing aerial imagery. 🛩
WebODM is built with scalability and performance in mind. While the default setup places all databases and applications on the same
machine, users can separate its components for increased performance (ex. place a Celery worker on a separate machine for running
background tasks).
Releases 37
2.5.5 Latest
on Aug 20
+ 36 releases
https://webodm.net
https://odmbook.com
Packages
No packages published
Contributors 90
+ 76 contributors
Languages
JavaScript 46.8% Python 35.7% HTML 7.4% SCSS 5.0% Shell 2.9% CSS 1.7% Other 0.5%
https://github.com/OpenDroneMap/WebODM 14/14