update readme and config.example.json

This commit is contained in:
Marco Andronaco 2023-08-09 02:12:27 +02:00
parent 7f43180250
commit 0705fab40f
3 changed files with 38 additions and 13 deletions

View File

@ -1,15 +1,14 @@
# artbound-python
# docker-status
A client-server reimplementation of the administration panel for ArtBound.
A simple status page for my Docker containers.
# Config
First of all, copy `config.json.example` into `config.json` and fill it out accordingly.
## Instructions
1. Copy `config.json.example` into `config.json` and fill it out;
2. Install dependencies: `poetry install`.
### Poetry
1. Install dependencies: `poetry install`.
2. Start the program:
* Debug: `poetry run flask --app docker_status run --port 1111 --debug`.
* Production: `poetry run waitress-serve --host 0.0.0.0 --port 1111 docker_status:app`
## Usage (poetry)
* Debug: `poetry run flask --app docker_status run --port 1111 --debug`.
* Production: `poetry run waitress-serve --host 0.0.0.0 --port 1111 docker_status:app`
## Usage (docker)
1. Generate a `token.json` file: `poetry run python get_token.py`;
2. Build the image and start the container: `docker-compose up -d`.
### Docker
Just use `docker-compose up -d`.

26
config.example.json Normal file
View File

@ -0,0 +1,26 @@
{
"Invidious": {
"provides": "YouTube",
"url": "https://invidious.mywebsite.com",
"containers": [
{
"name": "invidious",
"test": "https://invidious.mywebsite.com/api/v1/stats"
},
{
"name": "invidious-db",
"test": null
}
]
},
"LibReddit": {
"provides": "Reddit",
"url": "https://reddit.mywebsite.com",
"containers": [
{
"name": "libreddit",
"test": "https://libreddit.mywebsite.com/settings"
}
]
}
}

View File

@ -7,7 +7,7 @@
-->
<meta charset="utf-8">
<title>BiRabittoh - Status</title>
<meta name="description" content="A simple status page for my docker containers.">
<meta name="description" content="A simple status page for my Docker containers.">
<meta name="author" content="BiRabittoh">
<!-- Mobile Specific Metas