Bot Updating Documentation

pull/183/head
LinuxServer-CI 2024-02-17 17:41:13 +00:00
rodzic a22ca37742
commit 91ac4431d9
1 zmienionych plików z 34 dodań i 33 usunięć

Wyświetl plik

@ -36,43 +36,13 @@ The architectures supported by this image are:
## Application Setup
Access the webui at `<your-ip>:8080`, for more information check out [Snipe-it](https://github.com/snipe/snipe-it).
**This container requires a MySQL or MariaDB server to connect to, we reccomend [ours](https://github.com/linuxserver/docker-mariadb)**
"Access the webui at `<your-ip>:8080`, for more information check out [Snipe-it](https://github.com/snipe/snipe-it).
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](https://snipe-it.readme.io/docs/configuration#section-setting-a-language)|
| `-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 container requires a MySQL or MariaDB server to connect to, we recommend [ours](https://github.com/linuxserver/docker-mariadb)**
### 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
```
This image uses our NGINX base image all override configuration files for PHP are located in `/config/php`.
## Usage
@ -96,6 +66,16 @@ services:
- MYSQL_DATABASE=
- MYSQL_USER=
- MYSQL_PASSWORD=
- APP_ENV=production #optional
- APP_DEBUG=false #optional
- APP_LOCALE= #optional
- MAIL_PORT_587_TCP_ADDR=US/Pacific #optional
- MAIL_PORT_587_TCP_PORT=US/Pacific #optional
- MAIL_ENV_FROM_ADDR=US/Pacific #optional
- MAIL_ENV_FROM_NAME=US/Pacific #optional
- MAIL_ENV_ENCRYPTION=US/Pacific #optional
- MAIL_ENV_USERNAME=US/Pacific #optional
- MAIL_ENV_PASSWORD=US/Pacific #optional
volumes:
- /path/to/data:/config
ports:
@ -117,6 +97,16 @@ docker run -d \
-e MYSQL_DATABASE= \
-e MYSQL_USER= \
-e MYSQL_PASSWORD= \
-e APP_ENV=production `#optional` \
-e APP_DEBUG=false `#optional` \
-e APP_LOCALE= `#optional` \
-e MAIL_PORT_587_TCP_ADDR=US/Pacific `#optional` \
-e MAIL_PORT_587_TCP_PORT=US/Pacific `#optional` \
-e MAIL_ENV_FROM_ADDR=US/Pacific `#optional` \
-e MAIL_ENV_FROM_NAME=US/Pacific `#optional` \
-e MAIL_ENV_ENCRYPTION=US/Pacific `#optional` \
-e MAIL_ENV_USERNAME=US/Pacific `#optional` \
-e MAIL_ENV_PASSWORD=US/Pacific `#optional` \
-p 8080:80 \
-v /path/to/data:/config \
--restart unless-stopped \
@ -146,6 +136,16 @@ Containers are configured using parameters passed at runtime (such as those abov
| `MYSQL_DATABASE=` | Mysql database to use |
| `MYSQL_USER=` | Mysql user to use |
| `MYSQL_PASSWORD=` | Mysql password to use |
| `APP_ENV=production` | Default is `production` but can use `testing` or `develop`. |
| `APP_DEBUG=false` | Set to `true` to see debugging output in the web UI. |
| `APP_LOCALE=` | Default is `en`. Set to a language from [this list](https://snipe-it.readme.io/docs/configuration#section-setting-a-language). |
| `MAIL_PORT_587_TCP_ADDR=US/Pacific` | SMTP mail server ip or hostname. |
| `MAIL_PORT_587_TCP_PORT=US/Pacific` | SMTP mail server port. |
| `MAIL_ENV_FROM_ADDR=US/Pacific` | The email address mail should be replied to and listed when sent. |
| `MAIL_ENV_FROM_NAME=US/Pacific` | The name listed on email sent from the default account on the system. |
| `MAIL_ENV_ENCRYPTION=US/Pacific` | Mail encryption to use e.g. `tls`. |
| `MAIL_ENV_USERNAME=US/Pacific` | SMTP server login username. |
| `MAIL_ENV_PASSWORD=US/Pacific` | SMTP server login password. |
### Volume Mappings (`-v`)
@ -321,6 +321,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
## Versions
* **17.02.24:** - Add php81-exif.
* **03.07.23:** - Deprecate armhf. As announced [here](https://www.linuxserver.io/blog/a-farewell-to-arm-hf)
* **13.04.23:** - Move ssl.conf include to default.conf.
* **13.04.23:** - Add php81-pecl-redis for redis support.