Oktopus Controller Docs
Contact
  • Welcome
  • Getting Started
    • About
    • Architecture
    • Requirements
      • Network
    • Installation
      • Standalone
      • High Availability
      • FAQ
    • Community Edition
    • Enterprise Edition
      • Scripts
    • Integrations
  • Device Configuration
    • Simulators
      • (USP) Agent Simulator
    • Open Source Platforms
      • PrplOS
      • OpenWRT
  • USP (TR-369)
    • Introduction
    • Architecture
    • MTPs
      • MQTT
  • CWMP (TR-069)
    • Introduction
    • Architecture
  • Reference
    • Bibliography
Powered by GitBook
On this page
  • Requirements
  • Installation

Was this helpful?

Edit on GitHub
  1. Getting Started
  2. Installation

Standalone

PreviousInstallationNextHigh Availability

Last updated 6 days ago

Was this helpful?

The standalone mode installs all the software components into one server. It's pretty straighforward, but becomes a single point of failure. Anyway, it should be enough for small-medium sized workloads.

Requirements

  • docker

  • docker compose

  • wget

  • unzip

Have the services ports available internally or public accordingly to Oktopus . Keep in mind it's always advisable to have a firewall in front of your server and have controll of the traffic policies.

This tutorial was tested against OS Ubuntu 24.04, but it must work for other linux systems too.

Installation

First of all, let's download Oktopus codebase:

wget https://github.com/OktopUSP/oktopus/archive/refs/heads/main.zip && unzip main

Then go into the deploy/compose folder:

cd oktopus-main/deploy/compose

Edit ".env.controller" file last line with a secret value, this key will be used to sign JWTs used in Oktopus users authentication process.

nano .env.controller
.env.controller
MONGO_URI=mongodb://mongo_usp:27017
NATS_URL=nats://oktopususer:oktopuspw@msg_broker:4222
NATS_ENABLE_TLS="true"
CLIENT_CRT=/tmp/nats/config/cert.pem
CLIENT_KEY=/tmp/nats/config/key.pem
SERVER_CA=/tmp/nats/config/rootCA.pem
SECRET_API_KEY=<super-secret-key>

Once you've done the steps above, still inside "oktopus-main/deploy/compose" folder, run:

COMPOSE_PROFILES=nats,controller,cwmp,mqtt,stomp,ws,adapter,frontend,portainer docker compose up -d

Congratulations! Oktopus Web interface will be available at port 80.

network requirement section