Bug 14747 - RESTful API with reverse proxy configuration
Summary: RESTful API with reverse proxy configuration
Status: CLOSED WONTFIX
Alias: None
Product: Koha
Classification: Unclassified
Component: Web services (show other bugs)
Version: Main
Hardware: All All
: P5 - low enhancement (vote)
Assignee: Olli-Antti Kivilahti
QA Contact: Testopia
URL:
Keywords:
Depends on: 13799 14448
Blocks:
  Show dependency treegraph
 
Reported: 2015-08-27 17:04 UTC by Julian Maurice
Modified: 2018-06-04 20:10 UTC (History)
2 users (show)

See Also:
Change sponsored?: ---
Patch complexity: Medium patch
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:


Attachments
Bug 14747: RESTful API with reverse proxy configuration (4.96 KB, patch)
2015-08-27 17:10 UTC, Julian Maurice
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Julian Maurice 2015-08-27 17:04:18 UTC
RESTful API with reverse proxy configuration
Comment 1 Julian Maurice 2015-08-27 17:10:06 UTC
Created attachment 42040 [details] [review]
Bug 14747: RESTful API with reverse proxy configuration

OPTIONAL replacement to the
    Bug 13799: 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
    Bug 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
    Bug 14458: Add SwaggerUI documentation for RESTful API
to browse your API capabilities.

Then just go to
    /v1/doc
to see the API autodocumentation.
Comment 2 Zeno Tajoli 2015-09-01 08:20:45 UTC
Patch complexity is 'Medium' because this change has many architectural connections
Comment 3 Josef Moravec 2017-06-14 08:39:53 UTC
Closing because dependency bug 14448 is also closed with WONTFIX