Eclectic Media Git klaus / 1f7b5b7
Change Docker image to use 'klaus' script Jonas Haag authored 9 months ago Jonas Haag committed 9 months ago
2 changed file(s) with 47 addition(s) and 24 deletion(s). Raw diff Collapse all Expand all
99
1010 ARG KLAUS_VERSION
1111 RUN pip3 install klaus${KLAUS_VERSION:+==}${KLAUS_VERSION}
12
13 EXPOSE 5000
14 ENTRYPOINT ["uwsgi", "--plugin", "python", "--http11-socket", "0.0.0.0:5000"]
15 CMD ["-w", "klaus.contrib.wsgi_autoreload"]
1212 (If it doesn't Just Work for you, please file a bug.)
1313
1414 * Super easy to set up -- no configuration required
15 * Supports Python 2 and Python 3
1615 * Syntax highlighting
16 * Markdown + RestructuredText rendering support
1717 * Git Smart HTTP support
1818 * Code navigation using Exuberant ctags
1919
2424 :License: ISC (BSD)
2525
2626
27 Contributing
28 ------------
29 Please do it!
27 Running with Docker
28 --------------------
3029
31 I'm equally happy with bug reports/feature ideas and code contributions.
32 If you have any questions/issues, I'm happy to help!
30 The easiest way to get started. We maintain a Docker image that has syntax highlighting, Markdown rendering, code navigation, etc. pre-configured::
3331
34 For starters, `here are a few ideas what to work on. <https://github.com/jonashaag/klaus/issues?q=is%3Aissue+is%3Aopen+label%3A%22C%3A+1%22>`_ :-)
32 docker run -v /path/to/your/repos:/repos \
33 -p 7777:80 \
34 -it jonashaag/klaus:latest \
35 klaus --host 0.0.0.0 --port 80 /repos/repo1 /repos/repo2 ...
36
37 (Replace ``/path/to/your/repos`` with the folder that contains your Git repositories on the Docker host. You can also pass in multiple ``-v`` arguments if your repos are in multiple folders on the host.)
38
39 Go to http://localhost:7777 on the Docker host et voilà!
40
41 The command line above simply runs the ``klaus`` script -- for usage details, see the "Using the ``klaus`` script" section below.
3542
3643
37 |img1|_ |img2|_ |img3|_
38
39 .. |img1| image:: https://i.imgur.com/2XhZIgw.png
40 .. |img2| image:: https://i.imgur.com/6LjC8Cl.png
41 .. |img3| image:: https://i.imgur.com/EYJdQwv.png
42
43 .. _img1: https://i.imgur.com/MV3uFvw.png
44 .. _img2: https://i.imgur.com/9HEZ3ro.png
45 .. _img3: https://i.imgur.com/kx2HaTq.png
46
47
48 Installation
49 ------------
44 Local setup
45 -----------
5046 ::
5147
5248 pip install klaus
6662
6763 To run klaus using the default options::
6864
65 # With Docker:
66 docker run ... jonashaag/klaus:latest klaus [repo1 [repo2 ...]]
67 # Local setup:
6968 klaus [repo1 [repo2 ...]]
7069
7170 For more options, see::
7271
72 # With Docker:
73 docker run ... jonashaag/klaus:latest klaus --help
74 # Local setup:
7375 klaus --help
7476
7577
9193 --env KLAUS_REPOS="/path/to/repo1 /path/to/repo2 ..." \
9294 klaus.contrib.wsgi
9395
96 The Docker image also has uwsgi preinstalled::
97
98 docker run ... jonashaag/klaus:latest uwsgi ...
99
94100 See also `deployment section in the wiki <https://github.com/jonashaag/klaus/wiki#deployment>`_.
95101
96102 .. _wsgiref: http://docs.python.org/library/wsgiref.html
103
104
105 Contributing
106 ------------
107 Please do it!
108
109 I'm equally happy with bug reports/feature ideas and code contributions.
110 If you have any questions/issues, I'm happy to help!
111
112 For starters, `here are a few ideas what to work on. <https://github.com/jonashaag/klaus/issues?q=is%3Aissue+is%3Aopen+label%3A%22C%3A+1%22>`_ :-)
113
114
115 |img1|_ |img2|_ |img3|_
116
117 .. |img1| image:: https://i.imgur.com/2XhZIgw.png
118 .. |img2| image:: https://i.imgur.com/6LjC8Cl.png
119 .. |img3| image:: https://i.imgur.com/EYJdQwv.png
120
121 .. _img1: https://i.imgur.com/MV3uFvw.png
122 .. _img2: https://i.imgur.com/9HEZ3ro.png
123 .. _img3: https://i.imgur.com/kx2HaTq.png