first candidate for launch

This commit is contained in:
2026-05-28 07:21:42 -06:00
parent 9e4d26de44
commit 9e24a217ed
70 changed files with 1117 additions and 484 deletions

View File

@@ -0,0 +1,10 @@
---
weight: 160
title: "Enterprise"
description: "Account management, billing, Cores, domains, and team administration for Federated Enterprise."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---

View File

@@ -0,0 +1,10 @@
---
weight: 188
title: "Account"
description: "Manage your account settings and user profile information."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---

View File

@@ -0,0 +1,23 @@
---
weight: 189
title: "Account Settings"
description: "Change your company name and point of contact."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
Account settings control organization-level information that applies to your entire account. Only **Owners** and **Admins** can edit account settings.
## What You Can Change
- **Company Name** — The name of your organization as it appears on invoices and throughout the platform.
- **Point of Contact** — The primary contact user for the account. This is used for important account communications, billing notifications, and support interactions. By default, the Owner is the point of contact, but it can be changed to any active user on the account.
## Accessing Account Settings
Navigate to **Account** in the dashboard sidebar, then select **Settings**. Make your changes and save.
> **Note:** Billing address changes are handled separately. Contact support if you need to update the billing address on your account.

View File

@@ -0,0 +1,31 @@
---
weight: 190
title: "Changing User Information"
description: "How to update your own profile or another user's profile."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
Each user can update their own profile information. Admins and Owners can also update the profile information of other users on the account.
## What You Can Change
- **First and last name**
- **Email address** — must be unique across all Federated Enterprise users
## Updating Your Own Profile
Click your name or avatar in the top navigation to access your profile settings, then update your information and save.
## Updating Another User's Profile (Admin / Owner)
1. Go to **Team** in the dashboard.
2. Click on the user whose profile you want to edit.
3. Update their name or email and save.
## Changing Your Password
You can change your password from your profile settings. You'll need to enter your current password to confirm the change. If you've forgotten your password, use the **Forgot Password** link on the login page to receive a reset link by email.

View File

@@ -0,0 +1,12 @@
---
weight: 193
title: "Admin Guide"
description: "Internal documentation for Federated Computer staff with admin access."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
> **Internal use only.** This section is intended for Federated Computer staff with admin access. Do not share this content publicly or include it in external-facing documentation.

View File

@@ -0,0 +1,32 @@
---
weight: 195
title: "Adjusting Balances"
description: "How to manually credit or debit an account's balance."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
> **Internal use only.**
Admins can manually credit or debit an account's balance. This is used for issuing manual credits (goodwill adjustments, refunds, promotions) or correcting erroneous balance entries.
## How to Adjust a Balance
1. Open the account in the Admin panel.
2. Navigate to the **Balance** section.
3. Click **Adjust Balance**.
4. Choose the adjustment type: **Credit** or **Debit**.
5. Enter the amount in dollars (minimum $0.01).
6. Enter a **reason/description** for the adjustment. This is recorded in the transaction history and visible to account owners.
7. Confirm.
## Credits vs Debits
**Credit** — Adds funds to the account's balance. The account can use these funds toward future charges. Use credits for goodwill adjustments, service credits, or correcting undercharges.
**Debit** — Removes funds from the account's balance. Use debits to correct accidental credits or to reclaim balance for a specific reason. A debit cannot reduce the balance below zero — if the requested debit exceeds the available balance, it will fail.
> **Best Practice:** Always include a clear, specific description when adjusting a balance. Descriptions like "Goodwill credit — service outage 2024-11" are far more useful than generic notes like "adjustment". These are visible in the transaction history and may be referenced by support or finance.

View File

@@ -0,0 +1,44 @@
---
weight: 198
title: "Invoices and Retrying Failed Payments"
description: "How to view invoices, void open charges, and manually retry failed payments."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
> **Internal use only.**
Admins can view all invoices for any account, void open invoices, and manually trigger a retry on failed payments.
## Viewing Invoices
From an account's detail page, click **View Invoices** to see all invoices for that account. Each invoice shows its type, amount, date, period, status, and any retry attempts with their outcomes.
## Invoice Statuses
- `open` — Invoice has been created but payment has not been collected (either pending or failed).
- `paid` — Payment was successfully collected.
- `void` — Invoice has been voided. No payment will be attempted.
## Voiding an Invoice
Only `open` invoices can be voided. Voiding an invoice cancels any pending retry attempts and marks the invoice as permanently closed. Use this when a charge should not be collected — for example, if a billing error occurred and the charge is not owed.
To void an invoice, open the invoice detail and click **Void Invoice**. Confirm the action. This cannot be undone.
> **Caution:** Voiding an invoice does not issue a refund if the invoice was already paid. Only open invoices can be voided. For paid invoices that require a reversal, use a balance credit to compensate the account.
## Retrying a Failed Payment
The system automatically retries failed payments on a schedule (3 days, 7 days, 14 days after failure). If you need to trigger a retry manually — for example, after a customer has updated their card — you can do so from the invoice detail view by clicking **Retry Now**.
## Regenerating Invoice PDFs
If an invoice PDF was not generated correctly, you can regenerate it from the invoice detail view using the **Regenerate PDF** action. The new PDF will be stored and available for the customer to download.
## Payment Failure and Account Suspension
If all automatic retry attempts fail, the account may be suspended automatically. At that point, an admin can either manually retry the payment after the customer resolves their payment issue, or change the account status to reflect the appropriate resolution.

View File

@@ -0,0 +1,45 @@
---
weight: 194
title: "Managing Accounts"
description: "How to view, suspend, reactivate, and cancel customer accounts."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
> **Internal use only.**
Admins can view all accounts, inspect their details, and change their status from the admin panel. Navigate to **Admin → Accounts** to see a list of all accounts with summary information.
## Viewing an Account
Click any account to open the detail view. You'll see:
- Account details: company name, address, status, tier, Stripe customer ID
- Subscription details and any pending tier change
- Active subscription add-ons
- All users on the account with their roles
- Coupon history (codes applied and removed)
- Current account balance
## Account Statuses
An account can be in one of the following states:
- `pending_email` — Account created; user hasn't verified their email yet.
- `pending_checkout` — Email verified; awaiting checkout completion.
- `active` — Fully active, paying account.
- `suspended` — Account access is disabled. Cores are offline. Billing may still be running.
- `canceled` — Account has been terminated. Access is permanently revoked.
## Changing Account Status
From the account detail view, use the **Change Status** action to set an account to `active`, `suspended`, or `canceled`.
- **Suspending** an account sends a disable notification to the Provisioner, which takes Cores offline. The account owner receives a suspension notification email.
- **Reactivating** a suspended account sends an enable notification to the Provisioner, bringing Cores back online.
- **Canceling** permanently terminates the account. This action cannot be reversed through the admin panel. The account owner receives a cancellation email.
> **Caution:** Canceling an account is irreversible. Only cancel accounts when you are certain the action is correct. If you only need to temporarily disable access, use **Suspended** instead.

View File

@@ -0,0 +1,37 @@
---
weight: 197
title: "Managing Coupons"
description: "How to create coupons, set usage limits, and control what they apply to."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
> **Internal use only.**
Coupons can be created and managed from **Admin → Coupons**. Coupons are currently applied at checkout only.
## Creating a Coupon
Click **Create Coupon** and fill in the following fields:
- **Code** — The code customers will enter at checkout. Codes are stored in uppercase and must be unique. Letters, numbers, and hyphens are recommended.
- **Type** — One of three discount types:
- `percent` — Percentage discount. Set *Value* to the percentage (e.g., `20` for 20% off).
- `fixed` — Fixed dollar discount. Set *Value* to the amount in cents (e.g., `5000` for $50 off).
- `free` — Covers the full charge. Value is ignored.
- **Value** — The discount amount (percentage or cents, per type above). Set to 0 for free-type coupons.
- **Max Uses** — Optional. Maximum number of times this coupon can be used. Leave blank for unlimited uses.
- **Covers Domains** — If checked, the discount also applies to domain registration costs at checkout. If unchecked, the discount applies to the plan fee only.
## Toggling a Coupon
Any coupon can be activated or deactivated. Deactivated coupons are rejected at checkout even if they haven't reached their usage limit. Use this to quickly disable a coupon without deleting it.
## Viewing Coupon Usage
The Coupons list shows each coupon's current use count alongside its limit. You can also see coupon history on individual account pages — this shows which coupon was applied, when, and whether it was later removed.
> **Note:** Coupons cannot currently be applied to post-signup billing. If a customer needs a recurring discount, use balance adjustments (credits) as an alternative.

View File

@@ -0,0 +1,51 @@
---
weight: 196
title: "Managing Tiers"
description: "How to create, modify, and toggle plan tiers."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
> **Internal use only.**
Admins can view, create, modify, and toggle the active status of plan tiers from **Admin → Tiers**. Changes to tier pricing or limits affect new billing cycles going forward; they do not retroactively change existing invoices.
## Viewing Tiers
The Tiers page shows all tiers — both active and inactive — with their pricing and current settings.
## Editing an Existing Tier
Click on a tier to edit its details:
- **Name** — Display name shown to customers
- **Membership fee** — Monthly flat fee in cents
- **Per-Core price** — Monthly per-Core charge in cents
- **Credit cents** — Account credit included at signup (charged at checkout, loaded to balance)
- **Max Cores** — Maximum Cores allowed (0 = unlimited)
## Toggling Tier Availability
Each tier can be set to **active** or **inactive**. Inactive tiers are not visible or selectable by customers during checkout or plan changes. Existing accounts on an inactive tier are not affected — they remain on their current tier; only new sign-ups and tier changes are blocked.
## Creating a New Tier
Use the **Create Tier** button to define a new tier. You'll need to provide:
- A unique key (lowercase, no spaces — used internally and in the database, e.g. `enterprise_plus`)
- A display name
- Membership fee, per-Core price, credit cents, and max Cores
After creating a tier, you'll also need to configure its add-on pricing via the Add-on admin tools if you want that tier to support per-Core or subscription add-ons.
## Changing an Account's Tier (Admin Override)
From an account's detail view, admins can change that account's tier directly. This is separate from the customer-facing plan change flow. Admins can choose to apply the change **immediately** or **at the next billing cycle**.
- **Immediate** — Takes effect right away; new pricing applies from the current date.
- **Next billing cycle** — Behaves like a customer-initiated plan change.
> **Caution:** Immediate tier changes can affect an account's mid-cycle billing calculations. Use this sparingly and document the reason when performing immediate overrides.

View File

@@ -0,0 +1,10 @@
---
weight: 175
title: "Billing"
description: "Plans, pricing, balances, cycles, and payment management."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---

View File

@@ -0,0 +1,41 @@
---
weight: 177
title: "Account Balance"
description: "What the account balance is, how to add funds, and how it's used."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
Your account balance is a prepaid credit pool that can be used to pay for any charges on your account — including Core provisioning fees, domain registrations, domain renewals, and add-ons. Think of it like a store credit tied to your account.
## How It Works
Whenever a charge is incurred, your available balance is applied first. Only the portion of the charge that exceeds your balance is billed to your card. For example, if you have a $20 balance and incur a $30 charge, $20 comes from your balance and $10 is charged to your card.
## Included Credit at Checkout
When you complete checkout, your plan includes an account credit that is loaded onto your balance:
- **Enterprise:** $100.00 credit included
- **Consultant:** $40.00 credit included
- **Pay-As-You-Go:** No included credit
This credit is part of your first-month charge — it's prepaid funds loaded to your balance to offset ongoing charges throughout the month.
## Adding Funds
Only **Owners** and **Admins** can add funds. To top up your balance:
1. Go to **Billing** in the dashboard.
2. Click **Add Funds**.
3. Enter the amount you want to add. The minimum top-up amount is **$10.00**.
4. Confirm. The amount is charged to your card on file and added to your balance immediately.
## Viewing Your Balance
Your current balance is shown on the Billing page. You can also review all balance transactions — including credits, debits, and top-ups — in the transaction history on the same page.
> **Note:** Account balances are non-transferable and are not refunded automatically upon cancellation. Contact support if you have questions about your balance.

View File

@@ -0,0 +1,37 @@
---
weight: 180
title: "Add-ons"
description: "Available add-ons, their functionality, and per-tier pricing."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
Add-ons extend the functionality of your Cores or your account subscription. They're optional and can be added or removed at any time.
## Core Add-ons
Core add-ons are attached per Core and billed monthly based on how many Cores have the add-on active. Pricing varies by tier.
| Add-on | Description | Enterprise / Core | Consultant / Core | Pay-As-You-Go / Core |
|---|---|---|---|---|
| **Monitoring** | Core health monitoring and alerting | $8.00 | $10.00 | $15.00 |
| **Backup** | Automated Core backup | $10.00 | $15.00 | $15.00 |
| **Customer Service** | End-user customer service support for Core users | $15.00 | $20.00 | $22.00 |
| **Technical Support** | Technical support access | Included | Included | Included |
## Subscription Add-ons
Subscription add-ons are billed at a flat rate per month across your entire account, regardless of Core count.
| Add-on | Description | Price / Month | Availability |
|---|---|---|---|
| **Go-to-Market Support** | Flat-fee marketing and go-to-market support from the Federated team | $2,500.00 | Enterprise only |
## Managing Add-ons
Core add-ons can be added or removed from individual Cores on the Cores page. Subscription add-ons are managed from the Billing page. Only **Owners** and **Admins** can change add-ons.
When you add an add-on mid-cycle, the charge for the remaining days in the billing period is prorated and billed immediately. When you remove an add-on, it's canceled at the end of the current billing cycle.

View File

@@ -0,0 +1,33 @@
---
weight: 179
title: "Changing Your Plan"
description: "How to change your tier and when the change takes effect."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
You can change your plan tier at any time, but plan changes always take effect at the **start of your next billing cycle** — not immediately. Only **Owners** and **Admins** can change the plan.
## How to Change Your Plan
1. Navigate to **Billing** in the dashboard.
2. Click **Change Plan**.
3. Select your desired tier.
4. Confirm. A *pending tier change* is recorded. Your current tier remains active until your next billing date.
## What to Expect
After you schedule a plan change:
- Your current tier stays active — you keep your current pricing and features until the end of your billing period.
- On your next billing date, the new tier takes effect. Your new membership fee and per-Core pricing apply from that date forward.
- If the new tier doesn't support certain add-ons you currently have, those add-ons may be adjusted at the time the tier change applies.
## Canceling a Pending Plan Change
If you change your mind, you can cancel a pending plan change from the Billing page before your renewal date. Once the billing cycle rolls over and the new tier is applied, the change cannot be undone.
> **Note:** You cannot schedule a plan change while your subscription is already set to cancel at the end of the period. Remove the cancellation first if you want to change your plan.

View File

@@ -0,0 +1,30 @@
---
weight: 181
title: "Coupons"
description: "How coupon codes work at checkout."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
Coupon codes can be applied at checkout to reduce the initial charge when signing up for a Federated Enterprise account. If you have a coupon code, you can enter it during the checkout process before confirming your payment.
## Types of Discounts
Coupons can be configured in several ways:
- **Percentage discount** — Reduces the charge by a percentage (e.g., 20% off).
- **Fixed discount** — Reduces the charge by a set dollar amount.
- **Free** — Covers the full charge.
## What a Coupon Applies To
By default, coupons apply to your plan fee only. Some coupons are configured to also cover domain registration costs — these will be noted when you validate a code.
## Coupon Limits
Some coupons have a maximum number of uses. If a coupon is fully redeemed, it will no longer be accepted. Coupons may also have expiration dates.
> **Note:** Coupons are currently only applicable at checkout and cannot be applied retroactively to an existing account's billing. Contact support if you have questions about a coupon code.

View File

@@ -0,0 +1,37 @@
---
weight: 182
title: "Invoices and Payment History"
description: "Where to find your invoices and how to download PDFs."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
Every charge to your account generates an invoice. Invoices are emailed to your account's contact email address automatically when a payment is processed.
## Finding Your Invoices
All invoices and payment history are available in the **Billing** section of your dashboard, under the **Invoices** tab. Each invoice shows:
- Invoice date and billing period
- Line items (membership fee, Core fees, add-ons, domains, etc.)
- Total charged
- Payment status (paid, open, or void)
## Downloading a PDF Invoice
Each invoice can be downloaded as a PDF. Click the invoice in the list and use the **Download PDF** option. The PDF includes a full line-item breakdown and is suitable for accounting purposes.
## Invoice Types
The platform generates several types of invoices, which you may see in your history:
- **Subscription** — Monthly billing cycle charge
- **Setup** — Initial checkout charge
- **Core** — Mid-cycle prorated Core or add-on charge
- **Domain Purchase** — New domain registration
- **Domain Renewal** — Annual domain renewal
- **Add-on** — Standalone add-on purchase
- **Balance Top-up** — Manual funds added to account balance

