linuxserver/snipe-it
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.
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> |
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= | |
-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 |
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 = 16
post_max_size = 16M
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
---
version: "2.1"
services:
snipe-it:
image: lscr.io/linuxserver/snipe-it:latest
container_name: snipe-it
environment:
- PUID=1000
- PGID=1000
- APP_URL=http://localhost:8080
- MYSQL_PORT_3306_TCP_ADDR=<mysql host>
- MYSQL_PORT_3306_TCP_PORT=<mysql port>
- MYSQL_DATABASE=<mysql database>
- MYSQL_USER=<mysql pass>
- MYSQL_PASSWORD=changeme
- TZ=US/Pacific
volumes:
- <path to snipe-it data>:/config
ports:
- 8080:80
restart: unless-stopped
docker run -d \
--name=snipe-it \
-e PUID=1000 \
-e PGID=1000 \
-e APP_URL=http://localhost:8080 \
-e MYSQL_PORT_3306_TCP_ADDR=<mysql host> \
-e MYSQL_PORT_3306_TCP_PORT=<mysql port> \
-e MYSQL_DATABASE=<mysql database> \
-e MYSQL_USER=<mysql pass> \
-e MYSQL_PASSWORD=changeme \
-e TZ=US/Pacific \
-p 8080:80 \
-v <path to snipe-it data>:/config \
--restart unless-stopped \
lscr.io/linuxserver/snipe-it:latest
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.Parameter | Function |
|---|---|
80 | Snipe-IT Web UI |
Env | Function |
|---|---|
PUID=1000 | for UserID - see below for explanation |
PGID=1000 | for GroupID - see below for explanation |
APP_URL=http://localhost:8080 | Hostname or IP and port if applicable, be sure to define https/http |
MYSQL_PORT_3306_TCP_ADDR=<mysql host> | Mysql hostname or IP to use |
MYSQL_PORT_3306_TCP_PORT=<mysql port> | Mysql port to use |
MYSQL_DATABASE=<mysql database> | Mysql database to use |
MYSQL_USER=<mysql pass> | Mysql user to use |
MYSQL_PASSWORD=changeme | Mysql password to use |
TZ=US/Pacific | Specify a timezone to use EG Europe/London, this is required to run snipe-it |
Volume | Function |
|---|---|
/config | Contains your config files and data storage for Snipe-IT |
Miscellaneous Options
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.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.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)
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.
- 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
- 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.
Last modified 10d ago