kallithea Changeset - 2b2216e8af36

Changeset - 2b2216e8af36

Parent rev.

Child rev.

[Not reviewed]

stable

0 2 0

Søren Løvborg - 10 years ago 2015-09-09 18:32:05
sorenl@unity3d.com

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.

2 files changed with 14 insertions and 16 deletions:

docs/api/api.rst

docs/setup.rst

0 comments (0 inline, 0 general)

docs/api/api.rst

➞

Show inline comments

@@ @@ -74,48 +74,47 @@ All responses from the API will be ``HTT @@
 the reponse will have a failure description in *error* and
 *result* will be null.
 API client
 ++++++++++
 Kallithea comes with a ``kallithea-api`` command line tool, providing a convenient
 way to call the JSON-RPC API.
 For example, to call ``get_repo``::
- kallithea-api --apihost=<your.kallithea.server.url> --apikey=<yourapikey> get_repo
+    kallithea-api --apihost=<Kallithea URL> --apikey=<API key> get_repo
  calling {"api_key": "<apikey>", "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 => <Kallithea URL>
     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=<Kallithea URL> --apikey=<API key> get_repo repoid:myrepo
     calling {"api_key": "<apikey>", "id": 39, "args": {"repoid": "myrepo"}, "method": "get_repo"} to http://127.0.0.1:5000
     Kallithea said:
     {'error': None,
      'id': 39,
      'result': <json data...>}
     Calling method get_repo => <Kallithea URL>
     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=<your.kallithea.server.url> --apikey=<yourapikey>
+    kallithea-api --save-config --apihost=<Kallithea URL> --apikey=<API key>
-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.
 API methods
 +++++++++++
 pull
 ----
 Pull the given repo from remote location. Can be used to automatically keep
 remote repos up to date.

docs/setup.rst

➞

Show inline comments

@@ @@ -603,25 +603,25 @@ Sample config for Nginx using proxy: @@
        ssl_ciphers DHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA:EDH-RSA-DES-CBC3-SHA:AES256-SHA:DES-CBC3-SHA:AES128-SHA:RC4-SHA:RC4-MD5;
        ssl_prefer_server_ciphers on;
        ## 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;
        include         /etc/nginx/proxy.conf;
        location / {
             try_files $uri @kallithea;
+       }
        location @kallithea {
-            proxy_pass      http://kallithea;
+            proxy_pass      http://127.0.0.1:5000;
+       }
+    }
 Here's the proxy.conf. It's tuned so it will not timeout on long
 pushes or large pushes::
     proxy_redirect              off;
     proxy_set_header            Host $host;
     ## needed for container auth
     #proxy_set_header            REMOTE_USER $remote_user;
     #proxy_set_header            X-Forwarded-User $remote_user;
@@ @@ -640,25 +640,24 @@ pushes or large pushes:: @@
     large_client_header_buffers 8 64k;
 Apache virtual host reverse proxy example
 -----------------------------------------
 Here is a sample configuration file for Apache using proxy:
 .. code-block:: apache
     <VirtualHost *:80>
             ServerName hg.myserver.com
             ServerAlias hg.myserver.com
             <Proxy *>
               # For Apache 2.4 and later:
               Require all granted
               # For Apache 2.2 and earlier, instead use:
               # Order allow,deny
               # Allow from all
             </Proxy>
             #important !
             #Directive to properly generate url (clone url) for pylons

0 comments (0 inline, 0 general)