From 03cca968317417a0f610d408755eeebfd9784b71 Mon Sep 17 00:00:00 2001 From: Chris Caron Date: Sun, 27 Aug 2023 19:22:02 -0400 Subject: [PATCH] A little more git-friendly (#132) --- Dockerfile | 2 +- README.md | 11 +++++++++++ requirements.txt | 18 ++++++++++++++++-- 3 files changed, 28 insertions(+), 3 deletions(-) diff --git a/Dockerfile b/Dockerfile index 55857b8..9e6de52 100644 --- a/Dockerfile +++ b/Dockerfile @@ -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 diff --git a/README.md b/README.md index 5e13f12..826b765 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/requirements.txt b/requirements.txt index 7bc57bc..3ade66d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -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