Documentation Guidelines

This page explains how the Interstellio documentation is organized and how to read it, so you can find what you need quickly. It is worth a few minutes before you follow any of the product or integration guides.

How to use this documentation

The documentation is organized by product. Interstellio offers two products, each with its own section in the navigation.

Lunar is the network software you license and run on your own servers.
NebularStack is the managed (SaaS) platform.

If you are new, start with the RADIUS+AAA Solution overview. It explains how the two products fit together, then points you to the right section for your needs.

Documentation Structure

Each product provides one or more services, and every service is indexed in the navigation. Where a service exposes an API, its API documentation is the last item in that service's sub-navigation.

Read the introductory guides for a product before diving into a specific service.

Navigation Categories

Item	Description
Overview	Interstellio documentation home.
Guidelines	This page. How the documentation is organized.
RADIUS+AAA Solution	How Lunar and NebularStack provide a complete AAA solution.
Lunar	The Lunar network software documentation.
NebularStack	The NebularStack managed platform documentation.
NebularStack > Services	Individual services (Identity, Subscriber Management, Ticketing, etc.).
NebularStack > Services > API	API documentation specific to a service.

Keyword Definitions

Our keyword usage is based on IETF RFC2119.

In many of our documents, several words signify the requirements for API parameters, pre-configured resources and other dependencies. These words are often capitalized.

MUST This word, or the terms "REQUIRED" or "SHALL", mean that the definition is an absolute requirement of the specification.
MUST NOT This phrase, or the phrase "SHALL NOT", means that the definition is an absolute prohibition of the specification.
SHOULD This word, or the adjective "RECOMMENDED", means that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.
SHOULD NOT This phrase, or the phrase "NOT RECOMMENDED" means that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood, and the case should be carefully weighed before implementing any behavior described with this label.
MAY This word, or the adjective "OPTIONAL", means that an item is truly optional.