Skip to content

Commit

Permalink
doc: add more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vanthome committed Oct 29, 2024
1 parent e6cd3f2 commit ba334b6
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ WORKDIR $APP_HOME
COPY --chown=node:node ./cfg $APP_HOME/cfg
COPY --chown=node:node --from=build $APP_HOME/lib $APP_HOME/lib

EXPOSE 50051
EXPOSE 5000

CMD [ "node", "./lib/start.cjs" ]
27 changes: 27 additions & 0 deletions docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,30 @@ https://coveralls.io/github/restorecommerce/facade-srv?branch=master[image:http:

A microservice to serve as a facade for all other microservices.

[#features]
== Features

* Unified GraphQL API pane for the outside.
* Universal reverse proxy for gRPC and GraphQL federation.
* Generates requeist IDs which are passed downstream for tracing.
* Auto generation of GraphQL API from gRPC protobuf service definitions.
* API explorer via Apollo sandbox.
* Authentication aginast Restorecommerce identity-srv via OIDC.
* Built-in reverse proxy for REST access to the Restorecommerce ostorage-srv.
[#usage]
== Usage

[#usage_running_as_container]
=== Running as Container

[source,sh]
----
docker run -d -p 5000:5000 --name facade-srv ghcr.io/restorecommerce/facade-srv
----

[#path_map]
=== Path Map

* `/graphql`: GraphQL endpoint and API explorer
* `/os`: REST based access to the ostorage-srv (object storage)

0 comments on commit ba334b6

Please sign in to comment.