Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chibisafe/chibisafe
Blazing fast file vault written in TypeScript! 🚀
https://github.com/chibisafe/chibisafe
chibisafe file file-upload file-uploader files fileuploader js node pomf screenshots upload uploader video
Last synced: about 2 months ago
JSON representation
Blazing fast file vault written in TypeScript! 🚀
- Host: GitHub
- URL: https://github.com/chibisafe/chibisafe
- Owner: chibisafe
- License: mit
- Created: 2017-01-13T07:28:41.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T21:51:27.000Z (5 months ago)
- Last Synced: 2024-04-13T21:54:12.976Z (5 months ago)
- Topics: chibisafe, file, file-upload, file-uploader, files, fileuploader, js, node, pomf, screenshots, upload, uploader, video
- Language: TypeScript
- Homepage: https://chibisafe.app
- Size: 12.7 MB
- Stars: 1,485
- Watchers: 25
- Forks: 258
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-blazingly-fast - chibisafe - Blazing fast file uploader and awesome bunker written in node! 🚀 (JavaScript)
- starred - chibisafe/chibisafe - Blazing fast file vault written in TypeScript! 🚀 (TypeScript)
- awesome-github-star - chibisafe
- awesome-homelab - Chibisafe
README
[](https://raw.githubusercontent.com/chibisafe/chibisafe/master/LICENSE)
[](https://discord.gg/5g6vgwn)
[](https://www.patreon.com/pitu)
[](https://www.buymeacoffee.com/kana)
## What is Chibisafe?
Chibisafe is a file uploader service written in typescript that just works. It's easy to use, easy to deploy, free and open source. It accepts files, photos, documents, anything you imagine and gives you back a shareable link for you to send to others.
You can run it in public mode, user accounts mode or invite-only mode. Big files are automatically chunked to minimize network failure and users can create an API key to use the service programatically and hook it to other things.
The service also comes with a dashboard where you can edit almost every configuration of the instance directly from the UI without having to touch environment or configuration files manually. Control the name, the rate limit, max file size, accepted extensions, meta descriptions, etc directly from our intuitive panel.
_If you fork/deploy your own instance it would mean a lot if you were to keep either the GitHub logo to our repo or a link to it 💖_
---
### Features of v6 aka Holo
- 📄 [Beautiful docs](https://chibisafe.app/docs)
- 🗄️ [S3 Storage Support](https://github.com/chibisafe/chibisafe/blob/master/docs/s3.md)
- 📷 Beautiful masonry to browse media files
- ✨ Chunked uploads for big files
- 🔗 Share direct links to uploaded files
- 📂 Albums/Folders with direct links to share
- 📝 Snippets/Gists creation with direct links to share
- 🗃️ File management and file tagging
- 🙋 User management and quotas
- 🔗 Built-in URL shortener
- ✉️ Public or Private mode (with invite support)
- ⬆️ ShareX support out-of-the-box to upload screenshots/screenrecordings from your desktop
- 📱 iOS shortcut to upload files through the share menu
- 🌐 Browser extension to upload content from websites easily
- 🧩 Easily extensible
- 📖 Open source
- 🚫 No ads and no tracking (except for IP logging of requests)
## Installing and running chibisafe
Whichever method you choose to install chibisafe keep in mind that the installation process creates an account named `admin` with the same password. Once you log in the first time make sure to change it! Also we ***highly*** recommend using docker for chibisafe.
- [Running chibisafe with Docker](https://chibisafe.app/guides/running-with-docker) | [Alternate link](https://github.com/chibisafe/chibisafe/blob/master/packages/next/src/content/guides/running-with-docker.mdx)
- [Running chibisafe manually](https://chibisafe.app/guides/running-manually) | [Alternate link](https://github.com/chibisafe/chibisafe/blob/master/packages/next/src/content/guides/running-manually.mdx)
- [Using network storage with chibisafe](https://chibisafe.app/guides/using-network-storage) | [Alternate link](https://github.com/chibisafe/chibisafe/blob/master/packages/next/src/content/guides/using-network-storage.mdx)
For more guides and how to set up different aspects of the service [please refer to the guides](https://chibisafe.app/guides)
## Migrate from older versions
### v5 to v6
If you come from v5 you might be used to chibisafe exposing 1 single port for you to reverse proxy into nginx/caddy/apache. Starting from v6 this is also the case (although port is now 24424) as long as you run the configuration we provide with docker. Other than configuring your reverse proxy accordingly, all you need to do to migrate is to copy both the `uploads/` and `database/` folders into your new instance folder. Once chibisafe starts it will apply the necessary migrations automatically.
> [!CAUTION]
> Migrating from an older version than v5 to v6 is not possible, so we recommend setting up a new instance instead.
### Screenshots
## Author
**Chibisafe** © [Pitu](https://github.com/Pitu), Released under the [MIT](https://github.com/WeebDev/chibisafe/blob/master/LICENSE) License.
Authored and maintained by Pitu.
