extern/apprise-api
1
0
Fork 0
mirror of https://github.com/caronc/apprise-api.git synced 2024-12-04 22:10:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

README references Docker Pulls

Browse Source
This commit is contained in:
Chris Caron 2020-01-03 09:30:54 -05:00
parent b54b795c0c
commit 61a1f68a31
2 changed files with 32 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Dockerfile
View File

@ -30,18 +30,18 @@ RUN curl -fL -o /tmp/s6-overlay.tar.gz \
ENV S6_KEEP_ENV=1 \
S6_CMD_WAIT_FOR_SERVICES=1
# set work directory
WORKDIR /opt/apprise
# Copy our static content in place
COPY apprise_api/static /usr/share/nginx/html/s/
# Copy over Apprise API
COPY apprise_api/ webapp
# System Configuration
COPY etc /etc/
# set work directory
WORKDIR /opt/apprise
# Copy over Apprise API
COPY apprise_api/ webapp
# gunicorn to expose on port 8080
# nginx to expose on port 8000
# disable logging on gunicorn

38
README.md
View File

@ -9,7 +9,8 @@ Take advantage of [Apprise](https://github.com/caronc/apprise) through your netw
Apprise API was designed to easily fit into existing (and new) eco-systems that are looking for a simple notification solution.
[![Paypal](https://img.shields.io/badge/paypal-donate-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MHANV39UZNQ5E)
[![Discord](https://img.shields.io/discord/558793703356104724.svg?colorB=7289DA&label=Discord&logo=Discord&logoColor=7289DA&style=flat-square)](https://discord.gg/MMPeN2D)
[![Discord](https://img.shields.io/discord/558793703356104724.svg?colorB=7289DA&label=Discord&logo=Discord&logoColor=7289DA&style=flat-square)](https://discord.gg/MMPeN2D)<br/>
[![Docker Pulls](https://img.shields.io/docker/pulls/caronc/apprise.svg?style=flat-square)](https://hub.docker.com/r/caronc/apprise)
## Screenshots
There is a small built-in *Configuration Manager* that can be accesed using `/cfg/{KEY}`:<br/>
@ -18,6 +19,30 @@ There is a small built-in *Configuration Manager* that can be accesed using `/cf
Below is a screenshot of how you can set either a series of URL's to your `{KEY}`, or set your YAML and/or TEXT configuration below.
![Screenshot of GUI - Configuration](https://raw.githubusercontent.com/caronc/apprise-api/master/Screenshot-2.png)
## Installation
The following options should allow you to access the API at: `http://localhost:8000/` from your browser.
Using [dockerhub](https://hub.docker.com/r/caronc/apprise), you can do the following:
```bash
# Retrieve container
docker pull caronc/apprise:latest
# Start it up:
# /config is used for a persistent store, you do not have to mount
# this if you don't intend to use it.
docker run --name apprise \
-p 8000:8000 \
-v /var/lib/apprise/config:/config \
-d caronc/apprise:latest
```
A `docker-compose.yml` file is already set up to grant you an instant production ready simulated environment:
```bash
# Docker Compose
docker-compose up
```
## API Details
| Path | Description |
@ -49,17 +74,6 @@ The use of environment variables allow you to provide over-rides to default sett
| `DEBUG` | This defaults to `False` however can be set to `True`if defined with a non-zero value (such as `1`).
## Container Support
A `docker-compose.yml` file is already set up to grant you an instant production ready simulated environment:
```bash
# Docker Compose
docker-compose up
```
You can now access the API at: `http://localhost:8000/` from your browser.
## Development Environment
The following should get you a working development environment to test with: