Federated_Computer/enterprise.federated.computer
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

more tweaks

Browse Source
This commit is contained in:
david
2026-06-02 07:35:28 -06:00
parent 177c787344
commit ef068409e2
37 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
content/docs/coreplatform/_index.md Normal file
View File

@@ -0,0 +1,10 @@
---
weight: 160
title: "Core Platform"
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
---

10
content/docs/coreplatform/account/_index.md Normal file
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
---

23
content/docs/coreplatform/account/account-settings.md Normal file
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.

31
content/docs/coreplatform/account/user-profile.md Normal file
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.

10
content/docs/coreplatform/billing/_index.md Normal file
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
---

41
content/docs/coreplatform/billing/account-balance.md Normal file
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.

37
content/docs/coreplatform/billing/add-ons.md Normal file
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.

33
content/docs/coreplatform/billing/changing-your-plan.md Normal file
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.

30
content/docs/coreplatform/billing/coupons.md Normal file
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.

37
content/docs/coreplatform/billing/invoices-and-payment-history.md Normal file
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

39
content/docs/coreplatform/billing/subscription-and-billing-cycles.md Normal file
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.

36
content/docs/coreplatform/billing/understanding-your-plan.md Normal file
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.

21
content/docs/coreplatform/billing/updating-your-payment-method.md Normal file
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.

10
content/docs/coreplatform/cores/_index.md Normal file
View File

@@ -0,0 +1,10 @@
---
weight: 166
title: "Cores"
description: "Provision and manage custom open source software bundles running on your own virtual machines."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---

40
content/docs/coreplatform/cores/changing-a-core-domain.md Normal file
View File

@@ -0,0 +1,40 @@
---
weight: 169
title: "Changing a Core's Domain"
description: "How to change the domain assigned to a Core after provisioning."
icon: "article"
date: "2025-05-28T00:00:00-00:00"
lastmod: "2025-05-28T00:00:00-00:00"
draft: false
toc: true
---
When a Core is provisioned, it is assigned a domain based on the subdomain you specified in `core-create` and one of the three domains attached to your account — for example, `mycore.yourdomain.com`.
If you need to change the domain assigned to a Core after provisioning, you can do so using the Provisioner API.
## Before You Begin
Glue records for the new domain must be configured correctly before running this command. The domain change will not work if DNS is not set up in advance.
## Changing the Domain
```bash
curl -k -X POST https://178.156.242.210:4445/core-changedomain \
-H "Content-Type: application/json" \
-d '{
"account_id": "your-account-id",
"ip": "<ip address of the Core>",
"domain": "<new domain>",
"organization": "<organization name>"
}'
```
| Field | Required | Description |
|-------|----------|-------------|
| `account_id` | Yes | Your Federated Enterprise account ID. |
| `ip` | Yes | The IP address of the Core you are updating. |
| `domain` | Yes | The new domain to assign to this Core. Glue records must already be configured. |
| `organization` | Yes | Your company name. This is used to identify the organization this Core belongs to. |
A successful request returns an empty JSON object (`{}`).

97
content/docs/coreplatform/cores/core-sizing.md Normal file
View File

