Command Line Interface
======================

*This section describes how to use WsgiDAV from the command line.*

The WsgiDAV server was tested with these platforms

  * Mac OS X 10.9 - 10.13
  * Ubuntu 13 - 16
  * Windows (Win 7 - 10, Vista, XP)

To serve the ``/tmp`` folder as WebDAV ``/`` share, simply run::

  $ wsgidav --host=0.0.0.0 --port=80 --root=/tmp --auth=anonymous
  2019-01-03 20:47:52.034 - INFO    :  WsgiDAV/3.0.0a8 Python/3.7.0 Darwin-18.2.0-x86_64-i386-64bit
  2019-01-03 20:47:52.034 - INFO    :  Lock manager:      LockManager(LockStorageDict)
  2019-01-03 20:47:52.034 - INFO    :  Property manager:  None
  2019-01-03 20:47:52.034 - INFO    :  Domain controller: SimpleDomainController()
  2019-01-03 20:47:52.034 - INFO    :  Registered DAV providers by route:
  2019-01-03 20:47:52.035 - INFO    :    - '/:dir_browser': FilesystemProvider for path '/Users/martin/prj/git/wsgidav/wsgidav/dir_browser/htdocs' (Read-Only) (anonymous)
  2019-01-03 20:47:52.035 - INFO    :    - '/': FilesystemProvider for path '/tmp' (Read-Write) (anonymous)
  2019-01-03 20:47:52.035 - WARNING :  Basic authentication is enabled: It is highly recommended to enable SSL.
  2019-01-03 20:47:52.035 - WARNING :  Share '/' will allow anonymous write access.
  2019-01-03 20:47:52.035 - WARNING :  Share '/:dir_browser' will allow anonymous read access.
  2019-01-03 20:47:52.042 - INFO    :  Running WsgiDAV/3.0.0a8 Cheroot/6.5.4.dev43+gab92fb97 Python/3.7.0
  2019-01-03 20:47:52.042 - INFO    :  Serving on http://0.0.0.0:80 ...

.. warning::
	Here, WsgiDAV will publish the folder for anonymous access.
	Read :doc:`user_guide_configure` how to set up authentication.


CLI Options
-----------

Use the ``--help`` or ``-h`` argument to get help::

  $ wsgidav --help
  usage: wsgidav [-h] [-p PORT] [-H HOST] [-r ROOT_PATH]
                [--auth {anonymous,nt,pam-login}]
                [--server {paste,gevent,cheroot,cherrypy,ext-wsgiutils,flup-fcgi,flup-fcgi_fork,wsgiref}]
                [--ssl-adapter {builtin,pyopenssl}] [-v | -q]
                [-c CONFIG_FILE | --no-config] [-V]

  Run a WEBDAV server to share file system folders.

  Examples:

    Share filesystem folder '/temp' for anonymous access (no config file used):
      wsgidav --port=80 --host=0.0.0.0 --root=/temp --auth=anonymous

    Run using a specific configuration file:
      wsgidav --port=80 --host=0.0.0.0 --config=~/my_wsgidav.yaml

    If no config file is specified, the application will look for a file named
    'wsgidav.yaml' in the current directory.
    See
      http://wsgidav.readthedocs.io/en/latest/run-configure.html
    for some explanation of the configuration file format.


  optional arguments:
    -h, --help            show this help message and exit
    -p PORT, --port PORT  port to serve on (default: 8080)
    -H HOST, --host HOST  host to serve from (default: localhost). 'localhost' is only accessible from the local computer. Use 0.0.0.0 to make your application public
    -r ROOT_PATH, --root ROOT_PATH
                          path to a file system folder to publish as share '/'.
    --auth {anonymous,nt,pam-login}
                          quick configuration of a domain controller when no config file is used
    --server {paste,gevent,cheroot,cherrypy,ext-wsgiutils,flup-fcgi,flup-fcgi_fork,wsgiref}
                          type of pre-installed WSGI server to use (default: cheroot).
    --ssl-adapter {builtin,pyopenssl}
                          used by 'cheroot' server if SSL certificates are configured (default: builtin).
    -v, --verbose         increment verbosity by one (default: 3, range: 0..5)
    -q, --quiet           decrement verbosity by one
    -c CONFIG_FILE, --config CONFIG_FILE
                          configuration file (default: ('wsgidav.yaml', 'wsgidav.json', 'wsgidav.conf') in current directory)
    --no-config           do not try to load default ('wsgidav.yaml', 'wsgidav.json', 'wsgidav.conf')
    -V, --version         print version info and exit (may be combined with --verbose)

  Licensed under the MIT license.
  See https://github.com/mar10/wsgidav for additional information.
  $


Use a Configuration File
------------------------
Much more options are available when a configuration file is specified.

.. seealso::
	:doc:`user_guide_configure`


..
  Exit Codes
  ----------

  The CLI returns those exit codes::

      0: OK
      2: CLI syntax error
      3: Aborted by user