Serving my website home page through api-umbrella

Open
#455 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
nginx
Domain
api, web-dev

Research direction

Start by reviewing the API Umbrella deployment and the mentioned /opt/api-umbrella/embedded/apps/static-site/releases/20190514040459/build/index.html path. Determine whether serving the static home page and configuring the existing NGINX setup are supported, then document the recommended arrangement and configuration guidance for the three questions.

Written by the indexing model from the issue text.

Description

Assume I have a domain xyz.com and I have APIs available at

  1. xyz.com/service1
  2. xyz.com/service2
    Actually the above services are running at xyz.com:5000/service1 and xyz.com:5001/service2. I have used Nginx to make them accessible through port 80 as mentioned above.
    My website's home page is also served through NGINX.

Now, I want to use API umbrella for API management. What I understand is I have to run API umbrella on port 80 as I will be exposing API-Umbrella's end-point instead of NGINX end-point. So I will be running NGINX on another port.

I also want to serve my website's home page(static HTML page) through port 80. I tried to replacing /opt/api-umbrella/embedded/apps/static-site/releases/20190514040459/build/index.html with my website's webpage. It works fine.

But my queries are:
-Is that a standard practice?
-As api-umbrella runs NGINX internally, is it a good practice to run two NGINX services on a single server?
-Can I use the API-Umbrella's internal NGINX to configure my application? if yes, how?

Dominant language
Ruby
Stars
2.2k
Forks
373
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from NatLabRockies/api-umbrella

All issues in NatLabRockies/api-umbrella

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.