Bot Updating Documentation

pull/38/head
LinuxServer-CI 2021-04-18 02:36:15 +00:00
rodzic 7ae4fa3b73
commit 09565e3a03
1 zmienionych plików z 7 dodań i 12 usunięć

Wyświetl plik

@ -1,6 +1,9 @@
---
title: apprise-api
---
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read the https://github.com/linuxserver/docker-apprise-api/blob/main/.github/CONTRIBUTING.md -->
# [linuxserver/apprise-api](https://github.com/linuxserver/docker-apprise-api)
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-apprise-api.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-apprise-api)
@ -21,7 +24,6 @@ title: apprise-api
Apprise API was designed to easily fit into existing (and new) eco-systems that are looking for a simple notification solution.
## 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/).
@ -36,7 +38,6 @@ The architectures supported by this image are:
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
## Usage
Here are some example snippets to help you get started creating a container from this image.
@ -65,7 +66,7 @@ services:
### docker cli
```
```bash
docker run -d \
--name=apprise-api \
-e PUID=1000 \
@ -77,7 +78,6 @@ docker run -d \
ghcr.io/linuxserver/apprise-api
```
## Parameters
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.
@ -88,7 +88,6 @@ Docker images are configured using parameters passed at runtime (such as those a
| :----: | --- |
| `8000` | Port for apprise's interface and API. |
### Environment Variables (`-e`)
| Env | Function |
@ -103,15 +102,13 @@ Docker images are configured using parameters passed at runtime (such as those a
| :----: | --- |
| `/config` | Where config is stored. |
## Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
```
```bash
-e FILE__PASSWORD=/run/secrets/mysecretpassword
```
@ -122,7 +119,6 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/
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](https://en.wikipedia.org/wiki/Umask) before asking for support.
## 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`.
@ -131,18 +127,17 @@ Ensure any volume directories on the host are owned by the same user you specify
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
```
```bash
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
## Docker Mods
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=apprise-api&query=%24.mods%5B%27apprise-api%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=apprise-api "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
We publish various [Docker Mods](https://github.com/linuxserver/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.
## Support Info
* Shell access whilst the container is running: