expressgateway / express-gateway.io Goto Github PK

website for Express Gateway on express-gateway.io

HTML 29.74% CSS 2.04% JavaScript 13.18% Ruby 0.09% SCSS 54.95%

express-gateway docs faq website

express-gateway.io's Introduction

express-gateway.io

This is the repository of the website express-gateway.io. It is hosted directly from the repository as a GitHub Pages website.

The main branch for this repository is gh-pages.

The live site is published off gh-pages.

Local Setup

To run website locally:

Install Ruby and Bundler if you don't have them already.

Note: highly recommend installing rvm to install and manage Ruby

Install Jekyll and other important Gems. cd to the repository directory and run the command:

$ bundle install

Now do a build (this is only needed if pushing to GH pages)

$ bundle exec jekyll build

Run Jekyll using the following command:

$ bundle exec jekyll serve

You'll need to override _config.yml with the baseUrl set to "/"
Load http://localhost:4000/ on your browser.

Auto Regeneration

By default, Jekyll will auto-regenerate the static pages if you change files through a built in filewatcher. You can simply refresh your browser to see the updates.

Formatting

Jekyll uses a variant of Markdown known as Kramdown.

Jekyll uses the Liquid template engine for templating.

You can use GFM fenced code blocks.

Examples:

var express = require('express')
var app = express()
app.listen(3000)

apiEndpoints:
  help:
    host: '*.example.com'
    paths: /help

Algolia Index

Docsearch is crawling our website every day in order to generate our search index.

express-gateway.io's People

Contributors

Stargazers

Watchers

express-gateway.io's Issues

search button clashes with menu on mobile form factor

Complete docs for serviceEndpoint\Schema\apiEndpoint

http://127.0.0.1:9876/api-docs/
Complete docs for serviceEndpoint\Schema\apiEndpoint

Conditions page improvement

https://www.express-gateway.io/docs/policies/customization/conditions

Add simple example before advanced
Provide navigation links (contents) to jump to conditions
add copy button to make it possible to copy paste example without breaking indentation

cc @minotaurrr

document with example how proxy appends req.url to forwarded url

there is a description for that.
http://www.express-gateway.io/docs/policies/proxy

example: API endpoint - "http://api.foobar.com/api" proxied to a service endpoint defined as "http://internal.api.lan:8080/" will have "/api" appended to it to become "http://internal/api/lan:8080/api"

more examples should be added

document how you can use glitch to deploy a gateway instance on the web

Index blog posts in Algolia as well

So that people can look in all our content we wrote so far.

Cannot interact with express gateway admin while in the same path (PWD)

$ eg gateway create
? What's the name of your Express Gateway? expressg
? Where would you like to install your Express Gateway? expressg
? What type of Express Gateway do you want to create? Getting Started with Express Gateway
   create package.json
   create server.js
   create config/gateway.config.yml
   create config/system.config.yml
   create config/models/applications.json
   create config/models/credentials.json
   create config/models/users.json
...
+ [email protected]
added 775 packages in 13.818s

To start expressg, run the following commands:
    cd expressg && npm start

$ cd expressg
$ npm start

This works:
curl http://localhost:8080/ip

Then with a new terminal

$ cd expressg
$ eg users create
? Enter firstname [required]: first
? Enter lastname [required]: last
? Enter username [required]: firstlast
? Enter email: undefined
? Enter redirectUri: undefined
✖ <!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Error</title>
</head>
<body>
<pre>Cannot POST //users/</pre>
</body>
</html>

JWT documentation is unclear around the `checkCredentialsParameters` flag

Simpler Logger policy description

Inside the following page : http://www.express-gateway.io/docs/policies/simple-logger

The description of the simpler logger policy seems wrong to me.

The Simpler Logger policy provides capability for logging with basic message output. the JavaScript [ES6 template literal syntax][es6-template-literal-syntax]

