Portainer Templates logo

Portainer Templates

Snippet Box (stack)

Other

Snippet Box is a simple self-hosted app for organizing your code snippets. It allows you to easily create, edit, browse and manage your snippets in various languages.

Image details

Pulls: 2.5M
Architecture: amd64, arm64, arm/v7
Image size: 58 MB
User: pawelmalak
Created: Sep 23, 2021
Updated: 4 years ago
Status: active

Source details

Repo: pawelmalak/snippet-box
Stars: 1k
Forks: 92
Language: TypeScript
License: MIT
Updated: 3 years ago

Configuration

Type
Compose
Platform
linux
Image
pawelmalak/snippet-box
Ports
5000:5000
Volumes
/app/data : /portainer/Files/AppData/Config/snippetbox/data
Restart
unless-stopped
Source
Repo

Template by xneo1·Source

Standalone Install

Select an install method, to see config/commands for deploying Snippet Box (stack)

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 Snippet Box (stack), 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:
  snippet-box:
    image: pawelmalak/snippet-box
    container_name: snippet-box
    volumes:
      - /portainer/Files/AppData/Config/snippetbox/data:/app/data
    ports:
      - 5000:5000
    restart: unless-stopped

Or deploy it directly from the source:

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

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

Snippet Box

Snippet library screenshot

Description

Snippet Box is a simple self-hosted app for organizing your code snippets. It allows you to easily create, edit, browse and manage your snippets in various languages. With built-in Markdown support, Snippet Box makes it very easy to add notes or simple documentation to your code.

Technology

  • Backend
- Node.js - Express.js - Sequelize ORM + SQLite
  • Frontend
- React - TypeScript - Bootstrap
  • Deployment
- Docker

Development

# clone repository
git clone https://github.com/pawelmalak/snippet-box
cd snippet-box

# install dependencies (run only once)
npm run init

# start backend and frontend development servers
npm run dev

Installation

With Docker

Building image

docker build -t snippet-box .

Deployment

# run container
docker run -p 5000:5000 -v /path/to/data:/app/data snippet-box

Functionality

  • Pinned snippets
- Pin your favorite / important snippets to home screen for easy and quick access
Homescreen screenshot
  • Snippet library
- Manage your snippets through snippet library - Easily filter and access your code
Snippet library screenshot
  • Snippet
- View your code, snippet details and documentation - Easily perform snippet actions like edit, pin or delete from a single place
Snippet screenshot
  • Edditor
- Create and edit your snippets from simple and easy to use editor
Editor screenshot

Serve Snippet Box (stack) 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 snippet-box-stack.example.com to http://snippet-box:5000

Add this to your Caddyfile

snippet-box-stack.example.com {
	reverse_proxy http://snippet-box:5000
}

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

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

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/snippetbox/data

Image won't pull

Test the pull directly on the host: docker pull pawelmalak/snippet-box

  • "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, arm/v7
  • 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.

Raise an issue

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

A Compose stack

Snippet Box (stack) 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 Snippet Box (stack) needs bundled into one download. This template pulls pawelmalak/snippet-box, which Docker fetches once (about 58 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. Snippet Box (stack)'s comes from Docker Hub, published by pawelmalak.

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. 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, arm/v7, 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 5000:5000 means it's reachable on port 5000 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 5000:5000

Volumes

A volume is where Snippet Box (stack) 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:

  • /app/data from /portainer/Files/AppData/Config/snippetbox/data on the host

Restart policy

The restart policy here is unless-stopped, so Docker restarts Snippet Box (stack) 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 Snippet Box (stack) 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 snippet-box. That's what you'll spot in the containers list and use in commands like docker logs snippet-box.

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

Snippet Box (stack) 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 Snippet Box (stack) up. Add the template list to Portainer once, then deploying Snippet Box (stack) is a click rather than a wall of config.