View File

@@ -0,0 +1,39 @@
---
weight: 178
title: "Subscription and Billing Cycles"
description: "How monthly billing works, what's charged each cycle, and how failed payments are handled."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
Your subscription renews monthly on the same date each month — specifically, one month from when you completed checkout. For example, if you signed up on the 14th of March, your renewal date is the 14th of each subsequent month.
## What's Billed Each Cycle
On your renewal date, the platform calculates and charges:
- **Membership fee** — your plan's flat monthly fee
- **Core fees** — your per-Core rate × the number of active Cores on your account
- **Core add-on fees** — per-Core monthly charges for any add-ons active on your Cores
- **Subscription add-on fees** — flat monthly fees for any account-level add-ons
## How Billing Works
Your account balance is always applied first. Any remaining amount after balance is charged to your payment method on file. You'll receive an invoice by email for each billing cycle.
## Failed Payments
If a payment fails, the platform will retry automatically. The retry schedule is:
- **First retry:** 3 days after the failed attempt
- **Second retry:** 7 days after the failed attempt
- **Third retry:** 14 days after the failed attempt
You'll receive email notifications when a payment fails and again as each retry approaches. If all retries are exhausted without a successful payment, your account may be suspended. Update your payment method as soon as possible to avoid service interruption.
## Prorating
Items added mid-cycle — such as new Cores or Core add-ons — are prorated. You're charged only for the number of days remaining in the current billing period when the item was added.

View File

@@ -0,0 +1,36 @@
---
weight: 176
title: "Understanding Your Plan"
description: "A breakdown of all plan tiers and what each one includes."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
Federated Enterprise offers three plan tiers. Each tier has a different membership fee, per-Core pricing, and included account credit. The right tier depends on your scale and how heavily you'll use the platform.
## Plan Tiers
| Feature | Enterprise | Consultant | Pay-As-You-Go |
|---|---|---|---|
| Monthly membership fee | $400.00 | $200.00 | $0.00 |
| Per-Core / month | $10.00 | $15.00 | $55.00 |
| Included account credit | $100.00 | $40.00 | $0.00 |
| SSH key provisioning | Yes | Yes | Yes |
| Provisioner API access | Yes | Yes | Yes |
| Technical support | Yes | Yes | Yes |
| Core limit | Unlimited | Unlimited | Unlimited |
## Which Tier Is Right for You?
**Enterprise** is best for organizations running many Cores regularly. The higher membership fee is offset by significantly lower per-Core pricing ($10 vs $55), so it pays off quickly at scale.
**Consultant** is a middle ground — ideal for organizations running a moderate number of Cores, or those who want a lower commitment than the full Enterprise tier.
**Pay-As-You-Go** has no monthly commitment. You pay only for what you use. The per-Core rate is the highest of the three tiers, but if your Core usage is low or sporadic, this can be the most cost-effective option.
## Add-on Pricing by Tier
Core add-on pricing (Monitoring, Backup, Customer Service) also varies by tier. Enterprise accounts get the lowest add-on rates. See [Add-ons](add-ons.md) for the full pricing breakdown.

View File

@@ -0,0 +1,21 @@
---
weight: 183
title: "Updating Your Payment Method"
description: "How to update the card on file for your account."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
Only **Owners** and **Admins** can update the payment method on file. Your payment method is used for all charges that exceed your account balance, as well as balance top-ups.
## How to Update Your Card
1. Go to **Billing** in the dashboard.
2. Click **Update Payment Method**.
3. Enter your new card details in the secure card form.
4. Save. The new card becomes your default payment method immediately.
> **Important:** Keep your payment method up to date to avoid missed payments and potential account suspension. If a billing charge fails due to an expired card, the platform will retry, but each failed attempt delays service renewal.

View File

@@ -0,0 +1,10 @@
---
weight: 166
title: "Cores"
description: "Provision and manage dedicated compute units for your organization."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---

View File

@@ -0,0 +1,29 @@
---
weight: 169
title: "Deleting a Core"
description: "How to permanently remove a Core from your account."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
Deleting a Core permanently removes it from your account. Only **Owners** and **Admins** can delete Cores.
## How to Delete a Core
1. Go to **Cores** in the dashboard.
2. Locate the Core you want to remove.
3. Click the delete action for that Core.
4. Confirm the deletion. The Core is immediately decommissioned.
> **Warning:** Deleting a Core is **permanent and irreversible**. Any data or configuration on the Core will be lost. Make sure to back up anything important before proceeding.
## Billing After Deletion
Deleted Cores are removed from your billing at the end of the current billing cycle. You will not be charged for a deleted Core in the following month. There is no prorated refund for the portion of the current month that remains after deletion — the Core runs until the end of the period.
## Add-ons on Deleted Cores
Any add-ons attached to a deleted Core are automatically canceled when the Core is deleted. You will not be billed for those add-ons in subsequent billing cycles.

View File

@@ -0,0 +1,32 @@
---
weight: 168
title: "Provisioning a Core"
description: "How to provision a new Core from the dashboard."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
Provisioning a Core starts a new compute instance under your account. Owners and Admins can provision Cores from the Cores section of the dashboard.
## How to Provision a Core
1. Navigate to **Cores** in the main navigation.
2. Click **Provision a Core**.
3. Optionally, select any add-ons you'd like enabled on this Core (Monitoring, Backup, etc.).
4. Confirm. The Core is created immediately and moves into **Provisioning** status while the Provisioner sets it up.
5. Once provisioning completes, the Core will show as **Active** with its assigned IP address visible in the dashboard.
## Billing for New Cores
Cores are charged on a monthly basis as part of your regular billing cycle. When you provision a Core mid-cycle, the cost for the remaining days in the current period is **prorated** — you're only charged for the time the Core was active, not the full month.
Any Core add-ons selected at provisioning are also prorated in the same way.
> **Note:** Your account balance is used first when any charge is incurred. Only the amount exceeding your balance is charged to your card. See [Account Balance](../billing/account-balance.md) for details.
## SSH Access
Your account SSH key pair (generated at checkout) is the credential used by the Provisioner when setting up your Core. You can find your SSH public key in **Account Settings**. Enterprise and Consultant tier accounts can also use the Provisioner API directly to automate Core management.

View File

@@ -0,0 +1,32 @@
---
weight: 167
title: "What Are Cores"
description: "An introduction to Cores — dedicated compute units tied to your account."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
A **Core** is a dedicated compute unit provisioned to your account. Think of it as a private server that Federated manages on your behalf — you don't deal with hardware or hosting directly, but the Core is exclusively yours.
Each Core has its own IP address and is provisioned into your account's environment. Cores are billed on a per-unit, per-month basis on top of your membership fee. The exact per-Core price depends on your plan tier.
## Core States
A Core moves through several states during its lifecycle:
- **Available** — The Core has been allocated to your account but provisioning hasn't started yet.
- **Provisioning** — The Provisioner is actively setting up the Core. This typically takes a few minutes.
- **Active** — The Core is live and operational, accessible at its assigned IP address.
- **Failed** — Provisioning encountered an error. Contact support if a Core is stuck in this state.
- **Decommissioned** — The Core has been deleted and is no longer running.
## Core Add-ons
Each Core can have optional add-ons attached to it, such as Monitoring, Backup, Customer Service, and Technical Support. Add-ons are billed per Core, per month. See [Add-ons](../billing/add-ons.md) for pricing and details.
## Core Limits
Your plan tier may define a maximum number of Cores. The Enterprise and Consultant tiers have no hard Core limit by default. Check your plan details or contact support if you need to confirm your Core limit.

View File

@@ -0,0 +1,10 @@
---
weight: 170
title: "Domains"
description: "Manage Federated and custom domains for your account."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---

View File

