Files
Oxicloud/doc/DAV-CLIENT-SETUP.md
T

196 lines
6.4 KiB
Markdown
Raw Normal View History

2025-04-04 21:31:41 +02:00
# WebDAV Client Setup Guide for OxiCloud
2025-04-02 23:14:12 +02:00
2025-04-04 21:31:41 +02:00
This document provides detailed instructions for connecting desktop clients to OxiCloud using WebDAV, enabling seamless integration with your operating system's file browser.
2025-04-02 23:14:12 +02:00
2025-04-04 21:31:41 +02:00
## What is WebDAV?
2025-04-02 23:14:12 +02:00
2025-04-04 21:31:41 +02:00
WebDAV (Web Distributed Authoring and Versioning) is an extension of the HTTP protocol that allows users to collaboratively edit and manage files on remote web servers. OxiCloud implements WebDAV to provide desktop access to your files and folders.
2025-04-02 23:14:12 +02:00
2025-04-04 21:31:41 +02:00
## Connection Information
2025-04-02 23:14:12 +02:00
2025-04-04 21:31:41 +02:00
Use the following details to connect to OxiCloud via WebDAV:
2025-04-02 23:14:12 +02:00
2025-04-04 21:31:41 +02:00
- **Server URL**: `https://[your-oxicloud-server]/webdav/`
- **Username**: Your OxiCloud username
- **Password**: Your OxiCloud password
2025-04-02 23:14:12 +02:00
2025-04-04 21:31:41 +02:00
## Client Setup Instructions
2025-04-02 23:14:12 +02:00
### Windows
2025-04-04 21:31:41 +02:00
#### Windows 10/11 (File Explorer)
2025-04-02 23:14:12 +02:00
2025-04-04 21:31:41 +02:00
1. Open File Explorer
2. Right-click on "This PC" and select "Add a network location"
3. Click "Next"
4. Select "Choose a custom network location" and click "Next"
5. Enter the WebDAV URL: `https://[your-oxicloud-server]/webdav/`
6. When prompted, enter your OxiCloud username and password
7. Give the connection a name (e.g., "OxiCloud") and click "Next"
8. Click "Finish"
2025-04-02 23:14:12 +02:00
2025-04-04 21:31:41 +02:00
Your OxiCloud files will now appear as a network drive in File Explorer.
2025-04-02 23:14:12 +02:00
2025-04-04 21:31:41 +02:00
#### Alternative Method: Map Network Drive
2025-04-02 23:14:12 +02:00
2025-04-04 21:31:41 +02:00
1. Open File Explorer
2. Right-click on "This PC" and select "Map network drive"
3. Choose a drive letter
4. Enter the WebDAV URL: `https://[your-oxicloud-server]/webdav/`
5. Check "Connect using different credentials"
6. Click "Finish"
7. Enter your OxiCloud username and password
**Troubleshooting Windows Connections:**
If you experience issues connecting on Windows:
1. Open Registry Editor (regedit.exe)
2. Navigate to `HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\WebClient\Parameters`
3. Modify `BasicAuthLevel` to value `2`
4. Restart the WebClient service or restart your computer
You may also need to increase the file size limit:
1. In the same registry location, modify `FileSizeLimitInBytes` to a higher value (e.g., `4294967295` for 4GB)
2. Restart the WebClient service
2025-04-02 23:14:12 +02:00
### macOS
#### Finder
2025-04-04 21:31:41 +02:00
1. Open Finder
2. From the menu bar, click "Go" > "Connect to Server" (or press ⌘K)
3. Enter the WebDAV URL: `https://[your-oxicloud-server]/webdav/`
4. Click "Connect"
5. Enter your OxiCloud username and password
6. Click "Connect"
Your OxiCloud files will now appear as a mounted drive in Finder.
2025-04-02 23:14:12 +02:00
### Linux
2025-04-04 21:31:41 +02:00
#### GNOME (Nautilus File Manager)
2025-04-02 23:14:12 +02:00
2025-04-04 21:31:41 +02:00
1. Open Files (Nautilus)
2. Click the "+" button in the sidebar or press Ctrl+L
3. Enter the WebDAV URL: `davs://[your-oxicloud-server]/webdav/`
4. Enter your credentials when prompted
5. Click "Connect"
2025-04-02 23:14:12 +02:00
2025-04-04 21:31:41 +02:00
#### KDE (Dolphin File Manager)
2025-04-02 23:14:12 +02:00
2025-04-04 21:31:41 +02:00
1. Open Dolphin
2. In the address bar, enter: `webdavs://[your-oxicloud-server]/webdav/`
3. Enter your credentials when prompted
4. Click "Connect"
2025-04-02 23:14:12 +02:00
2025-04-04 21:31:41 +02:00
#### Command Line (davfs2)
2025-04-02 23:14:12 +02:00
2025-04-04 21:31:41 +02:00
1. Install davfs2: `sudo apt-get install davfs2` (Debian/Ubuntu) or equivalent for your distribution
2. Create a mount point: `sudo mkdir /mnt/oxicloud`
3. Edit `/etc/davfs2/secrets` and add: `/mnt/oxicloud [username] [password]`
4. Mount the WebDAV share: `sudo mount -t davfs https://[your-oxicloud-server]/webdav/ /mnt/oxicloud`
2025-04-02 23:14:12 +02:00
2025-04-04 21:31:41 +02:00
To automatically mount at boot, add to `/etc/fstab`:
```
https://[your-oxicloud-server]/webdav/ /mnt/oxicloud davfs user,rw,auto 0 0
```
2025-04-02 23:14:12 +02:00
2025-04-04 21:31:41 +02:00
### Mobile Devices
2025-04-02 23:14:12 +02:00
2025-04-04 21:31:41 +02:00
#### Android
2025-04-02 23:14:12 +02:00
2025-04-04 21:31:41 +02:00
Several apps support WebDAV connections on Android:
2025-04-02 23:14:12 +02:00
2025-04-04 21:31:41 +02:00
1. **X-plore File Manager**:
- Install from Google Play Store
- Tap the globe icon (Network)
- Select "New Connection" > "WebDAV"
- Enter server details and credentials
2. **Total Commander** with WebDAV plugin:
- Install both from Google Play Store
- Open the app and tap the folder icon
- Choose "LAN/Cloud" > "WebDAV"
- Enter your server details and credentials
2025-04-02 23:14:12 +02:00
#### iOS
2025-04-04 21:31:41 +02:00
1. **Documents by Readdle**:
- Install from App Store
- Tap the "+" button
- Select "Add Connection" > "WebDAV Server"
- Enter server URL and credentials
2025-04-02 23:14:12 +02:00
2025-04-04 21:31:41 +02:00
2. **FileBrowser**:
- Install from App Store
- Tap "+" to add a new connection
- Select "WebDAV"
- Enter server details and credentials
## Third-Party Applications
### Microsoft Office
1. Open any Office application
2. Go to File > Open
3. Click "Add a Place" and select "Office.com" or "SharePoint"
4. Enter the WebDAV URL: `https://[your-oxicloud-server]/webdav/`
5. Enter your credentials when prompted
### LibreOffice
1. Go to File > Open
2. In the file dialog, enter the WebDAV URL in the location bar
3. Enter credentials when prompted
### Desktop WebDAV Clients
- **Cyberduck** (Windows, macOS): Free, open-source WebDAV client
- **WinSCP** (Windows): Primarily an FTP client, but supports WebDAV
- **FileZilla Pro** (Windows, macOS, Linux): Supports WebDAV in the Pro version
## Performance Considerations
For optimal performance when using WebDAV:
1. **Large Files**: When working with files larger than 100MB, consider downloading them locally before editing
2. **Slow Connections**: Enable offline caching in your client when available
3. **File Locking**: Some clients support WebDAV locking to prevent conflicts
## Limitations and Known Issues
- **File Locking**: The current implementation does not support WebDAV locking operations (LOCK and UNLOCK)
- **Performance**: WebDAV may be slower than native sync clients for large file transfers
- **File Size**: Some WebDAV clients may have limitations on file sizes
## Security Considerations
WebDAV connections to OxiCloud use the same authentication mechanisms as the web interface. For enhanced security:
1. Always use HTTPS connections
2. Consider setting up two-factor authentication if supported
3. Don't save credentials on shared or public computers
## Troubleshooting
### Connection Issues
- Verify the server URL is correct and includes the `/webdav/` path
- Ensure your username and password are entered correctly
- Check if your network blocks WebDAV connections (ports 80/443)
- Verify that your OxiCloud server has WebDAV enabled
### File Operation Issues
- If you cannot upload files, check if you have write permissions
- If files appear to be corrupted, try using a different WebDAV client
- For timeout errors, increase the client timeout settings if possible
### Client-Specific Issues
For client-specific issues, consult the documentation for your WebDAV client or operating system.
## Getting Help
2025-04-02 23:14:12 +02:00
2025-04-04 21:31:41 +02:00
If you encounter issues not covered in this document, please contact your OxiCloud administrator or refer to the main OxiCloud documentation.