OneCX Local Environment - Overview
onecx-local-env is the local development environment for OneCX. It is based on Docker/Docker Compose, and enables developers to quickly run local instances of the OneCX Shell, selected OneCX products and their dependencies for development and testing purposes.
onecx-local-env can either be used as a standalone tool, or integrated into custom development environments via Git submodules. Custom development environments can interact with onecx-local-env via provided lifecycle-scripts and extend its functionality by wrapping the provided Docker Compose and script files with custom implementations.
Start here
-
Setup: Details on how to set up and install
-
Getting Started: The quickest way to get started
Use Scripts for Management
Since OneCX runs in a Docker Compose environment, most settings can be managed directly through Docker and Docker Compose. However, for a more convenient approach and taking into account specific OneCX features, various shell scripts are available. Each script has the -h flag to explain how to use.
Start the local environment including import of inital neccessary data |
|
Stop the local environment |
|
Import data |
|
Integrate local running microfrontends directly into OneCX |
|
List local images with state and version |
|
Update local images |
Utilities
In addition to the OneCX Core products, further services will be launched.
The IAM service used by OneCX |
|
Postgres |
Storing the data. Each OneCX backend service has its own separate database. Access can be gained using pgAdmin. |
Manage the Postgres databases. |
|
Proxy service for routing requests between services within the Docker network and from/to outside. |