> For the complete documentation index, see [llms.txt](https://docs.openvoxel.studio/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openvoxel.studio/cloudvoxel-welcome.md).

# CloudVoxel - Welcome!

CloudVoxel is an Open-Source local-first solution to file sharing!

## CloudVoxel?

### What is CloudVoxel?

CloudVoxel is a robust file-sharing platform that puts you in control:

* 📤 **Unlimited Uploads**: No arbitrary file size restrictions
* 🔗 **File Sharing**: Share files with others, even if they are not logged in
* 🔒 **Access Control**: User whitelisting by their email address
* 💡 **Open Source**: Community-driven development and transparency

{% hint style="info" %}
Check out our **Github** repository for the full source code: <https://github.com/OpenVoxelStudios/CloudVoxel>
{% endhint %}

### Why CloudVoxel?

CloudVoxel is born with the idea of a simple open-source file hosting and sharing platform to deploy in your local network or on a VPS. [Kubik](https://github.com/KodeurKubik) (the repository maintainer) initially created this for [OpenVoxel Studios](https://openvoxel.studio) for an intern file sharing service, but it turned out to be better to just open-source the whole code!

## Let's get starting!

### Downloading your instance

CloudVoxel will run where ever you want. On a raspberry pi or on a VPS it should work out of the box!

{% hint style="info" %}
Check out the [Installation](/server-management/installation.md) guide to proceed with the installation!
{% endhint %}

### Configuring your instance

Configurng CloudVoxel has to be done the first time before running your instance. There are a few files that have to be changed but then, you're ready to go!

{% hint style="info" %}
Visit the [Configuration](/server-management/configuration.md) guide to learn how to configure your instance!
{% endhint %}

### Running your instance

Now that everything is ready, you can start running your instance! You can either run a development server first to test everything or directly run the production server.

{% hint style="info" %}
But more about that on the [Starting the server](/server-management/starting-the-server.md) page where you will learn how to start your server!
{% endhint %}