Installation
This page describes how to install COD with Self Hosted, from the server to the final check. With Shared Hosted and Private Hosted, extocode sets up the instance.
As of: November 2026, COD 3.8.6
Documentation
Requirements
| Item | Requirement |
|---|---|
| Operating system | Ubuntu Server 22.04 LTS, 24.04 LTS or 26.04 LTS, freshly installed |
| Architecture | amd64 |
| Privileges | root or sudo |
| Package repository | Credentials for apt.extoco.de. You receive the repository credentials as part of the project. |
| Internet during installation | extocode's package repository, the Ubuntu archives, the Node.js repository (NodeSource), and on 22.04 and 24.04 also the PostgreSQL repository. Directly or through an HTTP proxy |
| Databases | MariaDB and PostgreSQL 18 or later, on the COD server or on your own database servers |
| Time | NTP on all servers |
| Hardware | Your partner gives you guide values for your size. |
COD ships as Debian packages and runs as systemd services. There are no containers. All details are under Requirements. How to spread COD across one or more hosts is described under Deployment shapes.
Procedure at a glance
- Provide the servers
- Run the setup script on every host
- Complete the setup wizard in the browser
- Set up HTTPS
- Enable modules for the tenant
- Roll out modules
- Set up TACACS+ and Hypervisor manually
- Check the installation
Step 1: Provide the servers
- Install Ubuntu Server freshly, in one of the supported versions.
- Set up NTP. This applies to the COD server, to database servers and to module servers.
- Decide on the name under which users and modules reach COD. A fixed DNS entry and a fixed address are recommended. The name matters for the certificate and for sign-in.
- For split deployment shapes, provide all hosts at the same time.
Note: If the address under which COD is reachable changes later, Ansible rollouts fail until you roll out again. See Troubleshooting.
Step 2: Setup script on every host
The setup script adds extocode's package repository with its signing key and installs Node.js 24. It then installs the selected packages and creates the databases and database users. It runs for a few minutes.
You receive the setup script command together with the repository credentials. For the shape "Everything on one server", the script installs the complete package cod-all and the database servers on the same host. Module servers and your own database servers need further settings. Customers and partners receive these as part of the project as well.
Hosts without internet access
| Situation | Approach |
|---|---|
| Internet only through a proxy | The setup script fetches the packages through an HTTP proxy |
| No internet | Offline bundle as a local package source, on request. Ask your partner. Technical questions to extocode go through the helpdesk form. |
Step 3: Setup wizard in the browser
The wizard runs on the COD server. You open it in the browser with a one-time token. It takes care of these steps:
- It checks the connections to the databases, the key service and the cache.
- It generates the keys of the installation.
- It creates the first superadmin.
- It asks for the e-mail address of the manager account.
- If you wish, it sets up HTTPS with a certificate authority of the installation.
- It shows the QR code for two-factor sign-in (TOTP) of the manager account and a key.
Important: The QR code and the key appear exactly once. Store both right away. The e-mail address of the manager account cannot be changed later.
Important: Back up the configuration with the keys of the installation right after the wizard. Without these keys COD does not start, and encrypted credentials are lost. See Backing up COD itself.
What follows after the wizard is described under Initial setup.
Step 4: Set up HTTPS
HTTPS is mandatory. Without HTTPS, sign-in only works locally on the COD server.
| Approach | Where you set it up |
|---|---|
| Certificate authority of the installation | in the setup wizard |
| Your own certificate | in COD under "Backend config", card "TLS" |
| Reverse proxy in front of COD | on the proxy, plus "trust proxy" in COD. The proxy must pass WebSocket and server-sent events |
Details are under Initial setup: HTTPS.
Step 5: Enable modules for the tenant
- Sign in with the manager account. Only this account enables modules.
- Open "Admin Area > Tenant > Modules".
- Select the licensed modules and save.
- Sign out and sign in again. Only then does COD show the modules.
Step 6: Roll out modules
The rollout wizard sets up the Ansible, Backup, NAC and Passkeepr modules per location. You find it under "Admin Area > Module Rollout".
- "Module": select the module.
- "Location": select the location.
- "Install": install the module on the target host.
- "Connect": connect COD to the module, using the setup address and a handshake token.
- "Configure": set the module's settings.
- "Apply": apply the settings.
Note: The connection between COD and module servers belongs in a trusted network.
Customers and partners receive the list of connections and firewall rules as part of the project.
Step 7: TACACS+ and Hypervisor manually
The rollout wizard does not cover these two modules.
| Module | What you do |
|---|---|
| TACACS+ | Set up the service on its host. Then enter the address of the management interface under "Location > Module URLs". The address ends in /api/v1 |
| Hypervisor | Set up the service on the COD server. It always runs there |
The field for the TACACS+ address only appears if NAC, Backup or Passkeepr is also enabled for the tenant. Customers and partners receive the address of the management interface with the list of connections and firewall rules as part of the project.
See TACACS+ and Hypervisor.
Step 8: Check the installation
Run these commands on the COD server:
systemctl --failed
systemctl list-units 'cod-*'
curl -sk https://localhost/api/health
| Command | Expected result |
|---|---|
systemctl --failed | no failed services |
systemctl list-units 'cod-*' | all installed COD services are running |
curl -sk https://localhost/api/health | {"status":"ok"} |
You can also add the health check to your own monitoring. If a result differs, see Diagnosis.
Handout
The procedure is also available as the handout “Installing and setting up COD”. You find the handout as a PDF on the Downloads page.
Further reading
- Requirements
- Deployment shapes
- Initial setup
- Updates
- Troubleshooting
- COD architecture
- FAQ: installation and updates