Skip to content

Latest commit

 

History

History
284 lines (217 loc) · 15.1 KB

README.md

File metadata and controls

284 lines (217 loc) · 15.1 KB
Raw

linuxserver.io

Blog Discord Discourse Fleet GitHub Open Collective

The LinuxServer.io team brings you another container release featuring:

  • regular and timely application updates
  • easy user mappings (PGID, PUID)
  • custom base image with s6 overlay
  • weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
  • regular security updates

Find us at:

  • Blog - all the things you can do with our containers including How-To guides, opinions and much more!
  • Discord - realtime support / chat with the community and the team.
  • Discourse - post on our community forum.
  • Fleet - an online web interface which displays all of our maintained images.
  • GitHub - view the source for all of our repositories.
  • Open Collective - please consider helping us by either donating or contributing to our budget

linuxserver/snipe-it

GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry MicroBadger Layers 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.

snipe-it

Supported Architectures

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 and our announcement here.

Simply pulling linuxserver/snipe-it 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 Tag
x86-64 amd64-latest
arm64 arm64v8-latest
armhf arm32v7-latest

Usage

Here are some example snippets to help you get started creating a container.

docker

docker create \
  --name=snipe-it \
  -e PUID=1000 \
  -e PGID=1000 \
  -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

docker-compose

Compatible with docker-compose v2 schemas.

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"

Parameters

Container 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
-p 80 Snipe-IT Web UI
-e PUID=1000 for UserID - see below for explanation
-e PGID=1000 for GroupID - see below for explanation
-e APP_URL=<hostname or ip> Hostname or IP and port if applicable IE :8080
-e MYSQL_PORT_3306_TCP_ADDR=<mysql host> Mysql hostname or IP to use
-e MYSQL_PORT_3306_TCP_PORT=<mysql port> Mysql port to use
-e MYSQL_DATABASE=<mysql database> Mysql database to use
-e MYSQL_USER=<mysql pass> Mysql user to use
-e MYSQL_PASSWORD=changeme Mysql password to use
-v /config Contains your config files and data storage for Snipe-IT

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.

Optional Parameters

This container also generates an SSL certificate and stores it in

/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:

-p 443:443

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

Parameter Function
-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
-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

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)

 

Application Setup

Access the webui at <your-ip>:8080, for more information check out Snipe-it.

Docker Mods

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge 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" }}' linuxserver/snipe-it

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Run/Create

  • Update the image: docker pull linuxserver/snipe-it
  • Stop the running container: docker stop snipe-it
  • Delete the container: docker rm snipe-it
  • Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
  • Start the new container: docker start snipe-it
  • You can also remove the old dangling images: docker image prune

Via Docker Compose

  • Update all images: docker-compose pull
    • or update a single image: docker-compose pull snipe-it
  • Let compose update all containers as necessary: docker-compose up -d
    • or update a single container: docker-compose up -d snipe-it
  • You can also remove the old dangling images: docker image prune

Via Watchtower auto-updater (especially useful if you don't remember the original parameters)

  • Pull the latest image at its tag and replace it with the same env variables in one run: 
    docker run --rm \
-v /var/run/docker.sock:/var/run/docker.sock \
containrrr/watchtower \
--run-once snipe-it

Note: We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using Docker Compose.

  • You can also remove the old dangling images: docker image prune

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-snipe-it.git
cd docker-snipe-it
docker build \
  --no-cache \
  --pull \
  -t linuxserver/snipe-it:latest .

The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static

docker run --rm --privileged multiarch/qemu-user-static:register --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

  • 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.