README ¶
Firebase Admin Go SDK
Table of Contents
Overview
Firebase provides the tools and infrastructure you need to develop apps, grow your user base, and earn money. The Firebase Admin Go SDK enables access to Firebase services from privileged environments (such as servers or cloud) in Go. Currently this SDK provides Firebase custom authentication support.
For more information, visit the Firebase Admin SDK setup guide.
Installation
To install Firebase Admin Go SDK, simply execute the following command
in a terminal from your $GOPATH
:
go get firebase.google.com/go
Contributing
Please refer to the CONTRIBUTING page for more information about how you can contribute to this project. We welcome bug reports, feature requests, code review feedback, and also pull requests.
Documentation
License and Terms
Firebase Admin Go SDK is licensed under the Apache License, version 2.0.
Your use of Firebase is governed by the Terms of Service for Firebase Services.
Documentation ¶
Overview ¶
Package firebase is the entry point to the Firebase Admin SDK. It provides functionality for initializing App instances, which serve as the central entities that provide access to various other Firebase services exposed from the SDK.
Index ¶
Constants ¶
const Version = "2.2.1"
Version of the Firebase Go Admin SDK.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type App ¶
type App struct {
// contains filtered or unexported fields
}
An App holds configuration and state common to all Firebase services that are exposed from the SDK.
func NewApp ¶
NewApp creates a new App from the provided config and client options.
If the client options contain a valid credential (a service account file, a refresh token file or an oauth2.TokenSource) the App will be authenticated using that credential. Otherwise, NewApp attempts to authenticate the App with Google application default credentials.
func (*App) Firestore ¶
Firestore returns a new firestore.Client instance from the https://godoc.org/cloud.google.com/go/firestore package.
Directories ¶
Path | Synopsis |
---|---|
Package auth contains functions for minting custom authentication tokens, and verifying Firebase ID tokens.
|
Package auth contains functions for minting custom authentication tokens, and verifying Firebase ID tokens. |
integration
|
|
Package internal contains functionality that is only accessible from within the Admin SDK.
|
Package internal contains functionality that is only accessible from within the Admin SDK. |
Package storage provides functions for accessing Google Cloud Storge buckets.
|
Package storage provides functions for accessing Google Cloud Storge buckets. |