Inside the option reference the link to "ES6 template literal syntax" is rendered over "Javascript" for me on linux with Chrome 60.0.3112.113, maybe a missing space ?

Document the Admin API

Per @altsang:

it's ok to say that admin api is limited to... apps, users, credentials, tokens for now and more coming

menu disappears when scrolling down content page

steps to reproduce:
(mobile safari)

resize browser to mobile form factor until menu hamburger icon appears
start at top of home page
click hamburger icon and confirm menu appears
click back to page content
scroll down page
click hambuger icon and menu has disappeared as shown below

Docs are not mentioning auth headers in downstream services

Our documentation are not mentioning anywhere that, when an user is authenticated, some headers gets added to the request done to the downstream services automatically for you.

JWT Plugin: new token type within EG credential management and token service management

see #30 for part 1 of the JWT use case

Docs issues

log policy is called simple-logger, which is wrong.
log policy does not tell that message is printed using INFO as log level.
The Admin API needs an introduction paragraph explaining what's going on, why do you need it and what you can do with that

EG: fix CSS for blog post styling

Missing ( in plugin section

Inside the following section : http://www.express-gateway.io/docs/plugins

paragraph Plugin Structure, 2x ( are missing for bullets 2 and 3

_A plugin can contain one or more of the following:

Policies ( Policy Reference)
Conditions Pipeline and Conditions Reference)
Models for new Entities Consumer Management)
Custom route handlers_

top banner: hide top banner used for Product Hunt

we'll re-use this feature in the future for something else

About page has some un accessible copies

This is an example:

Modify gitter sidecar button to match our styles

egContext: need to list all objects that are in EG that Express.req/res doesn't cover

Blog archives do not work at all

Blog archives, both by month and by year, aren't working.

How to config https

I am using GoDaddy for SSL certification and i got two .crt files.

I also generated .csrfile. And I put all combinations for key and cert but still not working.

https: port: 443 tls: "*.example.com": key: example.com.csr cert: 7e5f2a7e8fa0962d.crt

I got

_tls_common.js:104 c.context.setKey(options.key, options.passphrase); Error: error:0906D06C:PEM routines:PEM_read_bio:no start line at Object.createSecureContext (_tls_common.js:104:17) at TLSSocket.options.SNICallback [as _SNICallback] (/root/BubbleHRWebAppGateway/node_modules/express-gateway/lib/gateway/server.js:60:24) at loadSNI (_tls_wrap.js:113:8) at TLSSocket.oncertcb (_tls_wrap.js:193:3) at TLSWrap.ssl.oncertcb (_tls_wrap.js:452:39)

Can EG provide more detailed documentation for https configuration?

Thank you so much!

The lateral menu should follow you when scrolling the blog page

Or the page will seem to be incomplete and awful

http://www.giphy.com/gifs/APKXv7Bi9s4ahB5Wm5

docs: update resource page with new icons for latest policies

Admin API docs are missing info about pipeline\endpoints

^ subject

it could be some doc branch was not merged

Admin: spec for API signatures for new API

extend your current OpenAPI spec - adding to what we already have
examples of fine grain and course grain manipulation
examples of URL structures
overall architecture to do client interaction - CLI + web GUI (including JSON schema based validation and typing etc)

Plugin Framework: restore docs for plugins for 1.2.0 release

blog: CSS fix for anchors has affected the article listing and article title

List of Must have Doc updates for upcoming 1.4

Advanced policy with access to pluginContext
API endpoint for service\api -endpoints, policies, schema etc.
EG behind proxy
EG with redis Sentinels
Multi-Auth
App name alias support
Importing data and building test data set
- Update CLI example to show how to set keyId keySecret when creating
Redis Migration

[Update with whatever is missing]

The link for the Policy Reference provided is wrong : http://www.express-gateway.io/docs/configuration/gateway.config.yml/Policy%20Reference

From what I understand, it should be : http://www.express-gateway.io/docs/policies/