# WebDAV

The **WebDAV integration** enables backup and restoration of WebDAV remotes. Any
WebDAV-compatible service can be used as a source or destination, including
Nextcloud, ownCloud, and self-hosted WebDAV servers.

The WebDAV integration provides two connectors:

| Connector type            | Description                                                |
| ------------------------- | ---------------------------------------------------------- |
| **Source connector**      | Back up a WebDAV remote into a Kloset store.               |
| **Destination connector** | Restore a snapshot from a Kloset store to a WebDAV remote. |

## Installation

The WebDAV package can be installed using pre-built binaries or compiled from
source.

{{< tabs >}}

{{< tab label="Pre-built package" >}}

Pre-compiled packages are available for common platforms and provide the
simplest installation method.

> [!NOTE]+ Logging In
>
> Pre-built packages require Plakar authentication. See
> [Logging in to Plakar](../../guides/logging-in-to-plakar) for details.

Install the WebDAV package:

```bash
$ plakar pkg add webdav
```

Verify installation:

```bash
$ plakar pkg list
```

{{< /tab >}}

{{< tab label="Building from source" >}}

Source builds are useful when pre-built packages are unavailable or when
customization is required.

**Prerequisites:**

- Go toolchain compatible with your **Plakar** version

Build the package:

```bash
$ plakar pkg build webdav
```

A package archive will be created in the current directory (e.g.,
`webdav_v1.0.0_darwin_arm64.ptar`).

Install the package:

```bash
$ plakar pkg add ./webdav_v1.0.0_darwin_arm64.ptar
```

Verify installation:

```bash
$ plakar pkg list
```

{{< /tab >}}

{{< /tabs >}}

To list, upgrade, or remove the package, see
[managing packages guide](../../guides/managing-packages/).

## Configuration

### Protocols

The integration supports two protocols:

- `davs://` — TLS-encrypted WebDAV. Recommended for all remote connections.
- `dav://` — Unencrypted WebDAV. Requires `insecure=true` to be explicitly set.

> [!WARNING]+
>
> Only use `dav://` on trusted local networks. For any connection over the
> internet, use `davs://` to protect credentials and data in transit.

### Configuration options

These options apply to both connectors.

| Option     | Description                                                                  |
| ---------- | ---------------------------------------------------------------------------- |
| `username` | Optional. Username for basic authentication.                                 |
| `password` | Optional. Password for basic authentication. Only used if `username` is set. |
| `insecure` | Set to `true` to allow the unencrypted `dav://` protocol.                    |

## Source connector

The source connector retrieves files from a WebDAV remote and stores them in a
Kloset store with encryption and deduplication.

<!-- prettier-ignore-start -->
{{< mermaid >}}
flowchart LR

subgraph Source["WebDAV Remote"]
  FS["Files"]
end

subgraph Plakar["Plakar"]
  Connector["Retrieve files via<br/>WebDAV"]
  Transform["Encrypt & deduplicate"]
  Connector --> Transform
end

Source --> Connector

Store["Kloset Store"]
Transform --> Store
{{< /mermaid >}}
<!-- prettier-ignore-end -->

Register the source and run a backup:

```bash
$ plakar source add my-webdav \
  davs://<webdav-host>/path/to/files \
  username=<YOUR_USERNAME> \
  password=<YOUR_PASSWORD>

$ plakar at /var/backups backup "@my-webdav"
```

To back up a specific path:

```bash
$ plakar at /var/backups backup "@my-webdav:subpath"
```

### Example: Nextcloud

```bash
$ plakar source add nextcloud \
  davs://<nextcloud-url>/remote.php/dav/files/<your-user> \
  username=<YOUR_USERNAME> \
  password=<YOUR_PASSWORD>

$ plakar at /var/backups backup "@nextcloud"
```

## Destination connector

Restores files from a Kloset store back to a WebDAV remote.

<!-- prettier-ignore-start -->
{{< mermaid >}}
flowchart LR

Store["Kloset Store"]

subgraph Plakar["Plakar"]
  Transform["Decrypt & reconstruct"]
  Connector["Restore via<br/>WebDAV"]
  Transform --> Connector
end

Store --> Transform

subgraph Destination["WebDAV Remote"]
  FS["Files"]
end

Connector --> Destination
{{< /mermaid >}}
<!-- prettier-ignore-end -->

Register the destination and restore a snapshot:

```bash
$ plakar destination add my-webdav-restore \
  davs://<webdav-host>/path/to/files \
  username=<YOUR_USERNAME> \
  password=<YOUR_PASSWORD>

$ plakar at /var/backups restore -to "@my-webdav-restore" <snapshot_id>
```

## Notes

- WebDAV does not preserve all filesystem metadata such as Unix permissions and
  symlinks. Only file content, directory structure, modification times, and
  basic attributes are captured.
- Empty directories are preserved.
- When using `dav://`, the `insecure=true` option must be explicitly set.