nucleus: self-hosted file storage backend

Nucleus helps you sync and store your files on your own infrastructure.

⚠️ Warning: this is a very early-stage project that is NOT feature complete, safe to use, nor secure. Do not use this in production yet.

Project Goals

Nucleus' primary goal is to be a fast, secure, and light-weight cloud file storage and sync backend.

1. Pluggable Storage - Nucleus should allow configuring different backing storage implementations, for example with cloud object storage.
2. Files only - Nucleus does not want to replace your entire workgroups solution, your project management software, your video call software, your chat software... Nucleus is exclusively a file storage solution.
3. Nextcloud-compatible - To easily fit into existing workflows, Nucleus should be reasonably compatible with Nextcloud client apps, exposing an API they expect so you can swap your Nextcloud server for Nucleus and pick up where you left off with minimal interruption.
4. Declarative configuration - Nucleus should not require mutating itself on-disk or writing any configuration.
5. Scale-out, not up - Nucleus should easily allow for scale-out infrastructure, support immutable filesystems, and fit right at home in a cloud-native environment.
6. Gotta go fast - Nucleus should be fast, efficient, and require as few server resources as possible.

Development Setup

Nucleus is a Go application, using Go modules for dependency management.

A docker-compose.yml is provided to run the dependent services (i.e., postgresql). Use any Docker Compose-compatible tool to get that started:

$ docker compose up -d

First fetch and install dependencies:

$ go mod tidy

Then set up your config file. An example is provided:

$ cp config.yaml.example config.yaml

Once configured, you can migrate the database:

$ go run . -migrate

And then run the project:

$ go run .

Test Data

If you want to start off with a test user, credentials, and possibly other placeholder data, you can run the seeds:

$ go run . -seed

The default user is admin with a password credential of password123.

Testing

A test suite is provided. It uses a separate config file to separate it from the "normal" runtime.

$ cp config.yaml.example config.test.yaml

Edit the config.test.yaml to point to a different database, for best results.

Then migrate the test database:

$ go run . -config config.test.yaml -migrate

And then you can run the test suite for everything:

$ go test ./...