Command-line arguments of webodm.sh?

It would be nice to have a complete list of command-line arguments to pass to the webodm.sh script. I’d like to run WebODM in the background, but there’s nothing telling me how I can do that (other than manually running the docker-compose command from the script).

Just run:

./webodm.sh --help

Usage: ./webodm.sh <command>

This program helps to manage the setup/teardown of the docker containers for running WebODM. We recommend that you read the full documentation of docker at https://docs.docker.com if you want to customize your setup.

Command list:
	start [options]		Start WebODM
	stop			Stop WebODM
	down			Stop and remove WebODM's docker containers
	update			Update WebODM to the latest release
	rebuild			Rebuild all docker containers and perform cleanups
	checkenv		Do an environment check and install missing components
	test			Run the unit test suite (developers only)
	resetadminpassword "<new password>"	Reset the administrator's password to a new one. WebODM must be running when executing this command and the password must be enclosed in double quotes.

Options:
	--port	<port>	Set the port that WebODM should bind to (default: 8000)
	--hostname	<hostname>	Set the hostname that WebODM will be accessible from (default: localhost)
	--media-dir	<path>	Path where processing results will be stored to (default: appmedia (docker named volume))
	--default-nodes	The amount of default NodeODM nodes attached to WebODM on startup (default: 1)
	--with-micmac	Create a NodeMICMAC node attached to WebODM on startup. Experimental! (default: disabled)
	--ssl	Enable SSL and automatically request and install a certificate from letsencrypt.org. (default: NO)
	--ssl-key	<path>	Manually specify a path to the private key file (.pem) to use with nginx to enable SSL (default: None)
	--ssl-cert	<path>	Manually specify a path to the certificate file (.pem) to use with nginx to enable SSL (default: None)
	--ssl-insecure-port-redirect	<port>	Insecure port number to redirect from when SSL is enabled (default: 80)
	--debug	Enable debug for development environments (default: disabled)
	--dev	Enable development mode. In development mode you can make modifications to WebODM source files and changes will be reflected live. (default: disabled)
	--dev-watch-plugins	Automatically build plugins while in dev mode. (default: disabled)
	--broker	Set the URL used to connect to the celery broker (default: redis://broker)
	--detached	Run WebODM in detached mode. This means WebODM will run in the background, without blocking the terminal (default: disabled)
	--gpu	Use GPU NodeODM nodes (Linux only) (default: disabled)

The --detached flag seems what you are looking for.

:clinking_glasses:

1 Like

Thanks for the answer! This was embarrassingly simple. :slight_smile:

2 Likes

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.