Portainer Templates logo

Portainer Templates

Chibisafe Chibisafe

Stack

File Browsers

Chibisafe is a modern and self-hosted take on file uploading services that can handle anything you throw at it thanks to it's robust and fast API, chunked uploads support and more.

Image details

Pulls: 347k
Architecture: amd64, arm64
Image size: 66 MB
Latest: v6.5.5
User: itspitu
Created: Jul 12, 2023
Updated: 2 months ago
Status: active

Source details

Repo: chibisafe/chibisafe
Stars: 3k
Forks: 298
Language: TypeScript
License: MIT
Latest: v6.5.5 · 1 years ago
Updated: 2 months ago
Website: chibisafe.app/

Configuration

Type
Compose
Platform
linux
Image
chibisafe/chibisafe:latest
Ports
2425:8000
Volumes
/home/node/chibisafe/database : /portainer/Files/AppData/Config/chibisafe/db/home/node/chibisafe/uploads : /portainer/Files/AppData/Config/chibisafe/uploads/home/node/chibisafe/logs : /portainer/Files/AppData/Config/chibisafe/logs
Restart
on-failure:5
Source
Repo

Template by xneo1·Source

Standalone Install

Select an install method, to see config/commands for deploying Chibisafe

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Chibisafe, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  chibisafe:
    image: chibisafe/chibisafe:latest
    container_name: Chibisafe
    mem_limit: 8g
    cpu_shares: 2048
    security_opt:
      - no-new-privileges:true
    volumes:
      - /portainer/Files/AppData/Config/chibisafe/db:/home/node/chibisafe/database:rw
      - /portainer/Files/AppData/Config/chibisafe/uploads:/home/node/chibisafe/uploads:rw
      - /portainer/Files/AppData/Config/chibisafe/logs:/home/node/chibisafe/logs:rw
    ports:
      - 2425:8000
    restart: on-failure:5

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/chibisafe.yml up -d

More install options in our documentation, or see chibisafe/chibisafe for app-specific guidance.


GitHub license Chat / Support Support me Support me

What is Chibisafe?

Chibisafe is a file uploader service written in node that aims to to be easy to use and easy to set up. 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.
It supports both public and private mode. Public mode let's anyone sign up and start uploading files to the service, whereas private mode only users with an invite link can do so. During upload, if the file is big it's automatically split into chunks to minimize the chance of network failures enabling you to retry each chunk up to 5 times. Users can also create an API key to use with 3rd party applications to interact directly with their account.
The service also comes with a control panel 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 ratelimit, max file size, accepted extensions, meta descriptions, etc directly from an 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

  • Beautiful docs
  • Chunked uploads
  • Share direct links to uploaded files
  • Albums/Folders with direct links to share
  • File management
  • File tagging
  • User management
  • User quotas
  • Update checker
  • Public or Private mode (with invite support)
  • ShareX support out-of-the-box to upload screenshots/screenrecordings from your desktop
  • Browser extension to upload content from websites easily
  • Easily extensible
  • Open source
  • No tracking (except for IP logging of requests)
  • No ads

Installing and running chibisafe

To deploy chibisafe with docker you have a few options. If you want the latest features you can clone the repository and then run docker-compose up.
If you want to use the latest stable image published by us you can make a docker-compose.yml file with the following contents and then run docker-compose up: 
version: "3.7"

services:
  chibisafe:
    image: chibisafe/chibisafe:latest
    container_name: chibisafe
    volumes:
      - ./database:/home/node/chibisafe/database:rw
      - ./uploads:/home/node/chibisafe/uploads:rw
      - ./logs:/home/node/chibisafe/logs:rw
    ports:
      - 24424:8000
    restart: always
Or if you prefer to use docker directly, you could do something like this replacing the path values (if necessary) with your own: 
docker run -d \
  --name=chibisafe \
  -v ./database:/home/node/chibisafe/database:rw \
  -v ./uploads:/home/node/chibisafe/uploads:rw \
  -v ./logs:/home/node/chibisafe/logs:rw \
  -p 24424:8000 \
  --restart unless-stopped \
  chibisafe/chibisafe:latest

Now chibisafe will be available in port 24424.
For more in-depth configurations Please refer to the docs here

Screenshots

image image image

Author

Chibisafe © Pitu, Released under the MIT License.
Authored and maintained by Pitu.

Serve Chibisafe on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying chibisafe.example.com to http://chibisafe:8000

Add this to your Caddyfile

chibisafe.example.com {
	reverse_proxy http://chibisafe:8000
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:2425 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :2425
  • Stop the other service, or pick a different host port. In 2425:8000 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:2425. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, chibisafe can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 2425

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/chibisafe/db (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull chibisafe/chibisafe:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Chibisafe is a Compose stack, a set of containers defined in one file and brought up together by Portainer, then started and stopped as a single app.

The app image

An image is the app packed up ready to go, everything Chibisafe needs bundled into one download. This template pulls chibisafe/chibisafe:latest, which Docker fetches once (about 66 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Chibisafe's comes from Docker Hub, published by chibisafe.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is v6.5.5. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 2425:8000 means it's reachable on port 2425 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:2425 in a browser. It opens:

  • 2425:8000, likely the web interface

Volumes

A volume is where Chibisafe keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /home/node/chibisafe/database from /portainer/Files/AppData/Config/chibisafe/db on the host
  • /home/node/chibisafe/uploads from /portainer/Files/AppData/Config/chibisafe/uploads on the host
  • /home/node/chibisafe/logs from /portainer/Files/AppData/Config/chibisafe/logs on the host

Restart policy

The restart policy here is on-failure:5, so Chibisafe won't come back on its own after a crash or reboot. You bring it up again whenever you're ready. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Nothing custom is set, so Chibisafe sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container chibisafe. That's what you'll spot in the containers list and use in commands like docker logs chibisafe.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

Chibisafe is open source, released under the MIT license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Chibisafe up. Add the template list to Portainer once, then deploying Chibisafe is a click rather than a wall of config.