Updated enterprise documentation
This commit is contained in:
41
content/docs/enterprise/cores/changing-a-core-domain.md
Normal file
41
content/docs/enterprise/cores/changing-a-core-domain.md
Normal file
@@ -0,0 +1,41 @@
|
||||
---
|
||||
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 \
|
||||
-u "username:password" \
|
||||
-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 (`{}`).
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
weight: 169
|
||||
weight: 170
|
||||
title: "Deleting a Core"
|
||||
description: "How to permanently remove a Core from your account."
|
||||
icon: "article"
|
||||
@@ -11,14 +11,37 @@ toc: true
|
||||
|
||||
Deleting a Core permanently removes it from your account. Only **Owners** and **Admins** can delete Cores.
|
||||
|
||||
## How to Delete a Core
|
||||
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 you want to remove.
|
||||
3. Click the delete action for that Core.
|
||||
4. Confirm the deletion. The Core is immediately decommissioned.
|
||||
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.
|
||||
|
||||
> **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.
|
||||
## 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 \
|
||||
-u "username:password" \
|
||||
-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
|
||||
|
||||
|
||||
@@ -1,23 +1,77 @@
|
||||
---
|
||||
weight: 168
|
||||
title: "Provisioning a Core"
|
||||
description: "How to provision a new Core from the dashboard."
|
||||
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-27T00:00:00-00:00"
|
||||
lastmod: "2025-05-28T00: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.
|
||||
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.
|
||||
|
||||
## How to Provision a Core
|
||||
## Before You Begin
|
||||
|
||||
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.
|
||||
- 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 |
|
||||
| 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 |
|
||||
| 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
|
||||
|
||||
@@ -26,7 +80,3 @@ Cores are charged on a monthly basis as part of your regular billing cycle. When
|
||||
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.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
weight: 167
|
||||
title: "What Are Cores"
|
||||
description: "An introduction to Cores — dedicated compute units tied to your account."
|
||||
description: "An introduction to Cores"
|
||||
icon: "article"
|
||||
date: "2025-05-27T00:00:00-00:00"
|
||||
lastmod: "2025-05-27T00:00:00-00:00"
|
||||
@@ -9,9 +9,9 @@ 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.
|
||||
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 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.
|
||||
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
|
||||
|
||||
@@ -21,7 +21,7 @@ A Core moves through several states during its lifecycle:
|
||||
- **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.
|
||||
- **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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user