# Introduction

**PPDRIVE** is a free File Management API Provider built for speed, security, and reliability. While you can run PPDRIVE as a standalone service, you can also think of it as a backend framework for filesystem management. We also provide [optional features](#roadmap-features-lets-build-together) for free but they're all file-related.

As a standalone program, you can use PPDRIVE to build your own version of Google Drive, OneDrive, or Dropbox. PPDRIVE provides robust, secure, and extensible APIs that allow users to interact seamlessly with your server’s file system at the application level.

If you also need an owned cloud storage service (as alternative to AWS S3, GCP...etc), PPDRIVE integrates effortlessly into your existing applications. From self-hosted media streaming platforms to enterprise-grade storage solutions, PPDRIVE helps you build faster. Stay in control, while you pay nothing.

## Motivation

We notice that many startups, organizations, and developers prefer not to rely on third-party cloud storage services due to concerns about long-term costs, data privacy, and vendor lock-in. Unfortunately, the lack of viable alternatives often leaves them with limited choices. PPDRIVE was created to address this gap — offering a flexible, self-hosted suite of APIs for remote file management and storage.

## Why PPDRIVE?

* **Language/Framework Agnostic**: PPDRIVE works with any programming language or framework that allows you to send http requests. Whether it's Javascript or Golang; React, Vue, Angular, Flutter...you name it. You can even help us write an SDK or client library for your favorite language.
* **Privacy and Data Control**: All your user, application and business data stay on your server. PPDRIVE does not send, spy or use your data in any way.
* **No vendor lock-in. No hidden charges**: You don't need to pay for anything. PPDRIVE is totally free.
* **User-level Authorization**: PPDRIVE automatically provides fine-grained resource ownership so that only authorized users can access to assets. This way, you can focus on building other aspects of your application as we help you protect your filesystem.
* **Ease of Use**: If you're already familiar with sending HTTP requests, using PPDRIVE feels natural. We also provide a flexible service management tool for starting multiple services, viewing or cancelling running services.
* **Transparency**: The codebase is right here! Have a look at it, modify it and help us shape the future.
* **Speed**: Very fast operation handlers.
* **Cross Platform**: PPDRIVE can run on Linux, MacOS and Windows.
* **Lightweight**: We aim to make PPDRIVE as lightweight as possible. The starting point is to make sure you can install only what you need and extend it whenever you need more.

## 🚀 Features

* ⚙️ **REST API Interface**: PPDRIVE allows external applications to interact with your file system programmatically RESTful APIs. However, it is designed to be extended to support other networking protocols.
* 🔐 **Flexible Authentication**: PPDRIVE is secure by default, providing JWT authentication to protect private resources according to your applications. If you prefer to use PPDRIVE as a free tool and don't need protected access, you can opt-in for "No Auth" feature.
* 🪣 **Buckets**: Create isolated and configurable file buckets for better file system organization.
* 🧩 **Pluggable Integration**: Easily integrate into existing backends or operate as a standalone executable.
* 📦 **Prebuilt Executables**: Install and run with no setup required.
* 🧾 **File & Directory Operations**: Upload, download, rename, delete, and move files or folders.
* 🛢 **Cross Database Engine Support**: Support for Postgres, MySQL and SQLite (default) database backends.

Roadmap Features (Let's Build Together)

* Admin UI: Administrative client for managing your drive visually.
* File Compression: Compress files on the fly or at any convenient time.
* File Conversion: Convert files from one format to another.
* Image manipulation: Provide url queries for manipulating images.
* Async Upload: Upload large files in the background.
* File Streaming: Enable file streaming (for video/audio streaming platforms and other use cases)
* Live Streaming: End-to-end live streaming server.

## Getting Started

Setting up PPDRIVE takes less than 2 minutes. Just follow these steps:

{% stepper %}
{% step %}

### Install PPDRIVE

Depending on your platform, run the following commands to install PPDRIVE.

#### Linux

using curl:

{% code title="Install (Linux, curl)" %}

```sh
curl -fsSL https://raw.githubusercontent.com/dududaa/ppdrive/main/install.sh | bash
```

{% endcode %}

using wget:

{% code title="Install (Linux, wget)" %}

```sh
wget -qO- https://raw.githubusercontent.com/dududaa/ppdrive/main/install.sh | bash
```

{% endcode %}

#### MacOS

using homebrew:

{% code title="Install (macOS, Homebrew)" %}

```sh
brew tap dududaa/ppdrive && brew install ppdrive
```

{% endcode %}

#### Windows

using powershell:

{% code title="Install (Windows, PowerShell)" %}

```shell
powershell -NoProfile -ExecutionPolicy Bypass -Command "iwr -useb https://raw.githubusercontent.com/dududaa/ppdrive/main/install.ps1 | iex"
```

{% endcode %}
{% endstep %}

{% step %}

### Start Manager

Start PPDRIVE service manager.

{% code title="Start manager" %}

```sh
ppdrive start
```

{% endcode %}
{% endstep %}

{% step %}

### Launch Service

Launch a PPDRIVE REST Service.

{% code title="Launch REST service" %}

```sh
ppdrive launch rest
```

{% endcode %}

This will start PPDRIVE [REST Service](/ppdrive/starter-guide.md#getting-started-with-ppdrive-service) in [Client Mode](/ppdrive/starter-guide.md#auth-mode).

Now that your PPDRIVE instance is running, you can:

* Check out the [api endpoints](/ppdrive/rest-api/client.md#api-endpoints) to start connecting.
* Read the full [Starter Guide](/ppdrive/starter-guide.md) to have a better understanding of how it all fits together.
  {% endstep %}
  {% endstepper %}

## Sponsorship

If you would love to be a part of this journey, kindly [get in touch](mailto:dududaatech@gmail.com) for sponsorship.

## Contributing

We welcome contributions to PPDRIVE! Here’s how you can help:

* You can create a PPDRIVE Client for your favorite language or framework. Please check our REST API Docs to get started.
* You can help improve code-level documentations.
* Or you can contribute directly to PPDRIVE by helping us resolve an issue or implement our roadmap feature. Please follow these steps.

{% stepper %}
{% step %}
Fork the repository.
{% endstep %}

{% step %}
Create a new branch.

```sh
git checkout -b feature-name
```

{% endstep %}

{% step %}
Make your changes.
{% endstep %}

{% step %}
Commit your changes.

```sh
git commit -am 'Add new feature'
```

{% endstep %}

{% step %}
Push to your fork.

```sh
git push origin feature-name
```

{% endstep %}

{% step %}
Create a pull request.
{% endstep %}
{% endstepper %}

## License

PPDRIVE is open-source software licensed under the [MIT License](#/LICENSE).

## Acknowledgments

We ride on the shoulders of giants! We'll just mention a few:

* Dududaa: PPDRIVE is part of our ongoing Dududaa community project. You can [find us on Discord](https://discord.gg/BeVPFS7wkp).
* Rust: The systems programming language used to build PPDRIVE.
* Tokio: For Axum web framework and several other crates that simplify asynchronous Rust.
* RBatis: RBatis serves as a drive for our modeller crate and record management within PPDRIVE.
* Community: Thanks to the open-source community for their valuable contributions!


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://dududaa.gitbook.io/ppdrive/introduction.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.