confetti-box/README.md
2024-11-04 08:45:40 -06:00

27 lines
937 B
Markdown

# Confetti-Box 🎉
A super simple file host. Inspired by [Catbox](https://catbox.moe) and [Uguu](https://uguu.se).
## Features
### Current
- Entirely self contained, tiny (~4MB) single binary
- Customizable using a simple config file
- Only stores one copy of a given hash on the backend
- Chunked uploads of configurable size
- Fast (enough), runs just fine on a Raspberry Pi
- Simple API for interfacing with it programmatically
- No database setup required, uses self-contained in memory database
serialized to a small, LZ4 compressed file.
### Planned
- Theming
- More mochi
## Screenshot
<p align="center">
<img width="500px" src="https://github.com/user-attachments/assets/9b12d65f-257d-448f-a7d0-43068cc3f8a3">
<p align="center"><i>An example of a running instance</i></p>
</p>
## License
Confetti-Box is licensed under the terms of the GNU AGPL-3.0 license. Do what you want
with it within the terms of that license.