From cecbe8816c335f1a949ab2a3c95bff1c8b24b6a3 Mon Sep 17 00:00:00 2001 From: Heiko Pohl Date: Fri, 18 Jul 2025 15:10:38 +0200 Subject: [PATCH] rework admin welcome docs --- docs/admin/welcome/datasheet.md | 84 ++++++------- docs/admin/welcome/features.md | 202 ++++++++++++++------------------ docs/admin/welcome/index.md | 8 +- 3 files changed, 132 insertions(+), 162 deletions(-) diff --git a/docs/admin/welcome/datasheet.md b/docs/admin/welcome/datasheet.md index 2e6cbac4..ec4542b9 100644 --- a/docs/admin/welcome/datasheet.md +++ b/docs/admin/welcome/datasheet.md @@ -2,69 +2,71 @@ sidebar_position: 2 id: datasheet title: Datasheet +description: Datasheet +draft: false --- ## Deployment Options -| Category | Details | -| :---------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **Types** | | -| **Container (recommended)** | | -| **Bare-Metal (not officially supported)** | | +| Category | Details | +| :------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Types | | +| Container (recommended) | | +| Bare-Metal (not officially supported) | | ## Backup -| Category | Details | -| :------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------- | -| **Backup strategy** | | +| Category | Details | +| :-------------- | :------------------------------------------------------------------------------------------------------------------------------------------- | +| Backup strategy | | ## Security -| Category | Details | -| :----------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **Encryption** | | -| **Access management** | | -| **Auditing & Logging** | | -| **File Firewall** | | -| **Antivirus** | | -| **Data Loss Prevention** | | +| Category | Details | +| :------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Encryption | | +| Access management | | +| Auditing & Logging | | +| File Firewall | | +| Antivirus | | +| Data Loss Prevention | | ## Identity Management -| Category | Details | -| :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **Integrated** | | -| **External** | | +| Category | Details | +| :--------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Integrated | | +| External | | ## Compliance -| Regulation | Details | -| :---------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| **EU-GDPR** | | -| **WCAG 2.1 / BITV 2.0 Web Accessibility** | | +| Regulation | Details | +| :------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| EU-GDPR | | +| WCAG 2.1 / BITV 2.0 Web Accessibility | | ## High Availability -| Category | Details | -| :------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **Redundancy & Failover** | | +| Category | Details | +| :-------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Redundancy & Failover | | ## Integrations -| Category | Details | -| :-------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| **Plugins & Extensibility** | | +| Category | Details | +| :---------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Plugins & Extensibility | | ## APIs -| API | Description | -| :----------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **WebDAV** | | -| **GraphAPI** | | -| **gRPC** | | -| **OCS** | | -| **OCM** | | -| **SSE** | | -| **WOPI** | | -| **KQL** | | -| **ICAP** | | +| API | Description | +| :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| WebDAV | | +| GraphAPI | | +| gRPC | | +| OCS | | +| OCM | | +| SSE | | +| WOPI | | +| KQL | | +| ICAP | | diff --git a/docs/admin/welcome/features.md b/docs/admin/welcome/features.md index b0fee220..1bbd70c6 100644 --- a/docs/admin/welcome/features.md +++ b/docs/admin/welcome/features.md @@ -2,155 +2,123 @@ sidebar_position: 1 id: features title: Features +description: Features +draft: false --- -## **πŸš€ Key Features at a Glance** +## Key Features at a Glance -- **Seamless File Synchronization**: Access your files across all devices. -- **Secure & Flexible File Sharing**: Share files with granular roles, expiration dates, and password protection. -- **Spaces - Collaborative Team Folders**: Ensure continuity even if team members leave. -- **Real-Time Collaboration**: Work on documents simultaneously with Collabora Web Office. -- **Advanced Search & Organization**: Use full-text search, tags, and filters for quick access. -- **Unlimited Storage & Uploads**: No file size restrictions. -- **Privacy-First Design**: Zero-Knowledge principle ensures admins can't access user content. -- **Cross-Client Availability**: Works on Windows, Mac, Linux, Android (soon), iOS (soon), and Web. +- Seamless File Synchronization: Access your files across all devices. +- Secure & Flexible File Sharing: Share files with granular roles, expiration dates, and password protection. +- Spaces - Collaborative Team Folders: Ensure continuity even if team members leave. +- Real-Time Collaboration: Work on documents simultaneously with Collabora Web Office. +- Advanced Search & Organization: Use full-text search, tags, and filters for quick access. +- Unlimited Storage & Uploads: No file size restrictions. +- Privacy-First Design: Zero-Knowledge principle ensures admins can't access user content. +- Cross-Client Availability: Works on Windows, Mac, Linux, Android (soon), iOS (soon), and Web. ---- - -## **πŸ”„ Cross-Device Synchronization** - -- **Automatic Sync**: Keep files up to date across all devices. -- **File Manager Integration**: OpenCloud appears as a native drive in your file explorer. -- **Offline Access**: Work without an internet connection; sync updates when back online. - ---- - -## **πŸ” Secure File & Link Sharing** - -### **File Sharing** - -- **Granular Access Roles**: Assign users as Viewers, Editors, or Uploaders. -- **One-Click Sharing**: Generate share links instantly. -- **Expiration Dates**: Set automatic revocation of shared access. -- **Transparency**: Keep track of who made changes to files and when. -- **Unlimited Sharing**: Share with as many users or groups as needed. - -### **Link Sharing** - -- **Public Links**: Secure external sharing - no login or account needed. -- **Enforced Password Protection**: Custom rules for password strength. -- **Link Expiry**: Auto-disable links after a set period. -- **Multiple Links per File**: Unique links for different recipients; revoke links individually. -- **Anonymous File Drop**: Secure uploads without access to other files. -- **Built-in Password Generator**: Creates strong passwords automatically. - ---- - -## **πŸ“‚ Spaces - Collaborative Team Folders** - -- **Project-Based Team Folders**: Designed for teams to store, access, and manage files collectively. Files in Spaces belong to **multiple** users, ensuring continuity even if team members leave. -- **Self-Service Admin Transfer**: Easily reassign space owners and assign multiple owners for shared responsibility. -- **Easy Permission Control**: Manage user access based on the roles Viewers, Editors, Managers. - ---- - -## **πŸ“ Real-Time Collaboration – Web Office (Collabora)** +## Cross-Device Synchronization -- **Real-Time Editing**: Multiple users can work on documents at the same time. -- **No File Transfers**: Edit directly in the browser always on the latest version. -- **No Software Installation**: Works entirely online, reducing costs and complexity. +- Automatic Sync: Keep files up to date across all devices. +- File Manager Integration: OpenCloud appears as a native drive in your file explorer. +- Offline Access: Work without an internet connection; sync updates when back online. ---- +## Secure File & Link Sharing -## **πŸ”Ž Smart Search & Organization** +- File Sharing + - Granular Access Roles: Assign users as Viewers, Editors, or Uploaders. + - One-Click Sharing: Generate share links instantly. + - Expiration Dates: Set automatic revocation of shared access. + - Transparency: Keep track of who made changes to files and when. + - Unlimited Sharing: Share with as many users or groups as needed. -- **Full-Text Search**: Find files quickly, even in scanned documents. -- **Live Search**: Instant results as you type. -- **Image-to-Text Recognition**: Extract text from images and scanned files (OCR - Optical Character Recognition). -- **Advanced Filters**: Search by document type, tags, date, or storage location. +- Link Sharing + - Public Links: Secure external sharing - no login or account needed. + - Enforced Password Protection: Custom rules for password strength. + - Link Expiry: Auto-disable links after a set period. + - Multiple Links per File: Unique links for different recipients; revoke links individually. + - Anonymous File Drop: Secure uploads without access to other files. + - Built-in Password Generator: Creates strong passwords automatically. -### **Tags** +## Spaces - Collaborative Team Folders -- **Flexible Organization**: Categorize files beyond folder structures. -- **Quick Search**: Find files faster using keywords. -- **Audit & Compliance**: Ensure traceability of important documents. +- Project-Based Team Folders: Designed for teams to store, access, and manage files collectively. Files in Spaces belong to multiple users, ensuring continuity even if team members leave. +- Self-Service Admin Transfer: Easily reassign space owners and assign multiple owners for shared responsibility. +- Easy Permission Control: Manage user access based on the roles Viewers, Editors, Managers. ---- +## Real-Time Collaboration – Web Office (Collabora) -## **πŸ“œ File Versioning & Recovery** +- Real-Time Editing: Multiple users can work on documents at the same time. +- No File Transfers: Edit directly in the browser always on the latest version. +- No Software Installation: Works entirely online, reducing costs and complexity. -- **Easy Recovery**: Roll back to previous file versions. -- **Accidental Change Protection**: Recover files in case of unintended edits. -- **Deleted File Recovery**: Restore files from the trash bin. +## Smart Search & Organization ---- +- Full-Text Search: Find files quickly, even in scanned documents. +- Live Search: Instant results as you type. +- Image-to-Text Recognition: Extract text from images and scanned files (OCR - Optical Character Recognition). +- Advanced Filters: Search by document type, tags, date, or storage location. -## **⚑ High-Performance, User-Friendly Interface** +- Tags + - Flexible Organization: Categorize files beyond folder structures. + - Quick Search: Find files faster using keywords. + - Audit & Compliance: Ensure traceability of important documents. -- **Familiar Desktop Features**: - - **Right-click** context menus. - - **Drag & Drop** support between web and desktop. - - **Keyboard Shortcuts**: (Ctrl + C, Ctrl + X, Ctrl + V). - - **Multi-Selection**: (Ctrl + Click, Shift + Click). -- **Instant UI Updates**: No need to refresh when a file is modified. +## File Versioning & Recovery ---- +- Easy Recovery: Roll back to previous file versions. +- Accidental Change Protection: Recover files in case of unintended edits. +- Deleted File Recovery: Restore files from the trash bin. -## **πŸ›‘οΈ Security & Compliance** +## High-Performance, User-Friendly Interface -### **File Firewall** +- Familiar Desktop Features: + - Right-click context menus. + - Drag & Drop support between web and desktop. + - Keyboard Shortcuts: (Ctrl + C, Ctrl + X, Ctrl + V). + - Multi-Selection: (Ctrl + Click, Shift + Click). +- Instant UI Updates: No need to refresh when a file is modified. -- **Block Malicious Uploads**: Prevent unwanted file types like **.exe or macro files**. -- **Allowlist & Denylist Support**: Define permitted and blocked file types. +## Security & Compliance -### **ICAP Antivirus Interface** +- File Firewall + - Block Malicious Uploads: Prevent unwanted file types like .exe or macro files. + - Allowlist & Denylist Support: Define permitted and blocked file types. -- **Automated Malware Scanning**: Scan all uploaded files before they reach user devices. -- **Early Threat Detection**: Prevent infections before they spread. -- **Compliance Assurance**: Meets security standards for home and enterprise storage. +- ICAP Antivirus Interface + - Automated Malware Scanning: Scan all uploaded files before they reach user devices. + - Early Threat Detection: Prevent infections before they spread. + - Compliance Assurance: Meets security standards for home and enterprise storage. -### **Zero-Knowledge Principle** +- Zero-Knowledge Principle + - Admin Privacy Controls: Admins manage spaces without accessing file content. + - User-Owned Data: Only designated users can access stored files. -- **Admin Privacy Controls**: Admins manage spaces without accessing file content. -- **User-Owned Data**: Only designated users can access stored files. +- Access Control + - Granular Permission Management: Role-Based Access Control. -### **Access Control** +- GDPR & Accessibility Compliance + - GDPR Compliant: Fully meets EU data protection regulations. + - BITV 2.0 / WCAG 2.1 Compliance: Ensures accessible web usage for all users. -- **Granular Permission Management**: Role-Based Access Control. +## Unlimited File Size -### **GDPR & Accessibility Compliance** +- No File Size Limits: Upload large files without restrictions. -- **GDPR Compliant**: Fully meets **EU data protection regulations**. -- **BITV 2.0 / WCAG 2.1 Compliance**: Ensures **accessible** web usage for all users. +## Web Extension System ---- +- Extension System: Add new features and third-party integrations. +- Custom UI Adjustments: Modify the interface based on specific needs. +- Simple Installation & Management: Easily install and manage extensions. -## **πŸ“¦ Unlimited File Size** +## On-Premise -- **No File Size Limits**: Upload large files without restrictions. +- On-Premise: Fully self-hosted deployment for maximum control. ---- - -## **πŸ› οΈ Web Extension System** +## Built-in File Preview -- **Extension System**: Add new features and third-party integrations. -- **Custom UI Adjustments**: Modify the interface based on specific needs. -- **Simple Installation & Management**: Easily install and manage extensions. - ---- - -## **πŸ—οΈ On-Premise** - -- **On-Premise**: Fully self-hosted deployment for maximum control. - ---- - -## **πŸ–ΌοΈ Built-in File Preview** - -- **Supports Common Formats**: Preview images and browser-compatible videos directly in OpenCloud. - ---- +- Supports Common Formats: Preview images and browser-compatible videos directly in OpenCloud. -## **🌐 Multi-Platform Availability** +## Multi-Platform Availability -- **Compatible with**: Windows, Mac, Linux, **Android (soon), iOS (soon),** and Web. +- Compatible with: Windows, Mac, Linux, Android (soon), iOS (soon), and Web. diff --git a/docs/admin/welcome/index.md b/docs/admin/welcome/index.md index f9758378..c2fb46e5 100644 --- a/docs/admin/welcome/index.md +++ b/docs/admin/welcome/index.md @@ -5,7 +5,7 @@ slug: /admin/intro # πŸ™‹πŸ»β€β™€οΈ Welcome to OpenCloud Admin Docs -Welcome to **OpenCloud**, your self-hosted file sharing platform: Secure, simple and reliable. This documentation helps you to **get started, configure, and maintain** OpenCloud. +Welcome to OpenCloud, your self-hosted file sharing platform: Secure, simple and reliable. This documentation helps you to get started, configure, and maintain OpenCloud. ## Quick start @@ -15,9 +15,9 @@ curl -L https://opencloud.eu/install | /bin/bash ## What’s Inside? -1. **Getting Started** – Set up and deploy OpenCloud -2. **Configuration** – Customize and integrate with existing systems and storage -3. **Maintenance** – Learn how to update, backup and migrate +- Getting Started – Set up and deploy OpenCloud +- Configuration – Customize and integrate with existing systems and storage +- Maintenance – Learn how to update, backup and migrate ## Need Help?