MCPcopy Index your code
hub / github.com/chibisafe/chibisafe

github.com/chibisafe/chibisafe @v6.5.5

Chat with this repo
repository ↗ · DeepWiki ↗ · release v6.5.5 ↗ · + Follow
500 symbols 1,940 edges 348 files 0 documented · 0%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

GitHub license Chat / Support Support me Support me

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 💖


<img src="https://repobeats.axiom.co/api/embed/ef349e2a33281ebd0e289a666892597deb08ee1a.svg">

Features of v6 aka Holo

  • 📄 Beautiful docs
  • 🗄️ S3 Storage Support
  • 📷 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.

For more guides and how to set up different aspects of the service please refer to the 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

msedge_AjPLFovUHQ msedge_UH0h77QQoc msedge_BlsPiNf53x msedge_iIXnaUohh6

Author

Chibisafe © Pitu, Released under the MIT License.

Authored and maintained by Pitu.

Extension points exported contracts — how you extend this code

Core symbols most depended-on inside this repo

Shape

Function 436
Interface 62
Enum 1
Method 1

Languages

TypeScript100%

Modules by API surface

packages/next/src/types.ts26 symbols
packages/backend/src/utils/File.ts19 symbols
packages/backend/src/structures/interfaces.ts13 symbols
packages/backend/src/utils/StatsGenerator.ts11 symbols
packages/next/src/components/ui/plock.tsx7 symbols
packages/backend/src/utils/Util.ts7 symbols
packages/next/src/lib/file.ts6 symbols
packages/next/src/components/mdx/Mdx.tsx6 symbols
packages/next/src/actions/UserTableActions.ts6 symbols
packages/backend/src/utils/UpdateCheck.ts6 symbols
packages/next/src/lib/mdx.ts5 symbols
packages/next/src/components/ui/pagination.tsx5 symbols

For agents

$ claude mcp add chibisafe \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page