@sync-in/server/README.md

The secure, open-source platform for file storage, sharing, collaboration, and sync

<a href="https://sync-in.com" target="_blank" rel="noopener">
<picture>
  <source srcset="https://raw.githubusercontent.com/Sync-in/assets/main/logo-dark.svg" media="(prefers-color-scheme: dark)" />
  <img src="https://raw.githubusercontent.com/Sync-in/assets/main/logo.svg" alt="Sync-in" width="250" height="auto" />
</picture>
</a>

_Welcome to the official Sync-in server repository!_

- 🌍 [Website](https://sync-in.com)
- 📄 [Documentation](https://sync-in.com/docs)
- 🧪 [Try the demo](https://sync-in.com/docs/demo)
- 🐳 [Deploy with Docker](https://sync-in.com/docs/setup-guide/docker)
- 📦 [Deploy with NPM](https://sync-in.com/docs/setup-guide/npm)

<a href="#-license"><img src="https://img.shields.io/badge/Licence-AGPL%20v3.0-green.svg" alt="License"/></a>
<a href="https://github.com/Sync-in/server/releases" target="_blank"><img src="https://img.shields.io/github/v/release/Sync-in/server?sort=semver&display_name=tag&style=flat&logo=github&label=Release" alt="GitHub Release"/></a>
<a href="https://hub.docker.com/r/syncin/server" target="_blank"><img src="https://img.shields.io/docker/pulls/syncin/server?logo=docker&label=Docker%20Hub%20Pulls" alt="Docker pulls"/></a>
<a href="https://www.npmjs.com/package/@sync-in/server" target="_blank"><img src="https://img.shields.io/npm/d18m/@sync-in/server.svg?logo=npm&label=NPM%20Downloads&color=cb3837" alt="NPM"/></a>
<a href="https://discord.gg/qhJyzwaymT" target="_blank"><img src="https://img.shields.io/discord/1391081837849346088?logo=discord&label=Discord" alt="Discord"/></a>
<a href="https://deepwiki.com/Sync-in/server"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>

The **Sync-in Server** is designed to run on your own infrastructure, it gives you **full control over your data** while offering a modern,
intuitive interface for both internal and external users.

With features like **collaborative spaces**, **secure file sharing**, **granular permission management**,
Sync-in fits seamlessly into any environment — from small teams to large enterprises, public institutions, or privacy-conscious individuals.

<picture>
  <source srcset="https://raw.githubusercontent.com/Sync-in/assets/main/server-dark.png" media="(prefers-color-scheme: dark)" />
  <img src="https://raw.githubusercontent.com/Sync-in/assets/main/server.png" alt="Sync-in" width="600"/>
</picture>

---

## 🚀 Features

- 🖥️ Modern, Fast, and High-Performance Interface
  - Sleek and intuitive UI for a seamless user experience
  - Optimized for speed and efficiency
- 🔒 Security & Data Ownership
  - Full control over data security and compliance
  - Designed to protect sensitive documents and prevent unauthorized access
  - **Multi-Factor Authentication (MFA)**: TOTP (authenticator apps), recovery codes, app passwords
- 🔑 Advanced User Access Control
  - **Spaces & Shares**: Organize files with fine-grained access permissions
  - Role-based permission system ensuring secure file management
- 🤝 Collaboration & Integration
  - **OnlyOffice Integration**: Edit and collaborate on documents in real-time
  - **Activity Tracking**: Commenting, notifications, and file history for seamless teamwork
- 🔎 Powerful Full-Text Search
  - **Deep content search** for easy retrieval of files and documents
  - Supports various file formats for comprehensive indexing
- 📂 Document Management & Restrictions
  - **Quota & Lock Management**: Control file storage and prevent unwanted modifications
  - **Secure Spaces**: Ensure documents are shared in a protected environment
- 🔗 WebDAV Access
  - Fully compatible with **WebDAV** for remote file access and synchronization
- 🖥️ [Desktop Client](https://github.com/Sync-in/desktop)
  - Full-featured **desktop application** for enhanced productivity
  - Supports **file synchronization** across devices
  - Allows **connection to multiple servers** hosting the solution

---

## 🧩 Project Resources

- 🌍 **Official website**: [https://sync-in.com](https://sync-in.com)
- 📖 **Documentation**: [https://sync-in.com/docs](https://sync-in.com/docs)
- 🗄️ **Server** : [https://github.com/Sync-in/server](https://github.com/Sync-in/server)
- 💻 **Desktop & CLI** - Cross-platform desktop app and command-line interface : [https://github.com/Sync-in/desktop](https://github.com/Sync-in/desktop)
- 🐳 **Docker** - Setup & Deployment Guide : [https://sync-in.com/docs/setup-guide/docker](https://sync-in.com/docs/setup-guide/docker)

---

## 💛 Support

Sync-in is an independent open source project.  
If you find it useful, you can:

- ⭐ Star the repositories
- 🐛 Report issues and suggest improvements
- 🤝 Contribute code, translations, or documentation
- 💬 Join the community on :
   - [GitHub Discussions](https://github.com/Sync-in/server/discussions)
   - [Discord](https://discord.gg/qhJyzwaymT)
- 💖 Support the project !
  - [GitHub Sponsors](https://github.com/sponsors/Sync-in)
  - [Other ways to support](https://sync-in.com/support)

---

## 🤝 Contributing
Before submitting your pull request, please confirm the following:

- ✅ I have read and followed the [contribution guide](CONTRIBUTING.md).
- ✅ I am submitting this pull request in good faith and to help improve Sync-in.

---

## 📜 License
This project is licensed under the **GNU Affero General Public License (AGPL-3.0-or-later)**.  
See [LICENSE](LICENSE) for the full text.

Sync-in® is a registered trademark, see our [Trademark Policy](https://sync-in.com/trademark).

---

_Thank you for using **Sync-in** ! 🚀_