AMPS
  • What is AMPS?
  • Getting Started
    • Installation
      • Docker
      • Kubernetes
        • Local
        • Openshift
        • AWS
    • Setup
  • Fundamentals
    • Admin
      • Monitoring
        • Message Events
        • Sessions
        • Service Monitoring
        • System Logs
        • Audit Log
        • Consumers
      • Onboarding
        • Groups
        • Users
      • Message Configuration
        • Topics
        • Actions
        • Services
        • Scripts
        • Templates
        • Routing Rules
        • API Endpoints
        • Metadata Fields
        • Keys
        • Jobs
      • Data Configuration
        • Providers
        • Environments
        • Packages
      • Tools
      • System Configuration
    • End User
      • Mailboxes
      • Universe File Agent
      • Auth Tokens
    • Python
  • Use Cases
    • For Engineers
      • GitHub Integration
    • For Support
      • Intercom Integration
  • Guides
    • Creating your first project
    • Creating your first task
    • Advanced permissions
Powered by GitBook
On this page
  1. Getting Started
  2. Installation

Docker

PreviousInstallationNextKubernetes

Last updated 2 years ago

You can start a cluster of AMPS with all of its dependencies by which contains the AMPS Docker Compose file and nginx.conf file for the MinIO Nginx load balancer. You can start the AMPS cluster by unzipping the downloaded folder and running "docker compose up" from within the directory. By default, the compose file creates volumes for AMPS and its dependencies in the ./volumes directory. You can change these volume directories as you see fit. For the purpose of S3 archiving, the compose file also starts a four-container MinIO cluster that is load balanced via an Nginx container labeled S3. If you don't want to use S3 archiving, feel free to comment out all of the MinIO services and the S3 Nginx service. You can configure AMPS by setting the following environment variables within the compose file.

Name
Description

AMPS_MONGO_ADDR

The address for the Mongo Database to use.

AMPS_NATS_HOST

The hostname for the NATS instance to use.

AMPS_NATS_PORT

The port for the NATS instance to use.

TZ

The full name of the timezone to use.

AMPS_ADMIN_HOST

The hostname at which the AMPS admin portal should be served on the AMPSPORT and AMPS_SSL_PORT

AMPS_HOST

The hostname at which the AMPS user portal should be served on the AMPS_PORT and AMPS_SSL_PORT

AMPS_PORT

The port to use when serving the admi and user portals over HTTP.

AMPS_USE_SSL

Whether or not AMPS should serve the UIs using SSL.

AMPS_FORCE_SSL

Whether HTTP requests should automatically be redirected to HTTPS.

AMPS_GEN_CERTS

Whether AMPS should automatically generate certificates when AMPS_USE_SSL is true.

AMPS_CERT_MODE

When generating certificates, setting this to "local" creates self signed certificates, whereas when using "production", AMPS will use Let's Encrypt to generate certificates.

AMPS_EXTRA_DOMAINS

A comma separated list of additional domains to include in the certification request when AMPS_GEN_CERTS is true. They must share the same root domain as the Admin and User Portals.

AMPS_DNS_EMAILS

The emails to use when performing the SSL certification request.

AMPS_SSL_KEY

When not generating certificates, but using SSL, this environment variable should give the complete path to the SSL Key to use.

AMPS_SSL_CERT

When not generating certificates, but using SSL, this environment variable should give the complete path to the SSL Certificate to use.

SECRET_KEY_BASE

A cryptographically secure, random 64 digit string.

downloading the docker folder