From 097ec591160da338b7a52087c7acb0ac6764f5ce Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Mon, 1 Apr 2019 22:06:30 +0100 Subject: [PATCH] Bot Updating Templated Files --- images/docker-snipe-it.md | 74 +++++++++++++++++++++++---------------- 1 file changed, 43 insertions(+), 31 deletions(-) diff --git a/images/docker-snipe-it.md b/images/docker-snipe-it.md index 0f47d6bf2..6a711809c 100644 --- a/images/docker-snipe-it.md +++ b/images/docker-snipe-it.md @@ -1,30 +1,37 @@ -# linuxserver/snipe-it +# [linuxserver/snipe-it](https://github.com/linuxserver/docker-snipe-it) -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/snipe-it.svg)](https://microbadger.com/images/linuxserver/snipe-it) [![](https://images.microbadger.com/badges/image/linuxserver/snipe-it.svg)](https://microbadger.com/images/linuxserver/snipe-it) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/snipe-it.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/snipe-it.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-snipe-it/master)](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) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) +[![](https://images.microbadger.com/badges/version/linuxserver/snipe-it.svg)](https://microbadger.com/images/linuxserver/snipe-it "Get your own version badge on microbadger.com") +[![](https://images.microbadger.com/badges/image/linuxserver/snipe-it.svg)](https://microbadger.com/images/linuxserver/snipe-it "Get your own version badge on microbadger.com") +![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/snipe-it.svg) +![Docker Stars](https://img.shields.io/docker/stars/linuxserver/snipe-it.svg) +[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-snipe-it/master)](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) [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 -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/). +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/). 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 from this image. ### docker -```text +``` docker create \ --name=snipe-it \ -e PUID=1000 \ @@ -41,6 +48,7 @@ docker create \ linuxserver/snipe-it ``` + ### docker-compose Compatible with docker-compose v2 schemas. @@ -78,77 +86,80 @@ services: - PUID=1000 ports: - "8080:80" + ``` ## Parameters -Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `:` 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. +Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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`\) +### Ports (`-p`) | Parameter | Function | -| :---: | :--- | +| :----: | --- | | `80` | Snipe-IT Web UI | -### Environment Variables \(`-e`\) + +### Environment Variables (`-e`) | Env | Function | -| :---: | :--- | +| :----: | --- | | `PUID=1000` | for UserID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation | -| `APP_URL=` | Hostname or IP and port if applicable IE :8080 | +| `APP_URL=` | Hostname or IP and port if applicable IE :8080 | | `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=changeme` | Mysql password to use | -### Volume Mappings \(`-v`\) +### Volume Mappings (`-v`) | Volume | Function | -| :---: | :--- | +| :----: | --- | | `/config` | Contains your config files and data storage for Snipe-IT | + ## Optional Parameters This container also generates an SSL certificate and stores it in - -```text +``` /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: -```text +``` -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 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 | +| `-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`. +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: -```text +``` $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` @@ -157,6 +168,8 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel Access the webui at `:8080`, for more information check out [Snipe-it](https://github.com/snipe/snipe-it). + + ## Support Info * Shell access whilst the container is running: @@ -175,4 +188,3 @@ Access the webui at `:8080`, for more information check out [Snipe-it]( * **31.10.18:** - Rebasing to alpine 3.8 * **05.08.18:** - Migration to live build server. * **13.06.18:** - Initial Release. -