Web Auth Server
Introduction
Web Auth Server is a server side framework and must be used in conjunction with Web Auth Page. Web Auth Server is base on Nest framework, it provides easy access to a variety of OAuth platforms, with comprehensive logging, caching, database services, you will be able to easily extend on this framework. Of course, it also has a built-in stategy for twitter.
Quick start
Environment Construction
You need to set up the following services in the environment and make sure they are working properly:
- Redis
- Mysql or MariaDB
- Nodejs
If you are not familiar with Redis, MySQL, MariaDB and you are not ready to hire professional programers to deploy them, then see the section Development > Environment Build, I provide a out-of-the-box Docker solution that is suitable for experimental, smaller scale applications where you can increase the load limit by simply boosting a single server resources.
Please go to official document for how to install Nodejs: https://nodejs.org/en/download/package-manager
Environment Variables
You can configure environment variables in any familiar way, such as CI and PM2 both have their own environment variable configuration methods, except that you can use dotenv provided by Nest.
Launch Service
npm install --only=prod
npm run startThis is only the simplest way to start a service, and we prefer to use cluster mode of PM2 to start and manage processes in a production environment.
Document
The service provides several HTTP protocol API for Web Auth Page, and the documentation can be viewed at http://{hostname}/docs after starting the service, for example the default service address is http://127.0.0.1:8080, then the API documentation is located at http://127.0.0.1:8080/docs.
Issues
Please feel free to submit your questions at Issues.