Metadata-Version: 2.4
Name: webdav-server-for-filehold
Version: 17.2.0
Summary: WebDAV server for FileHold (Community Tool)
Project-URL: Repository, https://github.com/danielklecha/webdav-server-for-filehold
Author-email: Daniel Klecha <daniel.klecha@gmail.com>
Maintainer-email: Daniel Klecha <daniel.klecha@gmail.com>
License: MIT License
        
        Copyright (c) 2025 Daniel Klecha
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: adapter,filehold,filesystem,webdav
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
Requires-Python: >=3.10
Requires-Dist: requests
Requires-Dist: uvicorn
Requires-Dist: wsgidav
Requires-Dist: zeep
Description-Content-Type: text/markdown

# WebDAV for FileHold (Community Tool)

## Disclaimer

**Community Tool - Unofficial Implementation**
This project is an independent, community-developed open-source software project. It is **not** provided, supported, endorsed by, sponsored by, or affiliated with **FileHold Systems Inc.** or **Keymark**.

**Trademarks**
"FileHold" and the FileHold logo are trademarks or registered trademarks of FileHold Systems Inc. in the United States, Canada, and/or other countries. All other trademarks cited herein are the property of their respective owners. Use of these names is for descriptive purposes only (nominative fair use) to indicate compatibility.

## Features

This server allows you to access your FileHold documents via the WebDAV protocol.

1. **Browsing:** Navigate through cabinets, drawers, folder groups, and folders.
2. **Downloading:** Download documents.
3. **Adding:** Add cabinets, drawers, folder groups, folders and documents.
4. **Overriding:** Override existing documents.
5. **Structure Modification:** Create cabinets, drawers, folder groups, and folders.
6. **Renaming:** Rename cabinets, drawers, folder groups, folders and documents.


## Installation

* **Run directly with [uv](https://docs.astral.sh/uv/) (recommended)**: `uvx webdav-server-for-filehold`
* **pip**: `pip install webdav-server-for-filehold`
* **uv**: `uv pip install webdav-server-for-filehold`

## Quick start

To start the server, run:

```bash
uv run webdav-server-for-filehold --filehold-url http://localhost/FH/FileHold/
```

### Logging in

When connecting via a WebDAV client (like WinSCP), use your FileHold credentials:

- **Local User**: `sysadm`, `.\sysadm`, or `local\sysadm`
- **Domain User**: `domainName\sysadm`

## Configuration

You can configure the server using the following command-line arguments:

| Argument                      | Environment Variable               | Description                                                         | Default                         |
| :---------------------------- | :--------------------------------- | :------------------------------------------------------------------ | :------------------------------ |
| `--host`                      | `WEBDAV_HOST`                      | Host to bind to                                                     | `0.0.0.0`                       |
| `--port`                      | `WEBDAV_PORT`                      | Port to bind to                                                     | `8080`                          |
| `--filehold-url`              | `WEBDAV_FILEHOLD_URL`              | Base URL for FileHold                                               | `http://localhost/FH/FileHold/` |
| `--default_schema_name`       | `WEBDAV_DEFAULT_SCHEMA_NAME`       | Default schema name to use when creating Cabinets or Folders        | `None`                          |
| `--create-category-in-drawer` | `WEBDAV_CREATE_CATEGORY_IN_DRAWER` | Create Category instead of Folder when creating directory in Drawer | `False`                         |
| `-v`, `--verbose`             | `WEBDAV_VERBOSE`                   | Enable debug logging for the application                            | `False`                         |
| `-vv`, `--very-verbose`       | `WEBDAV_VERY_VERBOSE`              | Enable debug logging for everything (including libraries)           | `False`                         |
| `--ssl-cert`                  | `WEBDAV_SSL_CERT`                  | Path to SSL certificate file (PEM format)                           | `None`                          |
| `--ssl-key`                   | `WEBDAV_SSL_KEY`                   | Path to SSL key file (PEM format)                                   | `None`                          |

**Example:**
```bash
webdav-server-for-filehold --port 9090 --filehold-url http://filehold.example.com/FH/FileHold/ --default_schema_name "Document"
```

## Contributing

Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for development and testing instructions.

## License

`webdav-server-for-filehold` is provided as-is under the MIT license.
