mirror
/
docker-documentation
kopia lustrzana https://github.com/linuxserver/docker-documentation
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność
docker-documentation/images/docker-snipe-it.md

12 KiB
Czysty Wina Historia

title
snipe-it

linuxserver/snipe-it

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI

Snipe-it makes asset management easy. It was built by people solving real-world IT and asset management problems, and a solid UX has always been a top priority. Straightforward design and bulk actions mean getting things done faster.

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/snipe-it:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture Available Tag
x86-64 ✅ amd64-<version tag>
arm64 ✅ arm64v8-<version tag>
armhf ✅ arm32v7-<version tag>

Application Setup

Access the webui at <your-ip>:8080, for more information check out Snipe-it. This container requires a MySQL or MariaDB server to connect to, we reccomend ours

This container also generates an SSL certificate and stores it in

/config/keys/cert.crt
/config/keys/cert.key

To use your own certificate swap these files with yours. To use SSL forward your port to 443 inside the container IE:

-p 443:443

The application accepts a series of environment variables to further customize itself on boot:

Parameter Function
-e APP_ENV= Default is production but can use testing or develop
-e APP_DEBUG= Set to true to see debugging output in the web UI
-e APP_LOCALE= Default is en set to the language preferred full list here
-e MAIL_PORT_587_TCP_ADDR= SMTP mailserver ip or hostname
-e MAIL_PORT_587_TCP_PORT= SMTP mailserver port
-e MAIL_ENV_FROM_ADDR= The email address mail should be replied to and listed when sent
-e MAIL_ENV_FROM_NAME= The name listed on email sent from the default account on the system
-e MAIL_ENV_ENCRYPTION= Mail encryption to use IE tls
-e MAIL_ENV_USERNAME= SMTP server login username
-e MAIL_ENV_PASSWORD= SMTP server login password

PHP customization

This image uses our NGINX base image all configuration files for PHP and NGINX are located in /config/php. To overide any defaults please modify /config/php/php-local.ini IE for upload size:

upload_max_filesize = 16M
post_max_size = 16M

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

docker-compose (recommended, click here for more info)

---
version: "2.1"
services:
  snipe-it:
    image: lscr.io/linuxserver/snipe-it:latest
    container_name: snipe-it
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - APP_URL=http://localhost:8080
      - MYSQL_PORT_3306_TCP_ADDR=
      - MYSQL_PORT_3306_TCP_PORT=
      - MYSQL_DATABASE=
      - MYSQL_USER=
      - MYSQL_PASSWORD=
    volumes:
      - /path/to/data:/config
    ports:
      - 8080:80
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=snipe-it \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e APP_URL=http://localhost:8080 \
  -e MYSQL_PORT_3306_TCP_ADDR= \
  -e MYSQL_PORT_3306_TCP_PORT= \
  -e MYSQL_DATABASE= \
  -e MYSQL_USER= \
  -e MYSQL_PASSWORD= \
  -p 8080:80 \
  -v /path/to/data:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/snipe-it:latest

Parameters

Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter Function
80 Snipe-IT Web UI

Environment Variables (-e)

Env Function
PUID=1000 for UserID - see below for explanation
PGID=1000 for GroupID - see below for explanation
TZ=Etc/UTC specify a timezone to use, see this list.
APP_URL=http://localhost:8080 Hostname or IP and port if applicable, be sure to define https/http
MYSQL_PORT_3306_TCP_ADDR= Mysql hostname or IP to use
MYSQL_PORT_3306_TCP_PORT= Mysql port to use
MYSQL_DATABASE= Mysql database to use
MYSQL_USER= Mysql user to use
MYSQL_PASSWORD= Mysql password to use

Volume Mappings (-v)

Volume Function
/config Contains your config files and data storage for Snipe-IT

Miscellaneous Options

Parameter Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Docker Mods

Docker Mods Docker Universal Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

  • Shell access whilst the container is running:
    • docker exec -it snipe-it /bin/bash
  • To monitor the logs of the container in realtime:
    • docker logs -f snipe-it
  • Container version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' snipe-it
  • Image version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/snipe-it:latest

Versions

  • 13.04.23: - Move ssl.conf include to default.conf.
  • 13.04.23: - Add php81-pecl-redis for redis support.
  • 28.12.22: - Rebase to Alpine 3.17, migrate to s6v3.
  • 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
  • 14.05.22: - Add php7-sodium for v6.
  • 12.04.22: - Don't build development elements.
  • 02.03.22: - Rework init logic, do not show default compose.
  • 29.06.21: - Rebasing to alpine 3.14.
  • 30.04.21: - Rebasing to alpine 3.13, add artisan migrate on spinup.
  • 01.06.20: - Rebasing to alpine 3.12.
  • 19.12.19: - Rebasing to alpine 3.11.
  • 28.06.19: - Rebasing to alpine 3.10.
  • 10.04.19: - Add php deps for V4.7.0, ensure framework directories are available at build time.
  • 10.04.19: - Fix permissions for new bootstrap cache directory.
  • 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
  • 22.02.19: - Rebasing to alpine 3.9.
  • 31.10.18: - Rebasing to alpine 3.8
  • 05.08.18: - Migration to live build server.
  • 13.06.18: - Initial Release.