Sphere Documentation INDEX

Welcome to the Sphere documentation. Learn how to set up, configure, and make the most of our IT asset management platform.

New to Sphere?

Start with our Quick Start guide to get up and running in minutes.

Installation

Sphere can be deployed in multiple ways depending on your needs and infrastructure.

Cloud (Recommended)

The fastest way to get started. We handle all infrastructure, security, and updates.

Sign up for a Sphere account at app.sphere.wf
Complete the onboarding wizard
Start adding your assets

Self-Hosted (Enterprise)

Deploy Sphere on your own infrastructure for complete control.

# Clone the repository
        git clone https://github.com/your-org/sphere.git
        cd sphere

        # Install dependencies
        npm install

        # Build the application
        npm run build

        # Start the server
        npm start

Requires Enterprise plan. See pricing for details.

Quick Start

Get started with Sphere in just a few minutes.

1

Create Your Account

Sign up at app.sphere.wf and verify your email address.

2

Add Your First Asset

Navigate to Assets > Add Asset and enter your device information.

3

Invite Team Members

Go to Settings > Users to invite your team and set permissions.

4

Set Up Alerts

Configure notifications for license renewals and warranty expirations.

Configuration

Customize Sphere to fit your organization's needs.

System Settings

Setting	Description	Default
Timezone	System timezone for all timestamps	UTC
Date Format	Preferred date format	MM/DD/YYYY
Default Currency	Currency for financial reports	USD
Asset Naming	Automatic asset ID generation	Auto-increment

Asset Management

Learn how to manage your hardware and software assets effectively.

Adding Assets

Assets can be added manually or discovered automatically through network scanning.

Navigate to Assets > Add Asset to manually add a device. For automatic discovery, go to Settings > Discovery and configure your network scanners.

Asset Categories

Organize your assets with custom categories and fields.

Laptops & Desktops
Mobile Devices
Servers
Network Equipment
Peripherals
Custom Categories

License Management

Track and manage software licenses to ensure compliance and optimize costs.

License Types

Per User

Licenses assigned to individual users

Per Device

Licenses tied to specific devices

Concurrent

Shared licenses with usage limits

Site-Wide

Unlimited use within organization

Cloud Resources

Manage your cloud assets across AWS, Azure, and Google Cloud.

Supported Providers

AWS

Azure

Google Cloud

User Management

Manage user access and permissions within your organization.

User Roles

Role	Permissions
Admin	Full system access
Manager	Manage assets and users
User	View and checkout assets
Viewer	Read-only access

API Reference

Integrate Sphere with your existing systems using our REST API.

Authentication

All API requests require an API key in the header:


        Authorization: Bearer YOUR_API_KEY

Endpoints

GET /api/v1/assets

List all assets

POST /api/v1/assets

Create a new asset

PUT /api/v1/assets/:id

Update an asset

DELETE /api/v1/assets/:id

Delete an asset