Skip to content
This repository has been archived by the owner on May 2, 2019. It is now read-only.
/ tempest-login Public archive

Desktop authentication utility.

License

Notifications You must be signed in to change notification settings

ZephyrVR/tempest-login

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Zephyr Login

NOTE: This project was part of Project Tempest and is no longer actively maintained.

Desktop application built with Electron which enables a user to quickly authenticate with Zephyr Server.

Usage

This program is intended for use with other software distributions (for example, Zephyr Overlay) to enable users to quickly and securely authenticate with Zephyr Server.

If you're a developer, you just need a Zephyr API key and App ID to begin.

Configuration

There are a couple of options to configure Zephyr Login depending on your preference.

Environment variables

You can set the following environment variables before execution to configure the utility:

  • ZEPHYR_SERVER_BASE - the base url of the Zephyr Server instance
  • ZEPHYR_API_KEY - your app's API key (keep secret)
  • ZEPHYR_APP_ID - the App ID associated with your application

Config file

Alternatively, you can configure the utility by either directly editing the config.json file found here or by creating a file named config-private.js (see example) in the same directory.

Output

Upon successful login, a file named token.json will be created in your current working directory. This file contains the reponse from the Zephyr Server authentication result. Below is an example of such token:

{
   "name": "Username",
   "avatar": "https://steamcdn-a.akamaihd.net/.../image.jpg",
   "room": "Zephyr Room ID",
   "token": "Zephyr Token"
}