@@ -0,0 +1,26 @@
---
weight: 172
title: "Buying a Custom Domain"
description: "How to search for and purchase a custom domain from the dashboard."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
You can add custom domains to your account either during checkout or at any time from the **Domains** section of the dashboard. Only **Owners** and **Admins** can purchase domains.
## Checking Domain Availability
Before purchasing, you can search for a domain name to check whether it's available and see the registration and renewal pricing. Enter the full domain name including the TLD (e.g., `mycompany.com`).
## Purchasing a Domain
1. Go to **Domains** in the dashboard and click **Add Domain**.
2. Search for your desired domain name to confirm availability and pricing.
3. Confirm the purchase. The displayed price is for a one-year registration.
4. Payment is processed immediately. Your account balance is applied first; any remaining amount is charged to your card on file.
5. The domain is registered with our registrar partner. Registration can take a few minutes to complete. You'll receive an invoice by email.
> **Note:** Domain registration failures are rare but can occur if the domain becomes unavailable between your availability check and the registration attempt. If a registration fails, your payment is refunded automatically and you'll receive a notification email.

View File

@@ -0,0 +1,28 @@
---
weight: 173
title: "Domain Renewal"
description: "How custom domain renewal works, including auto-renewal and failure handling."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
Custom domains are registered for one year at a time. Federated Enterprise automatically handles renewal so your domains stay active without manual intervention.
## Auto-Renewal
By default, all custom domains are set to **auto-renew**. Before a domain expires, the platform will charge the renewal fee to your account (balance first, then card) and renew the registration for another year.
You can toggle auto-renewal on or off for individual domains from the Domains page. Only **Owners** and **Admins** can change this setting.
> **Warning:** If you disable auto-renewal, you are responsible for renewing the domain before it expires. An expired domain may become available for registration by others and can disrupt your Cores and services.
## Renewal Failures
If a renewal charge fails (e.g., due to an expired card or insufficient balance), you'll receive a notification email. The platform will attempt the renewal again, but it's important to ensure your payment method is up to date to avoid service interruption.
## Federated Domains
Federated-managed domains (`federatedcomputer.cloud`, `federatedcomputer.net`, `fedcom.net`) are maintained by Federated Computer and never expire or require renewal from your side.

View File

@@ -0,0 +1,38 @@
---
weight: 171
title: "Federated Domains vs Custom Domains"
description: "Understand the two domain options available for your account."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
Every Federated Enterprise account requires at least three domains. These domains are used by your Cores and the platform to route traffic, send email, and serve your environment. You can choose between two types of domains.
## Federated Domains
Federated Computer provides a set of shared domains that you can use at no extra cost:
- `federatedcomputer.cloud`
- `federatedcomputer.net`
- `fedcom.net`
These domains are owned and managed by Federated Computer. Using them requires no registration fees and no renewal management on your end — they're always active for as long as your account is active. This is the fastest way to get started and is fully functional for most use cases.
## Custom Domains
If you want to run your environment under your own brand, you can register custom domains through the Federated Enterprise platform. Custom domains are purchased through our domain registrar partner and are registered to your account.
Custom domains carry a registration fee (paid at checkout or when added post-signup) and an annual renewal fee. Domain pricing varies by TLD. You can check availability and current pricing in the checkout flow or on the Domains page in your dashboard.
## Comparison
| Feature | Federated Domains | Custom Domains |
|---|---|---|
| Registration cost | Free | Varies by TLD |
| Annual renewal | Free | Varies by TLD |
| Your own brand | No | Yes |
| Available immediately | Yes | After registration |
| Managed by Federated | Yes | No |

View File

@@ -0,0 +1,18 @@
---
weight: 174
title: "Why 3 Domains Are Required"
description: "The technical reason your account needs a minimum of three domains."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
Federated Enterprise requires a minimum of **three domains** when you sign up, and this is a technical requirement of the platform — not an arbitrary constraint.
The underlying Federated Core platform uses multiple domains in tandem to support the various services that run on your Cores. These services include unified messaging, unified storage, authentication, and other components of the Core environment. Each domain serves a distinct functional purpose in the platform's routing and service delivery architecture.
Having three separate domains ensures that services can be isolated, routed independently, and remain resilient if one domain encounters an issue. It also allows the platform to properly configure email delivery, SSL certificates, and service endpoints across your environment.
> **Note:** If you're unsure which domains to register, choosing the free Federated Domains option at checkout gets you a compliant, fully functional three-domain setup with no additional cost or configuration required.

View File

@@ -0,0 +1,10 @@
---
weight: 161
title: "Getting Started"
description: "Sign up, complete checkout, and get your account up and running."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---

View File

