Skip to content

Sekoia Self-Hosted 0.1.0

This is the documentation for Sekoia Self-Hosted 0.1.0. It describes the configuration keys, CLI commands, and behavior of this release only.

Pre-release version

Sekoia Self-Hosted 0.1.0 is currently in pre-release and may contain bugs. Report every bug to Sekoia in a separate report so that each issue can be tracked independently.

For what Sekoia Self-Hosted is and who it is for, see the section introduction. To check whether a more recent release is available, see Documentation versions.

Quick start path

If you are new to Sekoia Self-Hosted, follow this sequence:

  1. Read the Reference architecture to understand the platform topology.
  2. Validate your infrastructure against the Technical requirements and Network requirements.
  3. Prepare your config.yml using the Deployment configuration reference.
  4. Follow the Deploy the platform guide.
  5. Create your first user with the Set up the first administrator account guide.
  6. Get familiar with the self-hosted-controller (SHC) interface for day-to-day interactive operations.
  7. Set up continuous monitoring using the Monitor your platform guide.
  8. Run platform diagnostics to validate service health.

Documentation map

Architecture

Document What you will find
Reference architecture Platform components, infrastructure topology, node roles, high availability design, and data workflow.

Deployment

Document What you will find
Technical requirements Hardware, OS, storage, network, and operational requirements before you begin.
Network requirements Full table of required network flows, ports, and protocols.
The deployment process High-level overview of the deployment engine, execution modes, and lifecycle operations.
Deploy the platform Step-by-step installation: download, verification, initialization, and post-deployment validation.
Configure the deployment Copyable config.yml starter configuration and explanations for every required field.

Operations

Document What you will find
Set up the first administrator account How to provision the first administrator account and configure initial access.
Use the self-hosted-controller (SHC) interface The interactive self-hosted-controller (SHC) interface: command input, node, cluster and storage views, and diagnostics.

Monitoring and troubleshooting

Document What you will find
Monitor your platform Observability stack overview, daily monitoring workflows, and self-hosted-controller (SHC) diagnostic command reference.
Run platform diagnostics How to run targeted Prometheus health checks for platform services.
Debug your deployment Full self-hosted-controller (SHC) debug command reference with remediation guidance and log collection for support.

Release information

Document What you will find
Release notes v0.1.0 MVP feature scope, functional limitations, known issues, and support lifecycle.