Skip to content
This repository was archived by the owner on Dec 17, 2023. It is now read-only.

Commit cc0d076

Browse files
committed
update README
1 parent bd88e70 commit cc0d076

File tree

1 file changed

+14
-29
lines changed

1 file changed

+14
-29
lines changed

README.md

Lines changed: 14 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -7,45 +7,30 @@
77
- `py3.6`, `python3.6` [_(python3.6/Dockerfile)_](https://github.com/robertpeteuil/docker-nginx-uwsgi/blob/master/python3.6/Dockerfile)
88
- `py3.6-alpine`, `python3.6-alpine` [_(python3.6-alpine/Dockerfile)_](https://github.com/robertpeteuil/docker-nginx-uwsgi/blob/master/python3.6-alpine/Dockerfile)
99

10-
**the `latest` tag is not assigned - explicitly use one of the tags above.**
10+
**You must explicitly use one of the tags above.** The `latest` tag is not assigned since each tag represents a different variant, not an incremental version.
1111

12-
>This is to prevent pulling an unexpected image, as the tags represent completely different image variants not incremental versions.
13-
14-
# NGINX-UWSGI
12+
## NGINX-UWSGI
1513

1614
**Docker** image with **Nginx**, **uWSGI** and **Python** running in a single container to enable running Python Web Apps on NGINX.
1715

18-
> NOTE: This project is a derivative of the project at [tiangolo/UWSGI-NGINX-DOCKER](https://github.com/tiangolo/uwsgi-nginx-docker). It was created out of necessity to address urgent fixes and enhancements. This ultimately required creating derivatives of both the [base images](https://github.com/robertpeteuil/docker-nginx-uwsgi) and the [flask images](https://github.com/robertpeteuil/docker-nginx-uwsgi-flask).
19-
2016
**GitHub Repo**: <https://github.com/robertpeteuil/docker-nginx-uwsgi>
2117

2218
**Docker Hub Images**: <https://hub.docker.com/r/robpco/nginx-uwsgi/>
2319

24-
# Overview
20+
## Overview
2521

2622
This Docker image allow the creation/migration of Python Web Apps to run on Nginx and uWSGI in a single container. It's designed for use as base image for:
23+
2724
- Other images - such as a pre-built image for running Flask Apps [nginx-uwsgi-flask](https://github.com/robertpeteuil/docker-nginx-uwsgi-flask) .
2825
- A development image that can be customized with your unique web-framework, Python libraries and code.
2926

3027
This repo auto-generates images to [Docker-Hub](https://hub.docker.com/r/robpco/nginx-uwsgi/). It includes standard and alpine-based variants for each supported Python version (2.7, 3.5, 3.6).
3128

32-
# Enhancements
33-
34-
The image used in this repo includes the following enhancements (over previous repos):
35-
- Adds image variants built on alpine-linux
36-
- Updated built-in Nginx to 1.13.7 on non-alpine variants
37-
- Reduces CRIT errors from `supervisord`
38-
- `supervisord.conf` is explicitly referenced via the Dockerfile CMD statement
39-
- `supervisord.conf` includes an explicitly set user-name
40-
- Manually Building the image is protected against failures from key-server outages
41-
42-
# Information
29+
## Usage
4330

4431
The Docker-Hub [repository](https://hub.docker.com/r/robpco/nginx-uwsgi/) contains auto-generated images from this repo. They can be referenced (or pulled) by using the image name `robpco/nginx-uwsgi`, plus a tag for the python version desired (ex: `:python3.6`), and optionally appending `-alpine` to the tag (for alpine variants).
4532

46-
**Detailed usage documentation and examples can be found on the repo [tiangolo/UWSGI-NGINX-DOCKER](https://github.com/tiangolo/uwsgi-nginx-docker).**
47-
48-
# Custom Environment Variables
33+
## Custom Environment Variables
4934

5035
This image supports the following custom environment variables:
5136

@@ -57,27 +42,25 @@ This image supports the following custom environment variables:
5742
- **LISTEN_PORT** - custom port that Nginx should listen on
5843
- 80 = Nginx default
5944

60-
# Setting Environment Variables
45+
## Setting Environment Variables
6146

6247
Environment variables can be set in multiple ways. The following examples, demonstrate setting the `LISTEN_PORT` environment variable via three different methods. These methods apply to the other Environment Variables as well.
6348

64-
**Setting in a `Dockerfile`**
49+
### Setting in a `Dockerfile`
6550

6651
```dockerfile
6752
# ... (snip) ...
6853
ENV LISTEN_PORT 8080
6954
# ... (snip) ...
7055
```
7156

72-
73-
**Setting during [`docker run`](https://docs.docker.com/engine/reference/commandline/run/#options) with the `-e` option**
57+
### Setting during [`docker run`](https://docs.docker.com/engine/reference/commandline/run/#options) with the `-e` option
7458

7559
```shell
7660
docker run -e LISTEN_PORT=8080 -p 8080:8080 myimage
7761
```
7862

79-
80-
**Setting in `docker-compose` file using the `environment:` keyword in a `docker-compose` file**
63+
### Setting in `docker-compose` file using the `environment:` keyword in a `docker-compose` file
8164

8265
```yml
8366
version: '2.2'
@@ -88,8 +71,10 @@ services:
8871
LISTEN_PORT: 8080
8972
```
9073
74+
Inspired by the project at [tiangolo/UWSGI-NGINX-DOCKER](https://github.com/tiangolo/uwsgi-nginx-docker).
75+
76+
## UPDATES
9177
92-
# UPDATES
9378
- 2017-12-11: Added multiple tags per variant: `py3.6` is the same as `python3.6`, and so forth...
9479
- 2017-11-29: Added ability to change port Nginx listens on with new environment variable `LISTEN_PORT`.
9580
- Thanks to github user [tmshn](https://github.com/tmshn)
@@ -98,8 +83,8 @@ services:
9883
- 2017-11-29: Automatic image re-build when Python updates
9984
- 2017-11-28: Updated Nginx version installed on non-Alpine images
10085

86+
## CHANGELOG
10187

102-
# FIXES
10388
- 2017-12-15: Fix to avoid duplicate listen entries in nginx.conf
10489
- 2017-11-30: Alpine images - eliminated uWSGI random build failures
10590
- 2017-11-30: Non-Alpine images - limit build failures caused by GPG key validation failing

0 commit comments

Comments
 (0)