@@ -0,0 +1,33 @@
---
weight: 165
title: "Account Cancellation"
description: "What happens when you cancel your Federated Enterprise subscription."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
You can cancel your Federated Enterprise subscription at any time from the Billing page. Cancellation is immediate in the sense that it's recorded right away, but your access continues until the end of your current billing period.
## What Happens When You Cancel
- Your subscription is marked as canceling. You will not be billed again.
- You retain full access to your account, Cores, and domains until the end of your current billing period.
- You'll receive a confirmation email with the date your access ends.
- On the cancellation date, your account is marked inactive, your Cores are decommissioned, and access to the platform is revoked.
> **Important:** Cancellation is **not reversible through self-service**. If you cancel and later want to use Federated Enterprise again, you will need to create a new account at enterprise.federated.computer. Your previous account's data, Cores, and configuration will not be restored.
## Undoing a Cancellation
If you change your mind before your access period ends, you can reverse the cancellation from the Billing page by clicking **Keep my subscription**. Once your access period has expired, the option is no longer available.
## Account Balance on Cancellation
Any remaining account balance is not automatically refunded when you cancel. Contact support if you have questions about your balance at the time of cancellation.
## Need Help?
Visit the [Federated Computer support portal](https://freescout.federated.computer/help/3593186542) for assistance.

View File

@@ -0,0 +1,43 @@
---
weight: 164
title: "Completing Checkout"
description: "Choose a plan, set up domains, and activate your account."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
After verifying your email, you'll land on the checkout page. This is where you choose your plan, set up domains, enter payment details, and activate your account. The process takes just a few minutes.
## 1. Choose a Plan Tier
Select the plan tier that fits your organization. See the [Tier Comparison](../reference/tier-comparison.md) for a full breakdown of pricing and features. Your tier determines your monthly membership fee, per-Core pricing, and which add-ons are available.
## 2. Set Up Your Domains
You'll need a minimum of three domains. You have two options:
- **Use Federated Domains** — Get set up instantly with `federatedcomputer.cloud`, `federatedcomputer.net`, and `fedcom.net` at no additional cost. These are managed by Federated Computer and require no registration fees.
- **Register Custom Domains** — Choose your own domain names. You can check availability and see pricing directly in the checkout flow. Custom domains are registered through Federated's domain partner and billed as part of your setup charge.
See [Federated Domains vs Custom Domains](../domains/federated-vs-custom-domains.md) for more detail.
## 3. Apply a Coupon (Optional)
If you have a coupon code, enter it at checkout to receive a discount on your initial charge. Coupons may reduce the plan fee, the domain cost, or both depending on the coupon configuration.
## 4. Enter Payment Details
Provide a credit or debit card. Your card will be charged immediately for the setup amount, which includes:
- Your first month's membership fee for the plan you selected
- An account credit equal to your plan's included credit (applied to future Core and billing charges)
- Domain registration fees for any custom domains (Federated domains are free)
## 5. Account Activation
Once payment is processed successfully, your account is activated. You'll receive an invoice by email confirming the charges. Your account is now live and you can begin provisioning Cores.
> **Note:** An SSH key pair is automatically generated for your account during checkout. This key is used by the Provisioner API to deploy Cores. You can view your public key in Account Settings.

View File

@@ -0,0 +1,26 @@
---
weight: 162
title: "Overview"
description: "What Federated Enterprise is and how the platform is organized."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
Federated Enterprise is a managed compute platform that gives your organization private, self-hosted infrastructure without the complexity of running it yourself. At its core, the platform lets you provision and manage **Cores** — dedicated compute units tied to your account — backed by a set of **domains** that route traffic to your environment.
Unlike shared cloud platforms, Federated Enterprise gives each account its own isolated compute resources. Your Cores belong to your account, run under your domains, and can be equipped with optional add-on services like monitoring and backups.
## What You Get
- One or more provisioned Cores (compute instances) under your account
- At least three domains — either Federated-managed domains or custom domains you register through the platform
- An SSH key pair automatically generated at checkout, allowing your team to connect to and manage Cores via the Provisioner API
- A billing structure based on your chosen plan tier, with transparent per-Core pricing
- A team workspace where you can invite colleagues at different permission levels
## How the Platform Is Organized
Your account is the top-level container for everything: your Cores, domains, users, and billing. One person signs up as the **Owner** and completes checkout; from there, additional team members can be invited. All Cores and domains belong to the account, not individual users.

View File

@@ -0,0 +1,35 @@
---
weight: 163
title: "Signing Up"
description: "Create your Federated Enterprise account and verify your email."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
Creating a Federated Enterprise account is a two-step process: first you create your account and verify your email, then you complete checkout to choose a plan and set up payment.
## Step 1 — Create Your Account
Navigate to **enterprise.federated.computer** and click **Get Started**. You'll be asked to fill in:
- **Company Name** — the name that will appear on your account and invoices
- **Your Name** (first and last)
- **Email Address** — this becomes your login and the account's primary contact email
- **Phone Number** (optional)
- **Password** — minimum 8 characters
- **Billing Address** — street, city, state/region, country, and postal code
> **Important:** The email address you provide must be unique across all Federated Enterprise accounts. If you see an error that an account already exists with that email, try signing in or use a different email address.
After submitting the form, you'll receive an activation email at the address you provided. The activation link expires in **24 hours**. Click the link to verify your email and advance your account to the checkout step.
## Step 2 — Complete Checkout
Once your email is verified, you'll be taken to the checkout flow. See [Completing Checkout](completing-checkout.md) for details on what happens next.
## Resending Your Activation Email
If your activation email doesn't arrive within a few minutes, check your spam folder. If you need a new link sent, return to the login page and use the **Resend activation email** option.

View File

@@ -0,0 +1,10 @@
---
weight: 191
title: "Reference"
description: "Quick-reference tables and comparisons."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---

View File

@@ -0,0 +1,57 @@
---
weight: 192
title: "Tier Comparison"
description: "Side-by-side comparison of all three Federated Enterprise tiers, including plan fees, Core pricing, and add-on rates."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
Use this reference to compare all three Federated Enterprise tiers side by side — including plan fees, Core pricing, and all add-on rates.
## Plan Pricing
| | Enterprise | Consultant | Pay-As-You-Go |
|---|---|---|---|
| Monthly membership fee | $400.00 / mo | $200.00 / mo | $0.00 / mo |
| Per-Core / month | $10.00 | $15.00 | $55.00 |
| Account credit at signup | $100.00 | $40.00 | $0.00 |
| Core limit | Unlimited | Unlimited | Unlimited |
## Core Add-on Pricing (per Core, per month)
| Add-on | Enterprise | Consultant | Pay-As-You-Go |
|---|---|---|---|
| Monitoring | $8.00 | $10.00 | $15.00 |
| Backup | $10.00 | $15.00 | $15.00 |
| Customer Service | $15.00 | $20.00 | $22.00 |
| Technical Support | Included | Included | Included |
## Subscription Add-on Pricing (flat rate per month)
| Add-on | Enterprise | Consultant | Pay-As-You-Go |
|---|---|---|---|
| Go-to-Market Support | $2,500.00 | — | — |
## Platform Features
| Feature | Enterprise | Consultant | Pay-As-You-Go |
|---|---|---|---|
| SSH key provisioning | Yes | Yes | Yes |
| Provisioner API access | Yes | Yes | Yes |
| Technical support | Yes | Yes | Yes |
| Federated Domains option | Yes | Yes | Yes |
| Custom domain registration | Yes | Yes | Yes |
| Go-to-Market Support add-on | Yes | — | — |
## Cost Examples
To illustrate the difference between tiers, here are example monthly costs for an account running 10 active Cores with no add-ons:
- **Enterprise:** $400 membership + (10 × $10) = **$500/mo**
- **Consultant:** $200 membership + (10 × $15) = **$350/mo**
- **Pay-As-You-Go:** $0 membership + (10 × $55) = **$550/mo**
At higher Core counts, Enterprise becomes more economical due to its lower per-Core rate. At very low Core counts (13 Cores), Pay-As-You-Go or Consultant may be more cost-effective than paying the Enterprise membership fee.

View File

@@ -0,0 +1,10 @@
---
weight: 184
title: "Team"
description: "Invite team members, manage roles, and control access."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---

View File

@@ -0,0 +1,24 @@
---
weight: 185
title: "Inviting a Member"
description: "How to invite a new user to your Federated Enterprise account."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
Only **Owners** and **Admins** can invite new users to an account. There is no limit on the number of users you can have.
## How to Invite a User
1. Navigate to **Team** in the dashboard.
2. Click **Invite Member**.
3. Enter the invitee's first name, last name, and email address.
4. Choose a role: **Admin** or **Member**.
5. Send the invite. The invitee will receive an email from Federated Computer with an activation link.
The activation link expires in **24 hours**. The invited user clicks the link to set their password and activate their account. Once activated, they can log in to the platform and access resources according to their role.
> **Note:** The invitation email includes the name of the person who invited them and the company name on the account. Let new team members know to check their spam folder if the email doesn't arrive promptly.

View File

@@ -0,0 +1,22 @@
---
weight: 187
title: "Removing a User"
description: "How to remove a team member from your account."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
Only **Owners** and **Admins** can remove users from an account. The account Owner cannot be removed.
## How to Remove a User
1. Go to **Team** in the dashboard.
2. Find the user you want to remove.
3. Click **Remove** next to their name and confirm.
Removing a user revokes their access immediately. They will no longer be able to log in to the account. Any actions they took on the account (Core provisioning, billing changes, etc.) are preserved in history — only their active access is revoked.
> **Note:** You cannot remove yourself from the account. If you are an Admin and need to leave the account, another Admin or the Owner must remove you.

View File

@@ -0,0 +1,37 @@
---
weight: 186
title: "User Roles"
description: "The three user roles and their permissions within an account."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
Federated Enterprise has three user roles. Each role has a defined set of permissions within the account.
## Permissions by Role
| Permission | Owner | Admin | Member |
|---|---|---|---|
| View Cores & Domains | Yes | Yes | Yes |
| Provision & delete Cores | Yes | Yes | No |
| Manage Core add-ons | Yes | Yes | No |
| Buy & manage domains | Yes | Yes | No |
| Manage billing & add funds | Yes | Yes | No |
| Change plan tier | Yes | Yes | No |
| Invite users | Yes | Yes | No |
| Change user roles | Yes | Yes | No |
| Remove users | Yes | Yes | No |
| Cancel account | Yes | Yes | No |
| Update account settings | Yes | Yes | No |
| Edit own profile | Yes | Yes | Yes |
## Role Descriptions
**Owner** — There is exactly one Owner per account. The Owner is the user who signed up and completed checkout. The Owner role cannot be changed or transferred through the UI — contact support if you need to transfer account ownership.
**Admin** — Admins have the same permissions as the Owner for day-to-day operations: managing Cores, domains, billing, and users. Admins cannot change the Owner's role and cannot perform actions that affect the Owner user directly.
**Member** — Members have read-only access. They can view Cores, domains, and billing information, but cannot make changes to any resources or account settings. This role is suitable for team members who need visibility without the ability to modify infrastructure.

View File

@@ -1,10 +0,0 @@
---
weight: 100
title: "Federated Core Platform"
description: ""
icon: "article"
date: "2025-08-25T12:26:41-06:00"
lastmod: "2025-08-25T12:26:41-06:00"
draft: false
toc: true
---

View File

@@ -1,10 +0,0 @@
---
weight: 140
title: "Billing"
description: ""
icon: "article"
date: "2025-08-26T14:35:48-06:00"
lastmod: "2025-08-26T14:35:48-06:00"
draft: false
toc: true
---

View File

@@ -1,14 +0,0 @@
---
weight: 141
title: "Account Management and Billing"
description: ""
icon: "article"
date: "2025-08-25T12:33:38-06:00"
lastmod: "2025-08-25T12:33:38-06:00"
draft: false
toc: true
---
Federated Core Platform includes a service allowing your customers to navigate to an information website to learn about Federated Core services and offerings, sign up for a management account, then procure/modify/cancel Core subscriptions.
The billing engine is the accounting engine that tallies all the various product offerings delivered to a customers. It is *not* a payment platform but works with your payment platform of choice including Stripe, Auth.net, various crypto services, or something built in-house.

View File

@@ -1,10 +0,0 @@
---
weight: 130
title: "Customization"
description: ""
icon: "article"
date: "2025-08-26T14:35:38-06:00"
lastmod: "2025-08-26T14:35:38-06:00"
draft: false
toc: true
---

View File

@@ -1,14 +0,0 @@
---
weight: 132
title: "Adding Software to Federated Core"
description: ""
icon: "article"
date: "2025-08-25T12:35:31-06:00"
lastmod: "2025-08-25T12:35:31-06:00"
draft: false
toc: true
---
It is easy to package an open source SaaS application to work on Federated Core Platform. The project simply needs to create a package for the docker container, service files describing how the application connects to LDAP and Authelia for authentication, descriptions of premium licenses and how Federated Core Platform needs to recognize those for inclusion in premium services (example: OIDC), and then a template file for allowing for the correct choice of virtual machine resources and the Federated Monitor and Fix to ensure great experience for the customer. This package is dropped into the Provisioner service manager and is ready to be purchased/deployed by the billing system.
In the near future, we plan to provide a portal for projects to package and submit software for inclusion on Federated Core Platform.

View File

@@ -1,14 +0,0 @@
---
weight: 131
title: "Core Workflow Intelligence"
description: ""
icon: "article"
date: "2025-08-25T12:34:45-06:00"
lastmod: "2025-08-25T12:34:45-06:00"
draft: false
toc: true
---
Federated will be delivering in early 2026 an "on premise" solution for using artificial intelligence to create and deploy workflows between open source SaaS applications offered by Federated Core Platform. The design goal is to empower a customer to, for example, use Core Workflow Intelligence to take a grouping of customers from EspoCRM, connect them, based on conditions or parameters, to the mailing list software, and send AI-generated email communications to those customers based on actions taken in the Woocommerce store on Core.
We believe these sorts of "software intelligence" are very important for the overall success of customers using Federated Core and are central to the idea that open source is the best means to achieve maximum flexibility and business differentiation from software. Further, we believe AI is uniquely situated to provide real progress in connecting software to software for custom workflows. It need not work in "real time" but in enough time to deliver the right solution to customers reliably.

View File

@@ -1,12 +0,0 @@
---
weight: 134
title: "Whitelabel"
description: ""
icon: "article"
date: "2025-08-28T12:01:52-06:00"
lastmod: "2025-08-28T12:01:52-06:00"
draft: false
toc: true
---
Federated Core Platform can be entirely white-labeled for all customer-facing services. Included services are: Dashboard, Panel, Computer, Core Desktop, Core Scanner, Core Workflow Intelligence, Account Management and Billing, and the "home" website for information and ordering.

View File

@@ -1,16 +0,0 @@
---
weight: 133
title: "Why Open Source Projects Work With Federated"
description: ""
icon: "article"
date: "2025-08-25T12:36:40-06:00"
lastmod: "2025-08-25T12:36:40-06:00"
draft: false
toc: true
---
More and more, open source projects work with Federated Computer because we simplify the go-to-market. An open-source project hoping to monetize by selling a cloud service is now in the business of creating great SaaS software but also making it multi-tenant, building an ecommerce experience, and building and running a (hopefully) large cloud service. With Federated Core Platform, open source SaaS companies can off-load much of that to Federated while still maintaining the ability to charge for premium features and services.
You can think of an open source SaaS developer as an extension of your Federated Core Platform continually adding value to your overall go-to-market. These developers think in the same way. While their principle concern is the success and completeness of their software, they recognize the value for customers when their software is integrated into a total solution with great user management, unified storage and messaging, and the many other conveniences and services offered by Federated Core Platform.
All pricing for software is done outside of Federated Core Platform giving each installation the flexibility to build use cases and go-to-market solutions apart from the technology offerings.

View File

@@ -1,48 +0,0 @@
---
weight: 100
title: "Federated Core Platform"
description: ""
icon: "article"
date: "2025-08-25T12:32:20-06:00"
lastmod: "2025-08-25T12:32:20-06:00"
draft: false
toc: true
---
The Federated Core Platform is a suite of software providing everything needed to deliver open source SaaS applications: integrate them to work well together; manage, patch, update the software; and provide bespoke customer service for customers.
The main component groups of Federated Core Platform are:
### Provisioning
1) **Provisioner:** interacts with cloud platform (eg Hetzner, Cloud Stack, OpenStack, Triton) to spin up virtual machine and install software and network;
2) **Core Server:** Federated Linux distribution for X64 and ARM virtual machines;
3) **Core Mini:** The minimal amount of software that must always be installed for a Core;
4) **Unified Storage:** architecture for shared storage between Core docker images;
5) **Unified Messaging:** email infrastructure for all docker images including autodiscover services;
6) **Authentication:** OIDC provider;
7) **Dashboard:** user creation, domain and application preferences;
8) **Computer:** end-user application for managing software links and workflows.
### Maintenance
1) **CoreScanner:** customer support application for monitoring and locked-down actions on customer infrastructure;
2) **Update and Upgrade:** system for discovering new software versions and pushing to customers;
3) **Monitor and Fix:** machine-learning to identify and solve operational issues based on customer support patterns.
### Customization
1) **Core Workflow Intelligence:** AI-driven workflows between SaaS applications;
2) **Adding Software to Federated Core:** how to add SaaS applications to Federated Core Platform;
3) **Why Open Source Projects Work With Federated:** the benefits of Federated Core Platform for open source SaaS projects.
### Billing
1) **Account Management and Billing:** tracking what is used and billed.
### Services
1) **Federated Management:** let Federated Computer run your cloud for or alongside your team;
2) **Customer Service and Support:** let Federated Computer provide 24/7 customer support for or alongside your team.
(Note: you can learn more about these components by selecting the documentation in the left navigation.)

