# HG changeset patch # User Søren Løvborg # Date 1441816325 -7200 # Node ID 2b2216e8af368005b7619c12ab587e34461c1924 # Parent 222a9f3d4023985aa2631b411d24a26ff27bbc41 docs: update example output and example server configs kallithea-api example output was not up-to-date, and the text was a little vague on whether you specify a hostname or a URL. The Nginx example config has been updated to assume a Kallithea backend server on localhost:5000, like the Apache example. The redundant ServerAlias option was removed from the Apache example. diff -r 222a9f3d4023 -r 2b2216e8af36 docs/api/api.rst --- a/docs/api/api.rst Thu Sep 10 23:29:50 2015 +0200 +++ b/docs/api/api.rst Wed Sep 09 18:32:05 2015 +0200 @@ -83,30 +83,29 @@ For example, to call ``get_repo``:: - kallithea-api --apihost= --apikey= get_repo + kallithea-api --apihost= --apikey= get_repo - calling {"api_key": "", "id": 75, "args": {}, "method": "get_repo"} to http://127.0.0.1:5000 - Kallithea said: - {'error': 'Missing non optional `repoid` arg in JSON DATA', - 'id': 75, - 'result': None} + Calling method get_repo => + Server response + ERROR:"Missing non optional `repoid` arg in JSON DATA" Oops, looks like we forgot to add an argument. Let's try again, now providing the ``repoid`` as a parameter:: - kallithea-api get_repo repoid:myrepo + kallithea-api --apihost= --apikey= get_repo repoid:myrepo - calling {"api_key": "", "id": 39, "args": {"repoid": "myrepo"}, "method": "get_repo"} to http://127.0.0.1:5000 - Kallithea said: - {'error': None, - 'id': 39, - 'result': } + Calling method get_repo => + Server response + { + "clone_uri": null, + "created_on": "2015-08-31T14:55:19.042", + ... To avoid specifying ``apihost`` and ``apikey`` every time, run:: - kallithea-api --save-config --apihost= --apikey= + kallithea-api --save-config --apihost= --apikey= -This will create a ``~/.config/kallithea`` with the specified hostname and API key +This will create a ``~/.config/kallithea`` with the specified URL and API key so you don't have to specify them every time. diff -r 222a9f3d4023 -r 2b2216e8af36 docs/setup.rst --- a/docs/setup.rst Thu Sep 10 23:29:50 2015 +0200 +++ b/docs/setup.rst Wed Sep 09 18:32:05 2015 +0200 @@ -612,7 +612,7 @@ } location @kallithea { - proxy_pass http://kallithea; + proxy_pass http://127.0.0.1:5000; } } @@ -649,7 +649,6 @@ ServerName hg.myserver.com - ServerAlias hg.myserver.com # For Apache 2.4 and later: