globals

Documentation

Index

• Variables

Variables

var APIVersion = "1.0"

APIVersion is route api version. See also routes and routers \todo: Add support for multiple versions.

var BucketS3 string

BucketS3 contains the name of the S3 bucket used to save models and worlds zip files.

var ElasticSearch *elasticsearch.Client

ElasticSearch is a pointer to the Elastic Search client.

var FlagsEmailRecipient string

FlagsEmailRecipient is the target email to use when sending flags notifications. It is set using IGN_FLAGS_EMAIL_TO env var.

var FlagsEmailSender string

FlagsEmailSender is the sender email to use when sending flags notifications. It is set using IGN_FLAGS_EMAIL_FROM env var.

var FormDecoder *form.Decoder

FormDecoder holds a reference to the global Form Decoder. See https://github.com/go-playground/form. We use a single instance of Decoder, as it caches struct info

var HTTPTestS3Server *httptest.Server

HTTPTestS3Server is used as a testing web server for interacting with the S3 API on test suites.

var LeaderboardCircuitFilter []string

LeaderboardCircuitFilter contains a list of comma-separated circuits that will be excluded from leaderboard score results.

var LeaderboardOrganizationFilter []string

LeaderboardOrganizationFilter contains a list of comma-separated organizations that will be excluded from leaderboard score results.

var MaxCategoriesPerModel int

MaxCategoriesPerModel defines the maximum amount of categories that can be assigned to a model

var Permissions *permissions.Permissions

Permissions manages permissions for users, roles and resources.

var QueryCache *memcache.Client

QueryCache is used to store/cache results for common queries.

var ResourceDir string

ResourceDir is the directory where all resources are located.

var S3 *s3.S3

S3 contains a reference to the S3 API using the AWS SDK v1 that allows you to interact with a buckets and objects.

var Server *gz.Server

Server encapsulates database, router, and auth0

var SessionS3 *session.Session

SessionS3 contains an AWS session used to perform S3 operations.

var Storage storage.Storage

Storage holds an implementation of storage.Storage that allows you to upload and download files.

var UploaderS3 *s3manager.Uploader

UploaderS3 contains a reference to the S3 API using the AWS SDK v1 that allows you to upload objects to S3.

var VCSRepoFactory func(ctx context.Context, dirpath string) vcs.VCS

VCSRepoFactory is the factory function used to create new repositories to manage versions of Models, Worlds, Plugins, etc. Our current implementation uses go-git.

var Validate *validator.Validate

Validate references the global structs validator. See https://github.com/go-playground/validator. We use a single instance of validator, as it caches struct info