Attachment 41327 Details for Bug 13799 – Bug 13799 - 1.1 RESTful API with reverse proxy configuration without api.host.domain

[patch] Bug 13799 - 1.1 RESTful API with reverse proxy configuration without api.host.domain

Bug-13799---11-RESTful-API-with-reverse-proxy-conf.patch (text/plain), 3.46 KB, created by Olli-Antti Kivilahti on 2015-08-04 07:56:38 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Olli-Antti Kivilahti

Created: 2015-08-04 07:56:38 UTC

Size: 3.46 KB

patch

obsolete

>From 2687c60a7a77de0f0944fdb209051abc95656bad Mon Sep 17 00:00:00 2001
>From: Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi>
>Date: Mon, 3 Aug 2015 17:54:51 +0300
>Subject: [PATCH] Bug 13799 - 1.1 RESTful API with reverse proxy configuration
> without api.host.domain
>
>OPTIONAL replacement to the
>    Buugg 13799: 1. RESTful API with Mojolicious and Swagger2
>httpd-configuration.
>
>Instead of having to go to your dns-provider, you can run the api from your
>current virtualhost.
>
>Use these configurations to reverse proxy www.host.domain/v1/ to the REST API.
>
>---------------------------
>:INSTALLATION INSTRUCTIONS:
>---------------------------
>
>You need
>    Buugg 14448 - Adding the REST API as a Hypnotoad service, koha-api-daemon.
>to deploy the backend Mojolicous application as a FastCGI-daemon.
>
>Then add the modifications from etc/koha-httpd.conf
>to your /etc/apache2/sites-enabled/koha.conf
>and adjust paths to fit.
>
>..$ a2enmod proxy
>..$ a2enmod proxy_http
>..$ service apache2 restart
>
>Much recommended is
>    Buugg 14458: 5. Add SwaggerUI documentation for RESTful API
>to browse your API capabilities.
>
>Then just go to
>    /v1/doc
>to see the API autodocumentation.
>---
> etc/koha-httpd.conf | 43 ++++++++++++++++++++++++-------------------
> 1 file changed, 24 insertions(+), 19 deletions(-)
>
>diff --git a/etc/koha-httpd.conf b/etc/koha-httpd.conf
>index 000e94a..98ab216 100644
>--- a/etc/koha-httpd.conf
>+++ b/etc/koha-httpd.conf
>@@ -27,6 +27,18 @@
>    # OVERRIDE_SYSPREF_NAMES for your staff intranet vhost
>    # SetEnv OVERRIDE_SYSPREF_PrefName Value
> 
>+   ##REVERSE PROXY REQUESTS TO THE KOHA API DAEMON
>+   Alias /v1/doc __INTRANET_CGI_DIR__/api/v1/doc
>+   Alias /v1/swagger.json "__INTRANET_CGI_DIR__/api/v1/swagger.json"
>+
>+   ProxyRequests Off #Disable anonymous forward proxying
>+   ProxyPreserveHost On
>+   ProxyPass        /v1/doc !
>+   ProxyPass        /v1/swagger.json !
>+   ProxyPass        /v1/  http://localhost:8081/v1/ keepalive=On
>+   ProxyPassReverse /v1/  http://localhost:8081/v1/
>+   ##REVERSE PROXYING OK
>+
>    <Directory "__OPAC_WWW_DIR__">
>       Options -Indexes
>    </Directory>
>@@ -144,6 +156,18 @@
>    ErrorDocument 404 /cgi-bin/koha/errors/404.pl
>    ErrorDocument 500 /cgi-bin/koha/errors/500.pl
> 
>+   ##REVERSE PROXY REQUESTS TO THE KOHA API DAEMON
>+   Alias /v1/doc __INTRANET_CGI_DIR__/api/v1/doc
>+   Alias /v1/swagger.json "__INTRANET_CGI_DIR__/api/v1/swagger.json"
>+
>+   ProxyRequests Off #Disable anonymous forward proxying
>+   ProxyPreserveHost On
>+   ProxyPass        /v1/doc !
>+   ProxyPass        /v1/swagger.json !
>+   ProxyPass        /v1/  http://localhost:8081/v1/ keepalive=On
>+   ProxyPassReverse /v1/  http://localhost:8081/v1/
>+   ##REVERSE PROXYING OK
>+
>    <Directory "__INTRANET_WWW_DIR__">
>       Options -Indexes
>    </Directory>
>@@ -216,22 +240,3 @@
>      RewriteRule ^/issn/([^\/]*)/?$ /search?q=issn:$1 [PT]
>    </IfModule>
> </VirtualHost>
>-
>-<VirtualHost __WEBSERVER_IP__:__WEBSERVER_PORT__>
>-   ServerAdmin __WEBMASTER_EMAIL__
>-   DocumentRoot __INTRANET_CGI_DIR__/api
>-   ServerName api.__WEBSERVER_HOST__:__WEBSERVER_PORT__
>-   SetEnv KOHA_CONF "__KOHA_CONF_DIR__/koha-conf.xml"
>-   SetEnv PERL5LIB "__PERL_MODULE_DIR__"
>-
>-  <Directory __INTRANET_CGI_DIR__/api>
>-    Options +ExecCGI +FollowSymlinks
>-    AddHandler cgi-script .cgi
>-
>-    RewriteEngine on
>-    RewriteCond %{REQUEST_FILENAME} !-f
>-    RewriteCond %{REQUEST_FILENAME} !-d
>-    RewriteCond %{DOCUMENT_ROOT}/$1/script.cgi -f
>-    RewriteRule ^(.*?)/.* $1/script.cgi/$0 [L]
>-  </Directory>
>-</VirtualHost>
>-- 
>1.9.1

Actions: View | Diff | Splinter Review

Attachments on bug 13799: 36700 | 36705 | 36938 | 36941 | 37119 | 37132 | 37172 | 38246 | 39156 | 39158 | 39159 | 39160 | 39161 | 39162 | 39163 | 39164 | 40088 | 40092 | 40093 | 40094 | 40098 | 40099 | 40101 | 40140 | 40141 | 40142 | 40463 | 40464 | 40465 | 40466 | 40467 | 40468 | 40469 | 40470 | 40471 | 40551 | 40552 | 40553 | 40554 | 40560 | 40561 | 40584 | 40585 | 40586 | 40587 | 40616 | 40617 | 40618 | 40619 | 41160 | 41161 | 41162 | 41268 | 41269 | 41270 | 41271 | 41272 | 41273 | 41274 | 41320 | 41321 | 41326 | 41327 | 41328 | 41329 | 41330 | 41331 | 41538 | 41539 | 41540 | 41541 | 41542 | 41543 | 41547 | 41554 | 42044 | 42085 | 42086 | 42123 | 42518 | 42766 | 42768 | 42801 | 42874 | 42875 | 42876 | 42877 | 42878 | 43186 | 43187 | 43189 | 43190 | 43191 | 43192 | 43204 | 43205 | 43206 | 43207 | 43208 | 43209 | 43210 | 43211 | 43212 | 43213 | 43214 | 43980 | 43981 | 43987 | 43989 | 43990 | 43991 | 43992 | 43993 | 43994 | 43995 | 43996 | 43997 | 43998 | 43999 | 44000 | 44001 | 44185 | 44285 | 44313 | 44375 | 44376 | 44377 | 44378 | 44379 | 44380 | 44381 | 44382 | 44383 | 44384 | 44385