Portainer Templates logo

Portainer Templates

Snipe-IT Snipe-IT

Stack

ProductivityTools

IT asset manager for keeping track of laptops, licences, accessories and consumables: who has what, check-outs and check-ins, audits, maintenance, depreciation and asset tag labels. Source: https://github.com/grokability/snipe-it

Source details

Repo: grokability/snipe-it
Stars: 15.1k
Forks: 4k
Language: PHP
License: AGPL-3.0
Latest: v8.8.1 · 1 day ago
Updated: 5 hours ago
Website: snipeitapp.com/

Configuration

Type
Compose
Platform
linux
Env vars
SNIPEIT_URL=''SNIPEIT_APP_KEY=''SNIPEIT_DB_PASSWORD=''SNIPEIT_TIMEZONE=UTCSNIPEIT_PORT=8300
Restart
unless-stopped
Source
Repo

Template by NotAFlightRisk·Source

Report issue

Notes

Fill in the address, app key and database password before you deploy, since the stack won't start without them. The address has to be exactly what you'll type in the browser, like http://192.168.1.20:8300: the port you're using, and no slash at the end. Snipe-IT builds every page, link and redirect from it, so if it's wrong the front page sends you off to that address instead, and any page you do reach has no styling and buttons that go nowhere. To fix it, change the address in the stack's environment variables and redeploy. Then open the address straight away, as whoever finishes the setup wizard first becomes the admin. There are no sign-ups, the admin adds everyone else under Users. Nothing gets emailed until you add mail settings to the stack's environment variables (see the docs). Uploads and backups live in the snipeit-data volume, everything else in db-data. Docs: snipe-it.readme.io

Services

snipeit

Configuration

Image
snipe/snipe-it:v8-latest
Ports
${SNIPEIT_PORT:-8300}:80
Volumes
/var/lib/snipeit : snipeit-data
Env vars
APP_URL=${SNIPEIT_URL:?Set the address you'll open it on}APP_KEY=${SNIPEIT_APP_KEY:?Set an app key}APP_TIMEZONE=${SNIPEIT_TIMEZONE:-UTC}DB_CONNECTION=mysqlDB_HOST=dbDB_PORT=3306DB_DATABASE=snipeitDB_USERNAME=snipeitDB_PASSWORD=${SNIPEIT_DB_PASSWORD:?Set a database password}
Restart
unless-stopped

Image details

Pulls: 29.3M
User: snipe
Created: Oct 09, 2015
Updated: 5 hours ago
Status: active

db

Configuration

Image
mariadb:11.4
Volumes
/var/lib/mysql : db-data
Env vars
MARIADB_DATABASE=snipeitMARIADB_USER=snipeitMARIADB_PASSWORD=${SNIPEIT_DB_PASSWORD:?Set a database password}MARIADB_RANDOM_ROOT_PASSWORD=1
Restart
unless-stopped

Image details

Pulls: 3.2B
User: stackbrew
Created: Nov 25, 2014
Updated: 3 days ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Snipe-IT

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 Snipe-IT, 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:
  snipeit:
    image: snipe/snipe-it:v8-latest
    restart: unless-stopped
    ports:
      - "${SNIPEIT_PORT:-8300}:80"
    environment:
      APP_URL: ${SNIPEIT_URL:?Set the address you'll open it on}
      APP_KEY: ${SNIPEIT_APP_KEY:?Set an app key}
      APP_TIMEZONE: ${SNIPEIT_TIMEZONE:-UTC}
      DB_CONNECTION: mysql
      DB_HOST: db
      DB_PORT: "3306"
      DB_DATABASE: snipeit
      DB_USERNAME: snipeit
      DB_PASSWORD: ${SNIPEIT_DB_PASSWORD:?Set a database password}
    volumes:
      - snipeit-data:/var/lib/snipeit
    depends_on:
      db:
        condition: service_healthy

  db:
    image: mariadb:11.4
    restart: unless-stopped
    environment:
      MARIADB_DATABASE: snipeit
      MARIADB_USER: snipeit
      MARIADB_PASSWORD: ${SNIPEIT_DB_PASSWORD:?Set a database password}
      MARIADB_RANDOM_ROOT_PASSWORD: "1"
    volumes:
      - db-data:/var/lib/mysql
    healthcheck:
      test: ["CMD", "healthcheck.sh", "--connect", "--innodb_initialized"]
      interval: 5s
      timeout: 5s
      retries: 20

volumes:
  snipeit-data:
  db-data:

Or deploy it directly from the source:

git clone https://github.com/NotAFlightRisk/portainer-templates-extras
cd portainer-templates-extras
docker compose -f apps/snipe-it/compose.yml up -d

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

Container Documentation

snipeit Documentation

The *only* official docker hub repository for Snipe-IT from the maintainers of Snipe-IT.

db Documentation

MariaDB Server is a high performing open source relational database, forked from MySQL.

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.

Image won't pull

Test the pull directly on the host: docker pull snipe/snipe-it:v8-latest

  • "manifest unknown" means the tag no longer exists.
  • "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.

  • 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

Snipe-IT is a Compose stack, a set of containers (2 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 2 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • snipeit runs snipe/snipe-it:v8-latest, starts after db
  • db runs mariadb:11.4

Volumes

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

  • /var/lib/snipeit kept in the snipeit-data volume Docker manages
  • /var/lib/mysql kept in the db-data volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Snipe-IT takes 13 of them, and 4 need a value before it'll start properly:

  • APP_URL, needs a value
  • APP_KEY, needs a value
  • APP_TIMEZONE, defaults to UTC
  • DB_CONNECTION, defaults to mysql
  • DB_HOST, defaults to db
  • DB_PORT, defaults to 3306
  • DB_DATABASE, defaults to snipeit
  • DB_USERNAME, defaults to snipeit
  • DB_PASSWORD, needs a value
  • MARIADB_DATABASE, defaults to snipeit
  • MARIADB_USER, defaults to snipeit
  • MARIADB_PASSWORD, needs a value
  • MARIADB_RANDOM_ROOT_PASSWORD, defaults to 1

Restart policy

The restart policy here is unless-stopped, so Docker restarts Snipe-IT 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

Portainer puts these services on one shared private network, so they can find each other by name (like snipeit) while only the ports above are open to you.

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

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