@@ -0,0 +1,97 @@
---
weight: 175
title: "Core Sizing"
description: "How to determine what size machine or VM you need..."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-27T00:00:00-00:00"
draft: false
toc: true
---
Core is made up of many different docker containers working in concert to build Core. Here is the information you need to figure out what size machine or VM you need for your Core.
### Core Mini(mum)
Every Core gets the following installed automatically to provide services for other packages:
1. PowerDNS
1. PowerDNSmysql
1. PowerDNSadmin
1. Traefik
1. Postgresql
1. LDAP
1. Authelia
1. Mail
1. Dashboard
1. Panel
1. Roundcube
### Core Docker Containers
In order to size your Core provisions on various clouds, machines, servers, here are the memory requirements for each docker container or collection of docker containers required to deliver an application:
|*Container* |*RAM MiB*|*Depends On* |
|-----------------------------|-------|--------------|
|Authelia |41.34 |Stand Alone |
|Autodiscover |5.812 |Mail |
|Baserow |1245 |Postgresql, Mail |
|Bookstack |123 |pdnsmysql |
|Calcom |751.6 |postgresql |
|Castopod |28.9 |pdnsql |
|Clickhouseserver |861.2 |Stand Alone |
|Collabora |97.45 |Nextcloud |
|Coturn |8.797 |Nextcloud Talk|
|Dashboard |17.48 |Stand alone |
|Discourse |2369 |redis postgresql |
|Element |4.914 |Matrix |
|EspoCRM |41.11 |LDAP, pdnsmysql |
|Freescout |163.2 |postgresql |
|Gitea |649.4 |postgresql |
|Gitearunner |126.4 |Gitea |
|Headplane |89.63 |Authelia, Headscale |
|Headscale |29.83 |Headscale |
|IMAPsync |3.129 |Imapsync |
|IMAPsync-proxy |0.55 |Imapsync |
|Jitsi-Jibri-1 |73.87 |Jitsi |
|Jitsi-Jicofo-1 |100.3 |Jitsi |
|Jitsi-JVB-1 |294.4 |Jitsi |
|Jitsi-Prosody-1 |38.78 |Jitsi |
|Jitsi-Web-1 |13.78 |Jitsi |
|Jitsiopenid |17.3 |Jitsi |
|Kimai |71.62 |pdnsmysql |
|LDAP |112.6 |LDAP |
|Listmonk |18.95 |postgresql, mail |
|Mail |1240 |LDAP |
|Matrix |228.8 |postgresql |
|Nextcloud |444.4 |postgresql |
|Nextcloud-Whiteboard-Server-1|1.938 |Nextcloud |
|NextcloudTalk |94.49 |Nextcloud |
|Panel |5.875 |Stand Alone |
|PowerDNS (pdns) |40.59 |pdnsmysql |
|pdnsadmin |104.6 |pdns, pdnsmysql |
|pdnsmysql |232.8 |pdnsmysql |
|Plane-admin-1 |6.047 |Plane |
|Plane-api-1 |152.5 |Plane |
|Plane-beat-worker-1 |32.02 |Plane |
|Plane-live-1 |8.98 |postgresql |
|Plane-plane-minio-1 |272.3 |Plane |
|Plane-plane-mq-1 |65.53 |Plane |
|Plane-plane-redis-1 |5.176 |Plane |
|plane-space-1 |9.836 |Plane |
|Plane-web-1 |3.023 |Plane |
|Plane-worker-1 |146.9 |Plane |
|Plausible |165.4 |clickhouseserver |
|postgresql |1021 |postgresql |
|postgresqlecom |34.49 |postgresqlecom|
|redis |5.281 |redis |
|Roundcube |11.04 |pdnsmysql, mail |
|Superpanel |88.29 |Superpanel |
|Tailscale |77.36 |Authelia, Headscale, Headplane |
|Traefik |109.6 |Traefik |
|Vaultwarden |135.1 |postgresql |
|Wordpress |118.1 |pdnsmysql |
#### Note:
These memory numbers are "at rest". You will likely need more depending on usage and load. Disk storage numbers are NOT given because they vary widely. CPU numbers are also not given since most clouds have a "regular" relationship between memory and CPU cores. There are services such as "pdnsmysql", for example, that are used by many different applications. You only need to account for one use.

51
content/docs/coreplatform/cores/deleting-a-core.md Normal file
View File

@@ -0,0 +1,51 @@
---
weight: 170
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.
There are two ways to delete a Core.
> **Warning:** Deleting a Core is **permanent and irreversible**. The Core will be removed from your account and CoreServer will stop functioning on that VM. Your underlying VM and its data remain yours, but you will need to re-provision if you want to restore it.
## Option 1: Dashboard
1. Go to **Cores** in the dashboard.
2. Locate the Core by its IP address.
3. Click **Delete** on that Core.
4. Confirm the deletion. The Core is immediately removed from your account.
## Option 2: API
You can also delete a Core programmatically using the Provisioner API.
```bash
curl -k -X POST https://178.156.242.210:4445/core-delete \
-H "Content-Type: application/json" \
-d '{
"account_id": "your-account-id",
"ip": "<ip address of the Core>"
}'
```
| Field | Required | Description |
|-------|----------|-------------|
| `account_id` | Yes | Your Federated Enterprise account ID. |
| `ip` | Yes | The IP address of the Core to delete. |
A successful request returns an empty JSON object (`{}`).
## 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.

82
content/docs/coreplatform/cores/provisioning-a-core.md Normal file
View File

