Skip to content

Commit a6d11b0

Browse files
committed
fix rst formating
1 parent 99fa187 commit a6d11b0

File tree

1 file changed

+18
-27
lines changed

1 file changed

+18
-27
lines changed

README.rst

Lines changed: 18 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Installation
33
============
44

55
The app depends on PyWPS and several other libraries that are listed in
6-
``requirements.txt``. It is advisable to run it using a python virtualenv to prevent package instalation problems
6+
``requirements.txt``. It is advisable to run it using a python virtualenv to prevent package instalation problems::
77

88
$ virtualenv -p python3 pywps_flask_env
99
$ cd pywps_flask_dir
@@ -13,7 +13,7 @@ The app depends on PyWPS and several other libraries that are listed in
1313
$ pip3 install -r requirements.txt
1414

1515

16-
If python virtualenv is not an option:
16+
If python virtualenv is not an option::
1717

1818
$ git clone https://github.com/geopython/pywps-flask
1919
$ cd pywps-flask
@@ -26,7 +26,7 @@ For Debian based systems you will need to install GDAL with::
2626
$ sudo apt-get install python3-gdal
2727

2828

29-
When using only using `requirement.txt`, the `pywps-flask` will run for the directory that was pulled from github, for a system wise installation is it advisable to use `setup.py`
29+
When using only using `requirement.txt`, the `pywps-flask` will run for the directory that was pulled from github, for a system wise installation is it advisable to use `setup.py`::
3030

3131
$ git clone https://github.com/geopython/pywps-flask
3232
$ cd pywps-flask
@@ -43,7 +43,7 @@ Simply run the python file::
4343

4444
The flag `-a` will bind to the ip range `0.0.0.0` and is normally the safest option access to `pypwps-flask`
4545

46-
The `-d` option will run pywps-flask as daemon and to stop it is necessary to determine the PID and kill it, one trick is to use fuser to determine PID, and then use it to kill the process
46+
The `-d` option will run pywps-flask as daemon and to stop it is necessary to determine the PID and kill it, one trick is to use fuser to determine PID, and then use it to kill the process::
4747

4848
$ fuser tcp/5000
4949
$ kill -15 <PID RETURNED PREVIOUSLY>
@@ -83,12 +83,12 @@ Pywps will be available in the following URL::
8383

8484

8585
Gunicorn-Alpine (production)
86-
---------------------------
86+
----------------------------
8787

88-
This image implements the previous ``flask-alpine image`` (you need to build it first, or it will be automatically pulled from dockerhub) but wrapping flask in a WSGI server (gunicorn) where each worker runs a an app. This image allows for the following environment variables::
88+
This image implements the previous ``flask-alpine image`` (you need to build it first, or it will be automatically pulled from dockerhub) but wrapping flask in a WSGI server (gunicorn) where each worker runs a an app. This image allows for the following environment variables:
8989

90-
* GU_WORKERS - Numer or workers. Gunicorn uses a set of workers to run pywps (normally ``workers = (2 * cpu) + 1``). (default: 5)
91-
* GU_PORT - Port running Gunicorn (default:8081)
90+
- GU_WORKERS - Numer or workers. Gunicorn uses a set of workers to run pywps (normally ``workers = (2 * cpu) + 1``). (default: 5)
91+
- GU_PORT - Port running Gunicorn (default:8081)
9292

9393

9494

@@ -102,9 +102,11 @@ To build the image (inside the folder with the Dockerfile)::
102102

103103

104104
And to run it::
105+
105106
$ docker run -p 8081:8081 -it pywps/gunicorn-alpine:latest
106107

107-
or::
108+
or::
109+
108110
$ docker run -e GU_WORKERS=10 -e GU_PORT=8082 -p 8082:8082 -it pywps/gunicorn-alpine:latest
109111

110112
Pywps will be available in the following URL::
@@ -118,7 +120,7 @@ Nginx-Alpine
118120
This is the complete stack intented for production, to have a stack we require to use ``docker-compose``
119121
to build two images: ``pywps/gunicorn-alpine:latest`` and ``pywps/nginx-alpine:latest``
120122

121-
Those images will be pulled from dockerhub, but they can compiled locally by building Flask-Alpine, Gunicron-Alpine and Nginx-Alpine, in this case only showing for nginx
123+
Those images will be pulled from dockerhub, but they can compiled locally by building Flask-Alpine, Gunicron-Alpine and Nginx-Alpine, in this case only showing for nginx::
122124

123125

124126
$ cd docker/alpine/nginx/Dockerfile
@@ -138,7 +140,7 @@ In this case pywps (only the WPS) will be avalable on::
138140
Flask-Ubuntu (basic)
139141
--------------------
140142

141-
The same as ``Flask-Ubuntu`` but using phusion image (ubuntu 18.04)
143+
The same as ``Flask-Ubuntu`` but using phusion image (ubuntu 18.04)::
142144

143145

144146
$ cd docker/ubuntu/flask/Dockerfile
@@ -152,7 +154,7 @@ And to run it::
152154
Nginx-Ubuntu (production)
153155
-------------------------
154156

155-
This image is based on ``Flask-Ubuntu`` and will require it (either build locally or pull from dockerhub). This image has Nginx and Gunicorn totally integrated as services in a docker image
157+
This image is based on ``Flask-Ubuntu`` and will require it (either build locally or pull from dockerhub). This image has Nginx and Gunicorn totally integrated as services in a docker image::
156158

157159

158160
$ cd docker/ubuntu/nginx/Dockerfile
@@ -162,7 +164,7 @@ And to run it::
162164

163165
$ docker run -p 80:80 pywps/nginx-ubuntu
164166

165-
It is possible to set the number of Gunicorn workers::
167+
It is possible to set the number of Gunicorn workers:
166168

167169
* GU_WORKERS - Numer or workers. (default: 5)
168170

@@ -185,7 +187,7 @@ Named volumes allow for container content to be available in the host system. Th
185187
And file:
186188
* /pywps-flask/pywps.cfg
187189

188-
Named volumes need to be created prior to ``docker run``
190+
Named volumes need to be created prior to ``docker run``::
189191

190192
$ docker volume create pywps_logs
191193
$ docker volume create pywps_outputs
@@ -205,18 +207,7 @@ To run a docker will all the volumes available in the host::
205207
-v pywps_cfg:/pywps-flask/pywps.cfg pywps/flask-alpine:latest
206208

207209

208-
209-
210-
211-
212-
213-
214-
215-
216-
217-
218-
219-
220-
210+
THE END
211+
=======
221212

222213

0 commit comments

Comments
 (0)