README
¶
Authentication Micro-Service
Introduction
A Golang based authentication and Authorization micro-service that handles various kinds of authentication:
- username/password based authentication
- phone/password based authentication
- OAuth2 authentication
- auth method verification e.g. phone number
In this Readme you will come accross the variable <version>,
it is the major version code of the VersionFull variable in
config/consts.go as per http://semver.org
e.g.
Name = "seedms"
VersionFull = "0.1.2"
yields
<version> => 0
Installation/Deployment
Refer to the respective readme files for instructions:
Manual build
Pre-requisites
- Go 1.8+ is required for this.
- APIDoc installed and added to
PATHvariable: http://apidocjs.com
Build
Run the build command from inside the root folder:
make build
make build can also be supplied with goos=[GOOS] goarch=[GOARCH]
goarm=[GOARM] values as per the documentation at https://golang.org/cmd/go (untested)
build uses the go toolchain to build binaries. It also generates API docs and configuration templates.
Documentation
¶
Overview ¶
build.go automates proper versioning of authms binaries and installer scripts. Use it like: go run build.go The result binary will be located in bin/app You can customize the build with the -goos, -goarch, and -goarm CLI options: go run build.go -goos=windows
This program is NOT required to build authms from source since it is go-gettable. (You can run plain `go build` in this directory to get a binary).
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api is a generated protocol buffer package.
|
Package api is a generated protocol buffer package. |
|
cmd
|
|
|
gcloud
command
|
|
|
microservice
command
|
|
|
standalone
command
|
|
|
handler
|
|
|
proto
|
|
|
authms
Package authms is a generated protocol buffer package.
|
Package authms is a generated protocol buffer package. |
|
sms
|
|