update readme and config.example.json
This commit is contained in:
parent
7f43180250
commit
0705fab40f
23
README.md
23
README.md
|
@ -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
|
### Poetry
|
||||||
1. Copy `config.json.example` into `config.json` and fill it out;
|
1. Install dependencies: `poetry install`.
|
||||||
2. 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)
|
### Docker
|
||||||
* Debug: `poetry run flask --app docker_status run --port 1111 --debug`.
|
Just use `docker-compose up -d`.
|
||||||
* 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`.
|
|
||||||
|
|
|
@ -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"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
|
@ -7,7 +7,7 @@
|
||||||
–––––––––––––––––––––––––––––––––––––––––––––––––– -->
|
–––––––––––––––––––––––––––––––––––––––––––––––––– -->
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8">
|
||||||
<title>BiRabittoh - Status</title>
|
<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">
|
<meta name="author" content="BiRabittoh">
|
||||||
|
|
||||||
<!-- Mobile Specific Metas
|
<!-- Mobile Specific Metas
|
||||||
|
|
Loading…
Reference in New Issue