Quick Start
From fresh install to managing your first server in 10 minutes
This guide takes you from a fresh oCore installation to having your first server connected and monitored. You will create an account, set up an organization, and add a Linux server via SSH.
Setup flow overview
Create your account
Sign up
Navigate to your oCore instance (e.g., http://localhost:3000) and click Sign Up. Enter your name, email address, and a password.
Password requirements:
- Minimum 8 characters
- At least 1 letter
- At least 1 number
If your administrator has enabled OAuth, you can also sign up with GitHub or Google.
After signing up, verify your email address if email verification is enabled. Check your inbox for a verification link from oCore.
Create an organization
After signing in, you will be prompted to create your first organization. An organization in oCore is the top-level container for all your resources -- servers, projects, instances, and team members.
Enter a name for your organization (e.g., "My Company") and an optional slug (e.g., my-company). The slug is auto-generated from the name if left blank.
- Slug must be 3-50 characters
- Only lowercase letters, numbers, and hyphens
- Must be unique across your oCore instance
You are automatically assigned the Owner role, giving you full control over the organization. You can invite team members later.
Organization Settings
Manage your organization, invite members, and configure roles.
Add your first server
A server in oCore represents a Linux machine that you want to manage. oCore connects to servers via SSH to deploy Odoo instances, collect metrics, run backups, and perform maintenance.
Requirements for the target server
Before adding a server, ensure it meets these requirements:
| Requirement | Details |
|---|---|
| OS | Ubuntu 20.04+, Debian 11+, CentOS 8+, or any modern Linux |
| SSH access | Root or sudo-capable user with SSH key or password auth |
| Docker | Docker Engine 24.0+ installed and running |
| Network | Accessible from the oCore server on the SSH port (default: 22) |
| Ports | Ports available for Odoo instances (base 10000+, configurable) |
Navigate to servers
In the oCore dashboard, navigate to Servers in the sidebar, then click Add Server.
Servers Dashboard
View and manage all connected servers.
Enter server details
Fill in the server connection details:
- Name: A friendly name for this server (e.g., "Production Server 1")
- Hostname: The IP address or domain name of the server (e.g.,
192.168.1.100orserver.example.com) - Port: SSH port (default:
22) - Username: SSH user (e.g.,
rootor a sudo-capable user) - Authentication: Choose SSH key (recommended) or password
SSH key authentication is strongly recommended for production servers. Password authentication should only be used for initial setup or testing.
Verify the connection
After saving, oCore tests the SSH connection to your server. You will see a status indicator:
- Connected -- SSH connection successful, server is reachable
- Failed -- Connection failed (check credentials, firewall, SSH configuration)
If the connection fails, verify:
- The server is reachable from the oCore host (
ping <hostname>) - SSH is running on the specified port (
ssh -p <port> <user>@<hostname>) - The credentials are correct
- No firewall is blocking the connection
Agent installation
Once connected, oCore installs a lightweight monitoring agent on the server. The agent collects:
- System metrics: CPU usage, memory usage, disk usage, load average
- Docker metrics: Container count, container states, resource usage per container
- Network metrics: Bandwidth usage, connection counts
The agent runs as a systemd service and reports metrics back to oCore at regular intervals. It also enables oCore to manage Docker containers on the server for Odoo instance deployments.
The agent installation is automatic and requires no manual intervention. oCore handles the setup via SSH.
What's next
Your server is now connected and monitored. From here, you can:
Deploy Your First Instance
Create a project, set up an environment, and deploy your first Odoo instance.
Understand Concepts
Learn about oCore's domain model: servers, instances, projects, environments, and deployments.
Self-Hosting Guide
Configure reverse proxy, SSL/TLS, backups, and monitoring for production.