View File

@@ -1,10 +0,0 @@
---
weight: 120
title: "Management"
description: ""
icon: "article"
date: "2025-08-26T14:35:18-06:00"
lastmod: "2025-08-26T14:35:18-06:00"
draft: false
toc: true
---

View File

@@ -1,18 +0,0 @@
---
weight: 121
title: "Core Scanner"
description: ""
icon: "article"
date: "2025-08-25T12:34:24-06:00"
lastmod: "2025-08-25T12:34:24-06:00"
draft: false
toc: true
---
Core Scanner is a utility to examine and manage each Core on a given installation of Federated Core Platform. It allows a customer service person to examine the Core, look at all the configuration files, see any anomalies in the files, track usage of resources (CPU, RAM, storage, network), and perform tightly managed actions on the Core to take remedial steps as needed.
Each installation of Core Scanner includes user and group priveleges so that the owner of the Federated Core Platform can look at all Cores running, but also partners can examine and manage the Cores of their customers. For example, a managed service provider may have a number of Cores for which they will want to be able to provide monitor and fix service3. Core Scanner allows them to see those Cores, only.
Core Scanner provides the ability to "take action" on a Core with a large library of pre-defined "actions" for each Core depending on the applications installed and the reality of the Core at the time of inspection. If a Core needs more storage, for example, "actions" are brought forward suggesting remedial action to the support person. There are also actions available to compare a given Core to normative Cores.
Core Scanner is supported by the "machine learning" functions in the [Update and Upgrade](update-and-upgrade.md) and [Monitor and Fix](monitor-and-fix.md) systems.

View File

@@ -1,16 +0,0 @@
---
weight: 123
title: "Monitor and Fix"
description: ""
icon: "article"
date: "2025-08-25T12:35:43-06:00"
lastmod: "2025-08-25T12:35:43-06:00"
draft: false
toc: true
---
Every Core running on an installation of Federated Core Platform, every application running on every Core, and every service not an application running on every Core, is monitored in real time to ensure it runs, has the system resources needed, and provides customers with the best experience. If there are anomalies detected, alerts are created and can be sent to the local Matrix server, and Federated Monitor and Fix system attempts to solve the problem using patterns and the service definitions in place.
For example, if a customer with a 500GB storage limit for their Files service decides to upload 3TB of files, the File service will fail, and Monitor and Fix will attempt to fix the problem by adding for block storage (if that service is available AND the service definition allows that to happen without customer "approval").
The Monitor and Fix system continues to get better and better as we see more patterns and improve the paths to successful amelioration of problems.

View File

@@ -1,16 +0,0 @@
---
weight: 122
title: "Update and Upgrade"
description: ""
icon: "article"
date: "2025-08-25T12:36:19-06:00"
lastmod: "2025-08-25T12:36:19-06:00"
draft: false
toc: true
---
Each Federated Core Platform installation has a Gitea respository where the software (OS, utilities, platform, open source SaaS) for the entire system is tracked. The operator of each installation is able to package those updates into regular upgrades pushed out to some/all Cores on the system, push them out individually for testing to some Cores, or schedule updates for a given list of Cores.
Since the nature of the Federated Core Platform is delivering open source SaaS to customers, there needs to be a testing protocol set up to ensure updates are in fact needed/wanted. Federated Computer does this centrally, so operators using Federated Core Platform can know the software will "work". However, there may be additional concerns with respect to security, other customizations that need to be tested, etc.
While Federated Core Platform draws much of the software from DockerHub, there are container images maintained by Federated Computer and, over time, more of the container images will come from Federated Computer rather than DockerHub. The principle reason for this is to add an additional step for quality and security.

