Skip to content

Commit 6e44088

Browse files
committed
README.md updated for running with docker
1 parent 81687eb commit 6e44088

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,40 @@
11
# Flask minimal example
22

3+
A simple tool for testing requests and ports locally, as well as on a remote server.
4+
35
## Running on a remote server
46

5-
### One-line command (new installation)
7+
There are two cases of running _flask minimal example_ covered here:
8+
1. Using docker-compose (via `Dockerfile`)
9+
2. Running it directly with `bash` command line on a given server (directly on the server's system)
10+
11+
### Running with docker-compose
12+
13+
Make sure that you have `docker` and `docker-compose` installed on your server.
14+
15+
Modify the contents of the `docker-compose.yml` file for defining the port you would like to use. __Note!__ For using port `80` you need `sudo` rights -- this option was not tested yet with `docker-compose` case.
16+
17+
```yaml
18+
ports:
19+
- '8080:5000'
20+
```
21+
22+
where:
23+
24+
* `8080` - is the port on which your application will be accessible outside of the `docker` container
25+
* `5000` - is the port that is used by the `Flask` application inside the `docker` container
26+
27+
Use the following commands to run the dockerized `Flask` application:
28+
29+
```bash
30+
docker-compose up
31+
```
32+
33+
### Running directly on the system
34+
35+
With this approach running the application on port `80` has already been tested.
36+
37+
#### One-line command (installing & running for the first time)
638

739
```bash
840
git clone https://github.com/mikbuch/flask_minimal_example && \

0 commit comments

Comments
 (0)