Skip to main content

Developer Environment Overview

In development and testing environments, you can deploy the One37 Platform and support applications all on the same host using Docker Compose.

This is the fastest way to get started with the platform.

System Prerequisites​

  • Docker Community Edition with Docker Compose configured
  • PostgreSQL 13.x or higher docker image
  • Redis 6.x or higher docker image
  • One37 Identity Platform docker images

Optional​

  • TLS Certificate (optional)
  • Domain Name (optional)
  • NGINX Proxy Manager (optional)
  • Database Management Tool (optional)
  • Redis Management Tool (optional)

Building a Development Environment​

If you don't already have a Linux workstation or virtual machine with the required software installed, you can follow the guides below to configure everything you need. Return here when you are done.

Starting the services​

As mentioned in the System Prerequisites section the One37 Platform needs a PostgreSQL database and Redis compatible cache to run.

  • PostgreSQL database:
    This database is used to store the various platform components' data.

  • Redis cache:
    The cache is used to store session data and other transient information that needs to be shared between components.

Normally this would involve individual installation for each component, but Docker allows us to easily combine several components into a single Docker Compose definition file.

This compose file can be placed in the Linux user home folder or a specific working folder; e.g ~/one37id. In it, we will define all the services and their dependencies.

[!tip] You could split the services into separate files and use the docker-compose -f option to specify the file to use. This is useful when you want to start only a subset of the services.

Run the containers​

docker compose up -d

[!tip] You can watch the logs using by omitting the -d flag. Run this in a separate terminal window or tmux session. The PostgreSQL database will take a bit longer to initialize the first time it is run.

Configuring the One37 Platform Applications​

Full instructions on how to setup the rest of the One37 Platform components can be found in the One37 Platform Installation Guide.

X

Graph View