View File

@@ -1,10 +0,0 @@
---
weight: 110
title: "Provisioning"
description: ""
icon: "article"
date: "2025-08-26T14:35:07-06:00"
lastmod: "2025-08-26T14:35:07-06:00"
draft: false
toc: true
---

View File

@@ -1,28 +0,0 @@
---
weight: 116
title: "Authentication"
description: ""
icon: "article"
date: "2025-08-25T12:33:49-06:00"
lastmod: "2025-08-25T12:33:49-06:00"
draft: false
toc: true
---
One of the obstacles to deploying open source SaaS is user management. When each application has its own user management, it becomes complicated to build a workable system for the business or team, to build reliable workflows across applications, and to ensure security for the business or team for data. Federated Core Platform provides two layers of authentication to deal with these problems.
### LDAP
The foundation of Federated Core Platform authentication is LDAP. Every application connects to LDAP. If it doesn't use LDAP, it doesn't work on the platform. There are some applications for which the *only* account in LDAP is the administrator and the other users are created in the application itself. And example is Vaultwarden (password manager) because of the very sensitive nature of the information in Vaultwarden *outside* of access to Core services. You create the user in Vaultwarden as the administrative user but then, the account is connected to Core LDAP (if desired).
LDAP services can be exposed to network outside of Core to be used by other systems that use LDAP. And example would be a collection of Windows, MacOS, Linux desktop computers where you want users to log in to this machines using their Core credentials from LDAP. You could also use Core LDAP for other software systems where you want to use a central user repository for access control such as virtual desktop environments.
Core LDAP support users and groups. For example, you can delegate administrative access controls to certain users in Nextcloud using LDAP.
LDAP is managed through the Federated Core app "Panel".
### OIDC
Single-sign on is provided in Federated Core Platform by Authelia. This allows, for example, a customer to log in to one open source SaaS application in a browser and to automatically log in to other Core applications in the same browser. It also allows the user to log out of all applications, in the same way.
Federated Core applications default to OIDC authentication when the application supports it. Most do. Some applications only support OIDC with a premium upgrade (also supported), but a few don't (yet) support OIDC or only support authentication using OIDC providers such as Google, etc. Federated plans to provide work arounds for all applications to use OIDC and have done this successfully for some (eg. cal.com).

View File

@@ -1,12 +0,0 @@
---
weight: 118
title: "Computer"
description: ""
icon: "article"
date: "2025-08-25T12:33:56-06:00"
lastmod: "2025-08-25T12:33:56-06:00"
draft: false
toc: true
---
Federated "Computer" is a new application coming in Fall, 2025 delivering a fully customizable front-end experience for Core users. It is a bookmarking application extended to support reminders, folders for watching applications, documents, events, the ability to pick up AI workloads and customizations, and more. Federated "Computer" is intended to be fully open-sourced, will work with other SaaS applications that support URLs, and will work natively on desktops, tablets, and mobile devices.

View File

@@ -1,14 +0,0 @@
---
weight: 175
title: "Core Desktop"
description: ""
icon: "article"
date: "2025-08-25T12:34:05-06:00"
lastmod: "2025-08-25T12:34:05-06:00"
draft: false
toc: true
---
Federated Core supports PXE-booting two different Linux distributions (OpenMandriva and Core Desktop based on Arch) when a customer wants to complete solution for their team or office. These desktops are tied into Federated Core Authentication, have all the desktop applications (email, calendar, contacts, bookmarks, file synchronization, applications that take advantage of Nextcloud and other desktop applications) pre-configured and redy to use for the particular user as they log in to Core Desktop. This is a great solution for offices or use cases where it is important that each desktop be closely managed for the "correct" software and services so that it "just works".
Core Desktop can also be installed on laptops and other mobile computers so that on-the-go team members can get a computer that "just works" without the requirements for network access.

View File

@@ -1,44 +0,0 @@
---
weight: 113
title: "Core Mini"
description: ""
icon: "article"
date: "2025-08-25T12:34:18-06:00"
lastmod: "2025-08-25T12:34:18-06:00"
draft: false
toc: true
---
Core Mini is the minimal install of software on a Core before adding additional SaaS and any scaling services (e.g. load balancing). These are the fundamental services used by ever other SaaS application.
### Traefik
Firewall and network management.
### PowerDNS
Domain name service.
### Authelia
OIDC authentication provider.
### Mail Services
SMTP and IMAP services.
### Postgresql
Database engine for SaaS services requiring Postgresql.
### MariaDB
Database engine for SaaS services requiring MariaDB. The will likely be obsolete in the coming months.
### Autodiscovery
Service for providing autodiscovery for SaaS service that use autodiscovery services. Example: email and calendar client configuration.
### Federated Monitors
Softare for communicating with Federated management systems.

View File

@@ -1,14 +0,0 @@
---
weight: 112
title: "Core Server"
description: ""
icon: "article"
date: "2025-08-25T12:34:34-06:00"
lastmod: "2025-08-25T12:34:34-06:00"
draft: false
toc: true
---
Federated maintains its own Linux distribution for the specific purpose of control of the types and versions of software used in virtual machine. This descrease the surface area for attacks, increased maintainability for the Cores built on top, and assures our systems work on X64 and Arm (example: Ampere) systems as well as fully supporting IPv4 and IPv6 for cloud deployment.
More information will be available very shortly.

View File

@@ -1,14 +0,0 @@
---
weight: 117
title: "Dashboard"
description: ""
icon: "article"
date: "2025-08-26T14:43:09-06:00"
lastmod: "2025-08-26T14:43:09-06:00"
draft: false
toc: true
---
Federated Dashboard is a simple launcher for users. It shows the applications available, a link to helpful documentation, and a note about user management. There are significant improvements planned for Dashboard in the coming months as it transitions to Federated [Computer](computer.md).
![Federated Dashboard](assets/images/dashboard.png)

View File

