Mercurial > kallithea
changeset 5880:61954577a0df
docs: mention use of static_files, it's setup and implications
| author | Mads Kiilerich <madski@unity3d.com> |
|---|---|
| date | Wed, 04 May 2016 01:18:25 +0200 |
| parents | 278a742731cd |
| children | a5ad2900985b |
| files | docs/setup.rst docs/usage/performance.rst |
| diffstat | 2 files changed, 31 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/setup.rst Wed Apr 06 21:46:21 2016 +0200 +++ b/docs/setup.rst Wed May 04 01:18:25 2016 +0200 @@ -656,7 +656,7 @@ ## uncomment root directive if you want to serve static files by nginx ## requires static_files = false in .ini file - #root /path/to/installation/kallithea/public; + #root /srv/kallithea/kallithea/kallithea/public; include /etc/nginx/proxy.conf; location / { try_files $uri @kallithea;
--- a/docs/usage/performance.rst Wed Apr 06 21:46:21 2016 +0200 +++ b/docs/usage/performance.rst Wed May 04 01:18:25 2016 +0200 @@ -47,5 +47,35 @@ that will separate regular user traffic from automated processes like CI servers or build bots. +5. Serve static files directly from the web server + +With the default ``static_files`` ini setting, the Kallithea WSGI application +will take care of serving the static files found in ``kallithea/public`` from +the root of the application URL. While doing that, it will currently also +apply buffering and compression of all the responses it is serving. + +The actual serving of the static files is unlikely to be a problem in a +Kallithea setup. The buffering of responses is more likely to be a problem; +large responses (clones or pulls) will have to be fully processed and spooled +to disk or memory before the client will see any response. + +To serve static files from the web server, use something like this Apache config +snippet:: + + Alias /images/ /srv/kallithea/kallithea/kallithea/public/images/ + Alias /css/ /srv/kallithea/kallithea/kallithea/public/css/ + Alias /js/ /srv/kallithea/kallithea/kallithea/public/js/ + Alias /codemirror/ /srv/kallithea/kallithea/kallithea/public/codemirror/ + Alias /fontello/ /srv/kallithea/kallithea/kallithea/public/fontello/ + +Then disable serving of static files in the ``.ini`` ``app:main`` section:: + + static_files = false + +If using Kallithea installed as a package, you should be able to find the files +under site-packages/kallithea, either in your Python installation or in your +virtualenv. When upgrading, make sure to update the web server configuration +too if necessary. + .. _SQLAlchemyGrate: https://github.com/shazow/sqlalchemygrate