2019-10-03 19:51:43 +00:00
# [linuxserver/snipe-it](https://github.com/linuxserver/docker-snipe-it)
2019-02-07 20:51:33 +00:00
2019-10-31 20:50:48 +00:00
[![GitHub Stars ](https://img.shields.io/github/stars/linuxserver/docker-snipe-it.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF )](https://github.com/linuxserver/docker-snipe-it)
[![GitHub Release ](https://img.shields.io/github/release/linuxserver/docker-snipe-it.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF )](https://github.com/linuxserver/docker-snipe-it/releases)
[![GitHub Package Repository ](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF )](https://github.com/linuxserver/docker-snipe-it/packages)
[![GitLab Container Registry ](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF )](https://gitlab.com/Linuxserver.io/docker-snipe-it/container_registry)
[![Quay.io ](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io )](https://quay.io/repository/linuxserver.io/snipe-it)
2019-10-03 19:51:43 +00:00
[![MicroBadger Layers ](https://img.shields.io/microbadger/layers/linuxserver/snipe-it.svg?style=flat-square&color=E68523 )](https://microbadger.com/images/linuxserver/snipe-it "Get your own version badge on microbadger.com")
2019-10-31 20:50:48 +00:00
[![Docker Pulls ](https://img.shields.io/docker/pulls/linuxserver/snipe-it.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF )](https://hub.docker.com/r/linuxserver/snipe-it)
[![Docker Stars ](https://img.shields.io/docker/stars/linuxserver/snipe-it.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF )](https://hub.docker.com/r/linuxserver/snipe-it)
2019-10-03 19:51:43 +00:00
[![Build Status ](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-snipe-it/job/master/badge/icon?style=flat-square )](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-snipe-it/job/master/)
[![ ](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/snipe-it/latest/badge.svg )](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/snipe-it/latest/index.html)
2019-02-07 20:51:33 +00:00
[Snipe-it ](https://github.com/snipe/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
2019-09-05 19:51:00 +00:00
Our images support multiple architectures such as `x86-64` , `arm64` and `armhf` . We utilise the docker manifest for multi-platform awareness. More information is available from docker [here ](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list ) and our announcement [here ](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/ ).
2019-02-07 20:51:33 +00:00
2019-02-13 08:46:49 +00:00
Simply pulling `linuxserver/snipe-it` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2019-02-07 20:51:33 +00:00
The architectures supported by this image are:
| Architecture | Tag |
2019-10-03 19:51:43 +00:00
| :----: | --- |
2019-02-07 20:51:33 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 19:27:24 +00:00
| armhf | arm32v7-latest |
2019-02-07 20:51:33 +00:00
2019-10-03 19:51:43 +00:00
2019-02-07 20:51:33 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
2019-10-03 19:51:43 +00:00
```
2019-02-07 20:51:33 +00:00
docker create \
--name=snipe-it \
2019-03-07 20:50:47 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-07 20:51:33 +00:00
-e APP_URL=< hostname or ip > \
-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 \
-p 8080:80 \
-v < path to snipe-it data > :/config \
--restart unless-stopped \
linuxserver/snipe-it
```
2019-10-03 19:51:43 +00:00
2019-02-07 20:51:33 +00:00
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
version: "3"
services:
mysql:
image: mysql:5
container_name: snipe_mysql
restart: always
volumes:
- < path to mysql data > :/var/lib/mysql
environment:
- MYSQL_ROOT_PASSWORD=< secret password >
- MYSQL_USER=snipe
- MYSQL_PASSWORD=< secret user password >
- MYSQL_DATABASE=snipe
snipeit:
image: linuxserver/snipe-it:latest
container_name: snipe-it
restart: always
depends_on:
- mysql
volumes:
- < path to data > :/config
environment:
- APP_URL=< your application URL IE 192 . 168 . 10 . 1:8080 >
- MYSQL_PORT_3306_TCP_ADDR=mysql
- MYSQL_PORT_3306_TCP_PORT=3306
- MYSQL_DATABASE=snipe
- MYSQL_USER=snipe
- MYSQL_PASSWORD=< secret user password >
- PGID=1000
- PUID=1000
ports:
- "8080:80"
2019-10-03 19:51:43 +00:00
2019-02-07 20:51:33 +00:00
```
## Parameters
2019-10-03 19:51:43 +00:00
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.
2019-02-07 20:51:33 +00:00
2019-10-03 19:51:43 +00:00
### Ports (`-p`)
2019-02-07 20:51:33 +00:00
| Parameter | Function |
2019-10-03 19:51:43 +00:00
| :----: | --- |
2019-02-07 20:51:33 +00:00
| `80` | Snipe-IT Web UI |
2019-10-03 19:51:43 +00:00
### Environment Variables (`-e`)
2019-02-07 20:51:33 +00:00
| Env | Function |
2019-10-03 19:51:43 +00:00
| :----: | --- |
2019-03-07 20:50:47 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-10-03 19:51:43 +00:00
| `APP_URL=<hostname or ip>` | Hostname or IP and port if applicable IE < ip or hostname > :8080 |
2019-02-07 20:51:33 +00:00
| `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 |
2019-10-03 19:51:43 +00:00
### Volume Mappings (`-v`)
2019-02-07 20:51:33 +00:00
| Volume | Function |
2019-10-03 19:51:43 +00:00
| :----: | --- |
2019-02-07 20:51:33 +00:00
| `/config` | Contains your config files and data storage for Snipe-IT |
2019-10-03 19:51:43 +00:00
2019-02-07 20:51:33 +00:00
## Optional Parameters
This container also generates an SSL certificate and stores it in
2019-10-03 19:51:43 +00:00
```
2019-02-07 20:51:33 +00:00
/config/keys/cert.crt
/config/keys/key.crt
```
To use your own certificate swap these files with yours. To use SSL forward your port to 443 inside the container IE:
2019-10-03 19:51:43 +00:00
```
2019-02-07 20:51:33 +00:00
-p 443:443
```
The application accepts a series of environment variables to further customize itself on boot:
| Parameter | Function |
2019-10-03 19:51:43 +00:00
| :---: | --- |
| `-e APP_TIMEZONE=` | The timezone the application will use IE US/Pacific|
| `-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][localesurl]|
| `-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|
2019-02-07 20:51:33 +00:00
| `-e MAIL_ENV_ENCRYPTION=` | Mail encryption to use IE tls |
2019-10-03 19:51:43 +00:00
| `-e MAIL_ENV_USERNAME=` | SMTP server login username|
| `-e MAIL_ENV_PASSWORD=` | SMTP server login password|
2019-02-07 20:51:33 +00:00
## User / Group Identifiers
2019-10-03 19:51:43 +00:00
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` .
2019-02-07 20:51:33 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2019-03-07 20:50:47 +00:00
In this instance `PUID=1000` and `PGID=1000` , to find yours use `id user` as below:
2019-02-07 20:51:33 +00:00
2019-10-03 19:51:43 +00:00
```
2019-02-07 20:51:33 +00:00
$ id username
2019-03-07 20:50:47 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-07 20:51:33 +00:00
```
## Application Setup
Access the webui at `<your-ip>:8080` , for more information check out [Snipe-it ](https://github.com/snipe/snipe-it ).
2019-10-03 19:51:43 +00:00
2019-02-07 20:51:33 +00:00
## Support Info
2019-09-05 19:51:00 +00:00
* Shell access whilst the container is running:
2019-02-07 20:51:33 +00:00
* `docker exec -it snipe-it /bin/bash`
2019-09-05 19:51:00 +00:00
* To monitor the logs of the container in realtime:
2019-02-07 20:51:33 +00:00
* `docker logs -f snipe-it`
2019-09-05 19:51:00 +00:00
* Container version number
2019-02-07 20:51:33 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' snipe-it`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/snipe-it`
## Versions
2019-06-30 19:37:22 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-05-28 23:46:43 +00:00
* **10.04.19:** - Add php deps for V4.7.0, ensure framework directories are available at build time.
2019-04-11 12:15:04 +00:00
* **10.04.19:** - Fix permissions for new bootstrap cache directory.
2019-03-24 19:27:24 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-24 04:10:06 +00:00
* **22.02.19:** - Rebasing to alpine 3.9.
2019-02-07 20:51:33 +00:00
* **31.10.18:** - Rebasing to alpine 3.8
* **05.08.18:** - Migration to live build server.
* **13.06.18:** - Initial Release.