bash git clone https://github.com/OpenDroneMap/WebODM --config core.autocrlf=input --depth 1 cd WebODM ./webodm.sh start bash sudo usermod -aG docker $USER exit (restart shell by logging out and then back-in) ./webodm.sh start 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)
The address to connect to would then be: http://192.168.1.100:8000.
To stop WebODM press CTRL+C or run:
./webodm.sh stop
To update WebODM to the latest version use:
./webodm.sh update
./webodm.sh restart --ssl --hostname webodm.myorg.com
That's it! The certificate will automatically renew when needed.
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.
When using Docker, all processing results are stored in a docker volume and are not available on the host filesystem. There are two specific docker volumes of interest:
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:
./webodm.sh restart --media-dir /home/user/webodm_data --db-dir /home/user/webodm_db
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.
| Symptoms | Possible Solutions |
|---|---|
| Run out of memory | Make sure that your Docker environment has enough RAM allocated: MacOS Instructions, Windows Instructions |
While starting WebODM you get: 'WaitNamedPipe','The system cannot find the file specified.' |
1. Make sure you have enabled VT-x virtualization in the BIOS. 2. Try to downgrade your version of Python to 2.7 |
On Windows, docker-compose fails with Failed to execute the script docker-compose |
Make sure you have enabled VT-x virtualization in the BIOS |
| Cannot access WebODM using Microsoft Edge on Windows 10 | Try to tweak your internet properties according to these instructions |
Getting a No space left on device error, but hard drive has enough space left |
Docker on Windows by default will allocate only 20GB of space to the default docker-machine. You need to increase that amount. See this link and this link |
Cannot start WebODM via ./webodm.sh start, error messages are different at each retry |
You could be running out of memory. Make sure you have enough RAM available. 2GB should be the recommended minimum, unless you know what you are doing |
| While running WebODM with Docker Toolbox (VirtualBox) you cannot access WebODM from another computer in the same network. | As Administrator, run cmd.exe and then type "C:\Program Files\Oracle\VirtualBox\VBoxManage.exe" controlvm "default" natpf1 "rule-name,tcp,,8000,,8000" |
| On Windows, the storage space shown on the WebODM diagnostic page is not the same as what is actually set in Docker's settings. | From Hyper-V Manager, right-click “DockerDesktopVM”, go to Edit Disk, then choose to expand the disk and match the maximum size to the settings specified in the docker settings. Upon making the changes, restart docker. |
On Linux or WSL, Warning: GPU use was requested, but no GPU has been found |
Run nvidia-smi (natively) or docker run --rm --gpus all nvidia/cuda:11.2.2-devel-ubuntu20.04 nvidia-smi (docker) to check with NVIDIA driver and NVIDIA Container Toolkit. |
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):
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.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>;webodm_appmedia, click on project, identify the correct project and click on it, click on task and identify the correct task.<projectID> and <taskID> into the command in Terminal;Have you had other issues? Please report them so that we can include them in this document.
If you want to move WebODM to another system, you just need to transfer the docker volumes (unless you are storing your files on the file system).
On the old system:
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 /temp
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:
ls backup # --> appmedia.tar dbdata.tar
./webodm.sh down # Make sure WebODM is down
docker run --rm --volume webodm_dbdata:/temp --volume `pwd`/backup:/backup ubuntu bash -c "rm -fr /temp/* && tar xvf /backup/dbdata.tar"
docker run --rm --volume webodm_appmedia:/temp --volume `pwd`/backup:/backup ubuntu bash -c "rm -fr /temp/* && tar xvf /backup/appmedia.tar"
./webodm.sh start
In case when recovery .tar is missed, or corrupted you can conduct Hard Recovery
If you forgot the password you picked the first time you logged into WebODM, to reset it just type:
./webodm.sh start && ./webodm.sh resetadminpassword newpass
The password will be reset to newpass. The command will also tell you what username you chose.
Plugins can be enabled and disabled from the user interface. Simply go to Administration -- Plugins.
If you use docker, updating is as simple as running:
./webodm.sh update
If you are running WebODM natively, these commands should do it:
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.
The following pre-requisites are required:
* Requires odm user
* Requires docker installed via system (ubuntu: sudo apt-get install docker.io)
* Requires 'screen' package to be installed
* Requires odm user member of docker group
* Required WebODM directory checked out/cloned to /opt/WebODM
* Requires that /opt/WebODM is recursively owned by odm:odm
* Requires that a Python 3 environment is used at /opt/WebODM/python3-venv
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:bash sudo systemctl enable /opt/WebODM/service/webodm-docker.service
To manually start/stop the service:bash sudo systemctl stop webodm-docker sudo systemctl start webodm-docker
To manually check service status:bash sudo systemctl status webodm-docker
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.
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.
To run WebODM, you will need to install:
* PostgreSQL (>= 9.5)
* PostGIS 2.3
* Python 3.6
* GDAL (>= 3)
* Node.js (>= 6.0)
* Nginx (Linux/MacOS) - OR - Apache + mod_wsgi or Waitress (Windows)
* Redis (>= 2.6)
* GRASS GIS (>= 7.8)
On Linux, make sure you have:
apt-get install binutils libproj-dev gdal-bin nginx
brew install postgres postgis
Then these steps should be sufficient to get you up and running:
git clone --depth 1 https://github.com/OpenDroneMap/WebODM
Create a WebODM/webodm/local_settings.py file containing your database settings:
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:
ALTER SYSTEM SET postgis.enable_outdb_rasters TO True;
ALTER SYSTEM SET postgis.gdal_enabled_drivers TO 'GTiff';
Start the redis broker:
redis-server
Then:
pip install -r requirements.txt
sudo npm install -g webpack
sudo npm install -g webpack-cli
npm install
webpack --mode production
python manage.py collectstatic --noinput
chmod +x start.sh && ./start.sh --no-gunicorn
Finally, start at least one celery worker:
./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.
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:
gunicorn webodm.wsgi --bind 0.0.0.0:8000 --preload
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
Should all work without errors.