@@ -1,26 +0,0 @@
---
weight: 111
title: "Provisioner"
description: ""
icon: "article"
date: "2025-08-25T12:35:51-06:00"
lastmod: "2025-08-25T12:35:51-06:00"
draft: false
toc: true
---
The "Provisioner" is responsible for setting up, updating/upgrading, and tearing down Cores. It does this in an entirely stateless way communicating with either the aacount management and billing system or the management system. Naturally, there are command-line utilities and an API available to accomplish all functions.
### Order
When and order comes through the account management and billing system, a manifest is created asking for a Core to be create with the required SaaS titles. This *manifest* is sent to the Provisioner which then requests a virtual machine (or machines, if the manifest includes load balancing or other extended Core services), then begins to build the Core software from the manifest. You can read more about the minimal build at [Core Mini](core-mini.md).
One of the key systems enabled for each Core is regular backup to a system of your choice. The credentials for the system are help by Provisioner but can be a local storage service, Backblaze (what we use at https://federated.computer), or some other backup service.
### Update
Provisioner can also modify Cores to add/subtract SaaS software from a Core depending on follow-on orders/cancellations from customers. It can also take instructions from the [update/upgrade system](../management/update-and-upgrade.md) to push out updates to existing software on a Core whether that is system software or SaaS software or other components.
### Tear Down
When it comes time to tear down a Core, Provisioner firsts backs up the Core to the system-defined backup service and then deletes the Core. After a set number of days a follow up command can be sent to Provisioner to clear away the backup.

View File

@@ -1,24 +0,0 @@
---
weight: 115
title: "Unified Messaging"
description: ""
icon: "article"
date: "2025-08-25T12:36:03-06:00"
lastmod: "2025-08-25T12:36:03-06:00"
draft: false
toc: true
---
Federated Core includes three systems for messaging.
### Email
There is a full-featured IMAP/SMTP service available for any needed notifications to users.
### Container-to-Container
There is a service for container-to-container communication allowing for complete workflow creation between SaaS applications when the native APIs are not enough.
### Optional: Matrix
If the Matrix service is loaded, you can use it like a message-bus for application notification to users.

View File

@@ -1,14 +0,0 @@
---
weight: 114
title: "Unified Storage"
description: ""
icon: "article"
date: "2025-08-25T12:36:10-06:00"
lastmod: "2025-08-25T12:36:10-06:00"
draft: false
toc: true
---
Every SaaS software deployed to a Federated Core using a single expandable storage service. This is a BTRFS file system on the Core but can be deployed as block storage (if the cloud provides such a service). It can be expanded and contracted based on customer demand/usage
Every SaaS software deployed to a Federated Core using a single expandable storage service. This is a BTRFS file system on the Core but can be deployed as block storage (if the cloud provides such a service). It can be expanded and contracted based on customer demand/usage.

View File

@@ -1,10 +0,0 @@
---
weight: 150
title: "Services"
description: ""
icon: "article"
date: "2025-08-26T14:35:55-06:00"
lastmod: "2025-08-26T14:35:55-06:00"
draft: false
toc: true
---

View File

@@ -1,26 +0,0 @@
---
weight: 152
title: "Customer Service and Support"
description: ""
icon: "article"
date: "2025-08-26T14:47:00-06:00"
lastmod: "2025-08-26T14:47:00-06:00"
draft: false
toc: true
---
Federated Computer can provide end-to-end customer support for your installation of Federated Core Platform. Whether your customers are end-user businesses and team or partners such as managed-service-providers.
In addition to customer support (offered during the timeframes you want), we offer a comprehensive documentation service and community for helping customers with self-service.
### End-user Businesses and Team
Federated Computer can use Freescout (a great Federated Core offering) to provide full customer support via email, SMS, or telephone to your customers. We have lots of experience providing great experiences to customers including 30-day on-boarding sequences, 3 hour response and 12 hour resolution, webinars, and other ways to ensure customer success and low churn for your go-to-market efforts.
### Channel Partners (Managed Service Providers)
We can also support your channel partners. In our experience, channel partners such as managed service providers are great ways to sell software and services but each requires significant support and explanation to best support their own customers. Federated Computer has extensive operation experience providing this service to partners and we can bring our experience, content, processes to your installation of Federated Core Platform.
### Other Operators
It isn't unusual for Federated Core Platform to be sold to other "operators" who don't want their own installation. We have done this for fiber companies, universities, and other large enterprises. Federated Computer can support your own go-to-market plans with support, content, and programs designed to find and close big opportunities such as other operators.

View File

@@ -1,20 +0,0 @@
---
weight: 151
title: "Federated Management"
description: ""
icon: "article"
date: "2025-08-25T12:35:12-06:00"
lastmod: "2025-08-25T12:35:12-06:00"
draft: false
toc: true
---
Federated Computer can work to get your to market in the fastest and most convenient way for your organization.
### Complete Management
We can run your installation of Federated Core Platform for your business. This includes 24/7/365 NOC operations on-top of your cloud installation or included with a Federated Computer cloud installation. In these scenarios, we ensure all software for Federated Core Platform is up and running, we work with your team to design specific product offerings and bundles, and run the updates/upgrades, we fix any Core faults in the system. The entire platform "just runs" and your team focuses on sales and marketing (working in conjunction with the Federated team for understanding use cases, content, blog posts, successful go-to-market).
### Management to Train
We can also, depending on the level of competency of your current team, work to run the Federated Core Platform for you while training your team to take over at a date certain in the future. We have found this to be the most successl approach to training rather that working on the particulars of how to run Federated Core Platform in the abstract.

View File

@@ -52,16 +52,8 @@ Federated Computer has designed and delivered bundles of software and services s
[Federated Omnimedia](software-catalog/federated-omnimedia.md) [Federated Omnimedia](software-catalog/federated-omnimedia.md)
### On-Line Affiliates
Influencers who speak to their audience about software are an important means to discovering best practice#. Federated Computer offers influencer partners tremendous means to earning recurring revenue through affiliate programs designed to resell an operator's or network's Federated Core Platform.
[On-Line Affiliates](partners/on-line-affiliates.md)
## Federated Computer Information ## Federated Computer Information
If there is other information you need to partner with Federated Computer, please reach out to us at info@federated.computer and we will get back to you promptly. If there is other information you need to partner with Federated Computer, please reach out to us at info@federated.computer and we will get back to you promptly.
The team at Federated Computer were the founders at Joyent, a pioneer in cloud computing bring such technologies as node.js, containers-as-a-service, and many other cloud innovations to the market. The team at Federated Computer were the founders at Joyent, a pioneer in cloud computing bring such technologies as node.js, containers-as-a-service, and many other cloud innovations to the market.
[Federated Company Backgrounder](about-federated-computer/federated-company-backgrounder.md)

View File

@@ -11,8 +11,4 @@ toc: true
Federated Computer has all the tools needed to allow a managed service provider to replace proprietary SaaS products such as Google Workplace, Microsoft Office 365, Slack, Salesforce, and many, many others with easy-to-use, high-value, priavate, flexible open source SaaS alternatives. Federated Computer has all the tools needed to allow a managed service provider to replace proprietary SaaS products such as Google Workplace, Microsoft Office 365, Slack, Salesforce, and many, many others with easy-to-use, high-value, priavate, flexible open source SaaS alternatives.
This leaves MORE money on the table for the managed service provider to provide high-value services. This leaves MORE money on the table for the managed service provider to provide high-value services.
### Solutions
Federated solutions include Core Scanner for active monitoring and fix of customer Cores. Our AI tools will allow you to easily build workflows for customers on top of existing open source SaaS. And our authentication services and facilities for adding software to Federated Core Platform allow MSPs to extend offerings while maintaining the security and ease-of-use of unified storage and messaging and authentication. With Federated Core Platform, you can build the comprehensive solution for a customer that includes all of their software, devices, and services in a single pane-of-glass.

View File

@@ -13,6 +13,4 @@ Federated Core Platform is the best way for hosting companies, fiber networks, w
The typical engagement with Federated Computer starts with some scoping sessions so that we can help you think through your product offering, your go-to-market, and how we will enable you to best support customers. The typical engagement with Federated Computer starts with some scoping sessions so that we can help you think through your product offering, your go-to-market, and how we will enable you to best support customers.
At the end of the day, the mission of Federated Computer is to provide you with the right tools, software, services allowing you to open up new monetization avenues within your existing hardware, datacenters, network pipes, sunk costs infrastructures, existing user bases. At the end of the day, the mission of Federated Computer is to provide you with the right tools, software, services allowing you to open up new monetization avenues within your existing hardware, datacenters, network pipes, sunk costs infrastructures, existing user bases.
Learn more about our solution for Fiber Networks:

View File

@@ -14,7 +14,7 @@ Federated Commerce is a bundle designed by Federated Computer for customers want
Federated Commerce delivers: Federated Commerce delivers:
1) "Unbreakable" Wordpress and WooCommerce add-ons; 1) "Unbreakable" Wordpress and WooCommerce add-ons;
2) Eversync: our catalog management software for WooCommerce and Shopify; 2) Additonal tools for WooCommerce;
Federate Commerce has been a very successful offering and shows the power you'll discover combining great open source software, bespoke service, and reliable support into a single bundle. Federate Commerce has been a very successful offering and shows the power you'll discover combining great open source software, bespoke service, and reliable support into a single bundle.

View File

@@ -9,13 +9,15 @@ draft: false
toc: true toc: true
--- ---
Federated offers a wide range of open source SaaS software. Many of these are available automatically for you to provision to your Cores. Others require notice so that we can set up the provision for you. Federated offers a wide range of open source SaaS software. Many of these are available automatically for you to provision to your Cores. *Others require notice so that we can set up the provision for you.*
All software works with Federated Computer's monitor and fix, update and upgrade, unified storage, and authentication technologies (when support and appropriate) for simple user experience. All software works with Federated Computer's monitor and fix, update and upgrade, unified storage, and authentication technologies (when supported by the SaaS application itself and appropriate for the user experience).
Each entry has a link to the code repository for the project and the open source license. Each entry has a link to the code repository for the project and the open source license.
[Please contact us:](info@federated.computer) if you would like us to add a particular open source SaaS application or tool. [Please contact us:](info@federated.computer) if you would like us to add a particular open source SaaS application or tool. While you are always free to add your own software to Federated Core, we are happy to work with you.
Here is a list of great open source SaaS software:
(Legend: **Title** Federated Bundles. ***Title*** Available.) (Legend: **Title** Federated Bundles. ***Title*** Available.)