Skip to content

Latest commit

 

History

History
102 lines (62 loc) · 3.29 KB

README.md

File metadata and controls

102 lines (62 loc) · 3.29 KB
Raw

space-gateway

English | 简体中文

Project Introduction

space-gateway is used for request routing, encryption and decryption, authentication and authorization, account management, video on demand service.

This application has a customized http root path: /space. And for api: https://localhost:8080/space/q/swagger-ui/

Module Design Introduction

  • gateway: Request routing, encryption and decryption, identity verification and authorization
  • account: Account management
  • push: Message push dependency
  • vod: Video on demand service file acquisition dependency ao-space/space-media-vod

Build and Run

Running the application in dev mode

You can run your application in dev mode that enables live coding using:

Note: The docker environment is required to run the application in dev mode. If docker is not installed, redis and postgresql connection parameters need to be configured under application.yml.

./mvnw compile quarkus:dev

NOTE: Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.

Packaging and running the application

The application can be packaged using:

./mvnw package

It produces the quarkus-run.jar file in the target/quarkus-app/ directory. Be aware that it’s not an über-jar as the dependencies are copied into the target/quarkus-app/lib/ directory.

If you want to build an über-jar, execute the following command:

./mvnw package -Dquarkus.package.type=uber-jar

The application is now runnable using java -jar target/quarkus-app/quarkus-run.jar.

Creating a native executable and Docker image

You can create a native executable using:

./mvnw package -Pnative

Or, if you don't have GraalVM installed, you can run the native executable build in a container using:

./mvnw package -Pnative -Dquarkus.native.container-build=true

You can then execute your native executable with: ./target/space-gateway-1.0.0-SNAPSHOT-runner

Create native docker image:

docker build -f src/main/docker/Dockerfile.native -t native/space-gateway .

And run above native image:

docker run -i --rm -p 8080:8080 native/space-gateway

If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling.html.

Combined with other services in AO.space

Refer to build-and-deploy.

Notes

Contribution Guidelines

Contributions to this project are very welcome. Here are some guidelines and suggestions to help you get involved in the project.

Contribution Guidelines

Contact us

Thanks for your contribution

Finally, thank you for your contribution to this project. We welcome contributions in all forms, including but not limited to code contributions, issue reports, feature requests, documentation writing, etc. We believe that with your help, this project will become more perfect and stronger.