Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blackieops/nucleus
🌤 ⚛ [WIP] Self-hosted cloud file sync backend compatible with Nextcloud clients.
https://github.com/blackieops/nucleus
cloud-native go lightweight nextcloud self-hosted
Last synced: about 17 hours ago
JSON representation
🌤 ⚛ [WIP] Self-hosted cloud file sync backend compatible with Nextcloud clients.
- Host: GitHub
- URL: https://github.com/blackieops/nucleus
- Owner: blackieops
- Created: 2022-01-22T05:48:51.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-01T20:22:38.000Z (over 1 year ago)
- Last Synced: 2024-12-20T21:13:10.828Z (4 days ago)
- Topics: cloud-native, go, lightweight, nextcloud, self-hosted
- Language: Go
- Homepage:
- Size: 211 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# nucleus: self-hosted file storage backend
[](https://github.com/blackieops/nucleus/actions/workflows/tests.yml)
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.
4. **[Nextcloud][nc]-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.
5. **Declarative configuration** - Nucleus should not require mutating itself
on-disk or writing any configuration.
6. **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.
7. **Gotta go fast** - Nucleus should be fast, efficient, and require as few
server resources as possible.
[nc]: https://www.nextcloud.com
## Development Setup
Nucleus is a [Go][go] application, using Go modules for dependency management.
[go]: https://go.dev
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 ./...
```