Skip to content

Commit

Permalink
A little more git-friendly (#132)
Browse files Browse the repository at this point in the history
  • Loading branch information
caronc authored Aug 27, 2023
1 parent 4056b20 commit 03cca96
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ ENV APPRISE_PLUGIN_PATHS /plugin

# Install nginx, supervisord, and cryptography dependencies
RUN apt-get update -qq && \
apt-get install -y -qq nginx supervisor \
apt-get install -y -qq nginx supervisor git \
build-essential libffi-dev libssl-dev cargo pkg-config python3-dev rustc

# Cryptography documents that the latest version of pip3 must always be used
Expand Down
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,17 @@ docker run --name apprise \
-d caronc/apprise:latest
```

You can also choose to build yourself a custom version after checking out the source code. This is sometimes useful when you want to make a change to the source code and try it out.
A common change one might make is to update the Dockerfile to point to the master branch of Apprise instead of using the stable version.
```bash
# Setup your environment the way you like
docker build -t apprise/local:latest -f Dockerfile .

# Launch your instance
docker run --name apprise \
-p 8000:8000 \
-d apprise/local:latest
```
A `docker-compose.yml` file is already set up to grant you an instant production ready simulated environment:

```bash
Expand Down
18 changes: 16 additions & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,23 @@
django
##
## Apprise Backend Installation
##
## You should only have 1 of the 3 items uncommented below.

## 1. Uncomment the below line to pull the main branch of Apprise:
# apprise @ git+https://github.com/caronc/apprise

## 2. Uncomment the below line instead if you wish to focus on a tag:
# apprise @ git+https://github.com/caronc/apprise@custom-tag-or-version

## 3. The below grabs our stable version (generally the best choice):
apprise == 1.4.5

## Apprise API Minimum Requirements
django
gevent
gunicorn

# 3rd party service support
## 3rd Party Service support
paho-mqtt
gntp
cryptography

0 comments on commit 03cca96

Please sign in to comment.