docs: updated for docker; feat: local and latest dockerfiles; add: .dockerignore file; feat: implemented health check for adrianux app
This commit is contained in:
parent
2b6885055b
commit
fa730cac1b
7 changed files with 87 additions and 16 deletions
32
README.md
32
README.md
|
@ -1,32 +1,50 @@
|
|||
# Installation
|
||||
|
||||
|
||||
## Setting up the environment
|
||||
|
||||
1. Create a virtual environment:
|
||||
```bash
|
||||
```sh
|
||||
python3 -m venv .venv
|
||||
```
|
||||
|
||||
2. Activate the virtual environment:
|
||||
```bash
|
||||
```sh
|
||||
. .venv/bin/activate
|
||||
```
|
||||
|
||||
3. Install dependencies:
|
||||
```bash
|
||||
```sh
|
||||
pip install requirements.txt
|
||||
```
|
||||
|
||||
4. Set the environment variables:
|
||||
```sh
|
||||
export GIT_URL=http://git.adrianux.net
|
||||
export WEBSITE_URL=http://adrianux.net
|
||||
export DEBUGMODE=False
|
||||
```
|
||||
|
||||
5. Run the app:
|
||||
```sh
|
||||
waitress-serve --listen=0.0.0.0:8080 app:app
|
||||
```
|
||||
|
||||
# Docker
|
||||
|
||||
## Building the container
|
||||
|
||||
```
|
||||
# <runtime> build -t adrianux:<tag> .
|
||||
```sh
|
||||
docker build -t adrianux:latest - < latest.dockerfile
|
||||
```
|
||||
|
||||
|
||||
## Running the container
|
||||
|
||||
```sh
|
||||
docker run adrianux:latest
|
||||
```
|
||||
# <runtime> run adrianux:<tag>
|
||||
# Docker Compose
|
||||
|
||||
```sh
|
||||
docker compose up adrianux
|
||||
```
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue