From 956d0865cb4ab0939c4fd9829ad48e6e4cbc2c05 Mon Sep 17 00:00:00 2001 From: Chris Caron Date: Tue, 2 Jul 2024 14:11:28 -0400 Subject: [PATCH] documentation cleanup --- README.md | 4 +++- docker-compose.yml | 18 +++++++++--------- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 474dd0a..7b27d07 100644 --- a/README.md +++ b/README.md @@ -135,6 +135,7 @@ curl -X GET -H "Accept: application/json" http://localhost:8000/status The above output may look like this: ```json { + "attach_lock": false, "config_lock": false, "status": { "can_write_config": true, @@ -144,9 +145,10 @@ The above output may look like this: } ``` +- The `attach_lock` always cross references if the `APPRISE_ATTACH_SIZE` on whether or not it is `0` (zero) or less. - The `config_lock` always cross references if the `APPRISE_CONFIG_LOCK` is enabled or not. - The `status.can_write_config` defines if the configuration directory is writable or not. If the environment variable `APPRISE_STATEFUL_MODE` is set to `disabled`, this value will always read `false` and it will not impact the `status.details` -- The `status.can_write_attach` defines if the attachment directory is writable or not. If the environment variable `APPRISE_ATTACH_SIZE` or `APPRISE_MAX_ATTACHMENTS` is set to `0` (zero) or lower, this value will always read `false` and it will not impact the `status.details`. +- The `status.can_write_attach` defines if the attachment directory is writable or not. If the environment variable `APPRISE_ATTACH_SIZE`. This value will always read `false` and it will not impact the `status.details`. - The `status.details` identifies the overall status. If there is more then 1 issue to report here, they will all show in this list. In a working orderly environment, this will always be set to `OK` and the http response type will be `200`. ### Stateless Solution diff --git a/docker-compose.yml b/docker-compose.yml index c7d3876..a12fd81 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -8,7 +8,6 @@ services: - APPRISE_STATEFUL_MODE=simple ports: - 8000:8000 - user: "www-data:www-data" volumes: - ./apprise_api:/opt/apprise/webapp:ro # if uncommenting the below, you will need to type the following @@ -24,6 +23,7 @@ services: # - ./attach:/attach:rw ## Un-comment the below and then access a testing environment with: + ## docker-compose run test.py310 build ## docker-compose run --service-ports --rm test.py310 bash ## ## From here you @@ -35,11 +35,11 @@ services: ## ## > Host service (visit http://localhost on host pc to access): ## ./manage.py runserver 0.0.0.0:8000 - #test.py310: - # ports: - # - 8000:8000 - # build: - # context: . - # dockerfile: Dockerfile.py310 - # volumes: - # - ./:/apprise-api + test.py310: + ports: + - 8000:8000 + build: + context: . + dockerfile: Dockerfile.py310 + volumes: + - ./:/apprise-api