Portainer Templates logo

Portainer Templates

Pingvin Pingvin

Stack

File Browsers

Pingvin Share is self-hosted file sharing platform and an alternative for WeTransfer.

Image details

Pulls: 3.2M
Architecture: amd64, arm64, arm64/v8
Image size: 177 MB
Latest: v1.13
User: stonith404
Created: Oct 11, 2022
Updated: 1 years ago
Status: active

Source details

Repo: stonith404/pingvin-share
Stars: 5k
Forks: 422
Language: TypeScript
License: BSD-2-Clause
Latest: v1.13.0 · 1 years ago
Updated: 2 months ago
Website: stonith404.github.io/pingvin-share/
Status: archived

Configuration

Type
Compose
Platform
linux
Image
stonith404/pingvin-share
Ports
3123:3000
Volumes
/opt/app/backend/data : /portainer/Files/AppData/Config/pingvin/opt/app/frontend/public/img : /portainer/Files/AppData/Config/pingvin/images
Restart
unless-stopped
Source
Repo

Template by xneo1·Source

Standalone Install

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

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 Pingvin, 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:
  pingvin-share:
    image: stonith404/pingvin-share
    restart: unless-stopped
    ports:
      - 3123:3000
    volumes:
      - /portainer/Files/AppData/Config/pingvin:/opt/app/backend/data
      - /portainer/Files/AppData/Config/pingvin/images:/opt/app/frontend/public/img
# Optional: If you add ClamAV, uncomment the following to have ClamAV start first.
#    depends_on:
#      clamav:
#        condition: service_healthy
# Optional: Add ClamAV (see README.md)  
# ClamAV is currently only available for AMD64 see https://github.com/Cisco-Talos/clamav/issues/482
#  clamav:
#    restart: unless-stopped
#    image: clamav/clamav

Or deploy it directly from the source:

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

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


Pingvin Share

Pingvin Share is a self-hosted file sharing platform and an alternative for WeTransfer.

✨ Features

  • Share files using a link
  • Unlimited file size (restricted only by disk space)
  • Set an expiration date for shares
  • Secure shares with visitor limits and passwords
  • Email recipients
  • Reverse shares
  • OIDC and LDAP authentication
  • Integration with ClamAV for security scans

🐧 Get to know Pingvin Share


⌨️ Setup

Installation with Docker (recommended)

  1. Download the docker-compose.yml file
  2. Run docker compose up -d

The website is now listening on http://localhost:3000, have fun with Pingvin Share 🐧!

📚 Documentation

For more installation options and advanced configurations, please refer to the documentation.

🖤 Contribute

We would love it if you want to help make Pingvin Share better! You can either help to translate Pingvin Share or contribute to the codebase.

Serve Pingvin 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 pingvin.example.com to http://pingvin-share:3000

Add this to your Caddyfile

pingvin.example.com {
	reverse_proxy http://pingvin-share:3000
}

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:3123 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :3123
  • Stop the other service, or pick a different host port. In 3123:3000 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:3123. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, pingvin-share can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 3123

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/pingvin (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull stonith404/pingvin-share

  • "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, arm64/v8
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

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.

Upstream project is archived

The developers have archived stonith404/pingvin-share, so bugs and security issues won't be fixed.

  • It'll keep working for now, but consider the similar apps below for a maintained alternative.

Raise an issue

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

A Compose stack

Pingvin 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 Pingvin needs bundled into one download. This template pulls stonith404/pingvin-share, which Docker fetches once (about 177 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. Pingvin's comes from Docker Hub, published by stonith404.

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 v1.13. 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, arm64/v8, 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 3123:3000 means it's reachable on port 3123 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:3123 in a browser. It opens:

  • 3123:3000, likely the web interface

Volumes

A volume is where Pingvin 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:

  • /opt/app/backend/data from /portainer/Files/AppData/Config/pingvin on the host
  • /opt/app/frontend/public/img from /portainer/Files/AppData/Config/pingvin/images on the host

Restart policy

The restart policy here is unless-stopped, so Docker restarts Pingvin after a crash or reboot, but leaves it off when you stop it on purpose. 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 Pingvin 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 pingvin-share. That's what you'll spot in the containers list and use in commands like docker logs pingvin-share.

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

Pingvin is open source, released under the BSD-2-Clause 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 Pingvin up. Add the template list to Portainer once, then deploying Pingvin is a click rather than a wall of config.