Skip to content

Commit c91f0db

Browse files
committed
Add sample nginx configuration
1 parent 24398bb commit c91f0db

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,27 @@ flask run
1313
This will run the application on port 5000. If you want to actually use the application
1414
in a production environment, it is recommended to set up a reverse proxy with nginx.
1515

16-
_Todo: Add instructions on installation / running the application within a python
17-
virtualenv_
16+
### Sample nginx configuration
1817

19-
## Todo
18+
To use nginx as a reverse proxy for `ippls`, add the following four lines to the `server`
19+
block in your nginx configuration:
20+
```
21+
location /ippls/ {
22+
proxy_pass http://127.0.0.1:5000/;
23+
proxy_set_header X-Real-IP $remote_addr;
24+
}
25+
```
26+
27+
## To do
2028

21-
* ~~Human-readable HTML version~~
22-
* ~~Plain text version for wget-like tools~~
23-
* ~~JSON output~~
2429
* `.deb` package
2530
* Configuration file
31+
* Instructions on running the application in a python virtualenv
2632

2733
## License
2834

2935
```
30-
Copyright (c) 2018 Martijn
36+
Copyright (c) 2018, 2019 Martijn
3137
3238
ippls is available under the terms of GNU Affero General Public License, either version 3
3339
of the License or (at your option) any later version.

0 commit comments

Comments
 (0)