@@ -0,0 +1,82 @@
---
weight: 168
title: "Provisioning a Core"
description: "How to download CoreServer, install it on your VM, and connect it to the platform."
icon: "article"
date: "2025-05-27T00:00:00-00:00"
lastmod: "2025-05-28T00:00:00-00:00"
draft: false
toc: true
---
On Federated Enterprise, a **Core** is a bundle of open source business software running on **CoreServer** — our custom operating system — installed on a virtual machine you provide. You bring the compute; we supply the OS and software, and connect it to the platform.
## Before You Begin
- You need an active Enterprise account.
- You need a virtual machine provisioned at your cloud provider. CoreServer supports x86 64-bit VMs.
- You need SSH access to your VM during setup.
## Step 1: Download the CoreServer Image
Download the image format that matches your cloud provider's import requirements:
| Format | Download | Use With |
|--------|----------|----------|
| Compressed raw (`.img.xz`) | [coreserver-enterprise-x86-26-05-12.img.xz](https://nginx.core-x86builder.federatedcomputer.cloud/coreserver-enterprise-x86-26-05-12.img.xz) | DigitalOcean, Hetzner |
| QCOW2 (`.qcow2`) | [coreserver-enterprise-x86-26-05-12.qcow2](https://nginx.core-x86builder.federatedcomputer.cloud/coreserver-enterprise-x86-26-05-12.qcow2) | KVM, QEMU, Proxmox, Contabo, Cloudstack |
| Raw image (`.img`) | [coreserver-enterprise-x86-26-05-12.img](https://nginx.core-x86builder.federatedcomputer.cloud/coreserver-enterprise-x86-26-05-12.img) | AWS EC2, general use |
| Compressed tar (`.tar.gz`) | [coreserver-enterprise-x86-26-05-12.tar.gz](https://nginx.core-x86builder.federatedcomputer.cloud/coreserver-enterprise-x86-26-05-12.tar.gz) | Google Cloud |
| VMDK (`.vmdk`) | [coreserver-enterprise-x86-26-05-12.vmdk](https://nginx.core-x86builder.federatedcomputer.cloud/coreserver-enterprise-x86-26-05-12.vmdk) | VMware (ESXi, vSphere), AWS EC2 |
Import the image into your cloud provider and create a VM from it. Refer to your provider's documentation for the import process.
## Step 2: Add Your SSH Public Key
Your account's SSH public key authorizes the Provisioner to connect to and configure your CoreServer VM.
1. In the dashboard, navigate to **Cores**.
2. Copy your account's **SSH public key**.
3. Add the key to the `authorized_keys` file on your VM (typically `~/.ssh/authorized_keys` for the root user).
## Step 3: Run core-create
Once the SSH key is in place, run the following command to provision your Core. Your `account_id` is pre-filled in the template provided to you at signup.
```bash
curl -k -X POST https://178.156.242.210:4445/core-create \
-H "Content-Type: application/json" \
-d '{
"account_id": "your-account-id",
"ip": "<ip address of your VM>",
"subdomain": "<your subdomain>",
"apps": "<app string>",
"backups": "yes | no",
"monitoring": "yes | no",
"email": "<optional: email to send welcome message to>"
}'
```
| Field | Required | Description |
|-------|----------|-------------|
| `account_id` | Yes | Your Federated Enterprise account ID. |
| `ip` | Yes | The IP address of your CoreServer VM. |
| `subdomain` | Yes | A name of your choosing for this Core (e.g. `team`, `prod`, `nyc1`). |
| `apps` | Yes | Comma-separated list of apps to install (e.g. `"nextcloud,gitea,vaultwarden"`). Available apps: `jitsi`, `element`, `nextcloud`, `baserow`, `freescout`, `espocrm`, `castopod`, `wordpress`, `kimai`, `plane`, `headscale`, `vaultwarden`, `calcom`, `listmonk`, `plausible`, `discourse`, `gitea`, `bookstack`. |
| `backups` | Yes | Enable automated backups (`yes` or `no`). |
| `monitoring` | Yes | Enable monitoring (`yes` or `no`). |
| `email` | No | Who to send the welcome email to. If omitted, the email goes to the account holder. |
## What Happens Next
The Provisioner configures your CoreServer VM and notifies the platform when complete. The Core will automatically appear in the **Cores** section of your dashboard as **Active** — no manual refresh needed.
If you specified a recipient email, they'll receive a welcome email confirming the Core is live.
## 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.

32
content/docs/coreplatform/cores/what-are-cores.md Normal file
View File

@@ -0,0 +1,32 @@
---
weight: 167
title: "What Are Cores"
description: "An introduction to Cores"
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 bundle of open source business software — pre-configured to work together — running on **CoreServer**, Federated's custom operating system. CoreServer is installed on a virtual machine you own and provision at your cloud provider. Federated manages the software layer; you own the underlying infrastructure.
Each Core is registered to your account with its VM's IP address. 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 removed from your account. Your underlying VM remains yours, but CoreServer will no longer function on it.
## 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.

10
content/docs/coreplatform/domains/_index.md Normal file
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
---

26
content/docs/coreplatform/domains/buying-a-custom-domain.md Normal file
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.

28
content/docs/coreplatform/domains/domain-renewal.md Normal file
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.

38
content/docs/coreplatform/domains/federated-vs-custom-domains.md Normal file
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 | Yes |

16
content/docs/coreplatform/domains/why-3-domains-are-required.md Normal file
View File

@@ -0,0 +1,16 @@
---
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.
Each domain on your account needs its own SSL certificate to serve traffic securely. The platform provisions these certificates automatically, and three domains ensures there is enough capacity to cover all the certificates your environment needs to function correctly.
> **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.

10
content/docs/coreplatform/getting-started/_index.md Normal file
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
---

33
content/docs/coreplatform/getting-started/account-cancellation.md Normal file
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 and access to the platform is revoked. Your VMs and cloud infrastructure remain yours — however, CoreServer requires an active account to function, so the software running on your Cores will stop working.
> **Important:** Cancellation is **not reversible through self-service**. If you cancel and later want to use Federated Enterprise again, please [contact us](https://freescout.federated.computer/help/3593186542).
## 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.

43
content/docs/coreplatform/getting-started/completing-checkout.md Normal file
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.

26
content/docs/coreplatform/getting-started/overview.md Normal file
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 software platform that runs on virtual machines you provision at your cloud provider of choice. You bring the compute infrastructure; Federated supplies **CoreServer** — a custom operating system — and **Cores** — bundles of open source business software that run on top of it.
A **Core** is a bundle of open source apps (such as Nextcloud, Gitea, and Vaultwarden) built to work together out of the box, running on **CoreServer** on your own VM. Cores are tied to your account and backed by a set of **domains** that route traffic to your environment. Each Core can also be equipped with optional add-on services like monitoring and backups.
## What You Get
- CoreServer and your chosen Core software bundle installed on your own VMs, managed through the Federated platform
- At least three domains — either free Federated-managed domains, or custom domains you purchase and register through the platform
- An SSH key pair automatically generated at checkout, used by the Provisioner to configure your Cores
- 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.

35
content/docs/coreplatform/getting-started/signing-up.md Normal file
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.

10
content/docs/coreplatform/reference/_index.md Normal file
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
---

63
content/docs/coreplatform/reference/tier-comparison.md Normal file
View File

@@ -0,0 +1,63 @@
---
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**
The most cost-effective tier depends on how many Cores you run:
- **1–4 Cores:** Pay-As-You-Go is cheapest — no membership fee offsets the higher per-Core rate at low volume.
- **5–39 Cores:** Consultant is cheapest — the $200 membership fee is recovered through lower per-Core pricing compared to Pay-As-You-Go.
- **40+ Cores:** Enterprise is cheapest — the crossover point where the $10/Core rate makes the $400 membership fee worthwhile.
These breakpoints assume no add-ons. Add-on pricing also varies by tier, so accounts with heavy add-on usage may find the breakeven shifts in favor of a higher tier sooner.

10
content/docs/coreplatform/team/_index.md Normal file
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
---

24
content/docs/coreplatform/team/inviting-a-member.md Normal file
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.

22
content/docs/coreplatform/team/removing-a-user.md Normal file
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.

39
content/docs/coreplatform/team/user-roles.md Normal file
View File

@@ -0,0 +1,39 @@
---
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 |
| View billing | 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 |
| Transfer ownership | Yes | No | 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. Ownership can be transferred by changing another user's role to Owner from the Team page — this immediately makes them the Owner and changes the previous Owner to an Admin.
**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.