extern/apprise-api
1
0
Fork 0
mirror of https://github.com/caronc/apprise-api.git synced 2025-03-02 16:41:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

documentation cleanup

Browse Source
This commit is contained in:
Chris Caron 2024-07-02 14:11:28 -04:00
parent e3352206f3
commit 956d0865cb
2 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -135,6 +135,7 @@ curl -X GET -H "Accept: application/json" http://localhost:8000/status
The above output may look like this: The above output may look like this:
```json ```json
{ {
"attach_lock": false,
"config_lock": false, "config_lock": false,
"status": { "status": {
"can_write_config": true, "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 `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_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`. - 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 ### Stateless Solution

18
docker-compose.yml
View File

@ -8,7 +8,6 @@ services:
- APPRISE_STATEFUL_MODE=simple - APPRISE_STATEFUL_MODE=simple
ports: ports:
- 8000:8000 - 8000:8000
user: "www-data:www-data"
volumes: volumes:
- ./apprise_api:/opt/apprise/webapp:ro - ./apprise_api:/opt/apprise/webapp:ro
# if uncommenting the below, you will need to type the following # if uncommenting the below, you will need to type the following
@ -24,6 +23,7 @@ services:
# - ./attach:/attach:rw # - ./attach:/attach:rw
## Un-comment the below and then access a testing environment with: ## 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 ## docker-compose run --service-ports --rm test.py310 bash
## ##
## From here you ## From here you
@ -35,11 +35,11 @@ services:
## ##
## > Host service (visit http://localhost on host pc to access): ## > Host service (visit http://localhost on host pc to access):
## ./manage.py runserver 0.0.0.0:8000 ## ./manage.py runserver 0.0.0.0:8000
#test.py310: test.py310:
# ports: ports:
# - 8000:8000 - 8000:8000
# build: build:
# context: . context: .
# dockerfile: Dockerfile.py310 dockerfile: Dockerfile.py310
# volumes: volumes:
# - ./:/apprise-api - ./:/apprise-api