Skip to content

OnPrem Access

Your infrastructure.
Connected to MyStocks.

Run the partner platform on your own domain and host. Keep your team’s workspace close, with authenticated API requests routed through the MyStocks gateway.

Requires an active cloud connection. OnPrem is not an offline trading system.

One partner workspace, on your domain

Partner console

Navigate accounts, trading tools, reports, team access and operational controls according to your cloud role and permissions.

API gateway

Route partner and sandbox API calls through the installation. Caller credentials, rate limits, idempotency and cloud policies remain enforced.

Enterprise sign-in

Use configured OIDC or SAML sign-in and supported authenticator challenges. Provider setup and user enrollment are separate onboarding steps.

Deployment choices

Use Docker with Caddy, Nginx or Traefik, or a supported native Linux service with an HTTPS proxy.

Before you install

  • An approved partner organization with an active full API credential and authorized team accounts.
  • A Linux AMD64 or ARM64 host, Docker Engine, Compose and Python 3. Native mode supports Debian 12 or Ubuntu 24.04 with Node.js 22 and systemd; Docker is still used to extract the image.
  • For self-hosting, an exact HTTPS domain you control; TXT or CNAME ownership proof is needed before production activation, and HTTPS ingress on ports 80/443. Keep the application’s internal port private.
  • Outbound HTTPS to MyStocks, Firebase authentication and the private image registry, plus DNS resolution and accurate system time. SSE connections require a proxy configured without response buffering.
  • A domain-bound installation license and separate, repository-scoped registry reader access. Store secrets on the server and never in browser code.

Capacity, availability targets, networking and vendor-specific SSO are reviewed during onboarding.

Installation, step by step

  1. Request access. Sign in with a verified email, enter your organization and intended hostname, choose a supported deployment and start the 14-day self-service evaluation below. Ownership verification is not required for evaluation. Administrator-reviewed preview requests can still omit the domain; extensions and production need review.
  2. Prepare production domain verification. Evaluation installation can precede ownership verification. Choose TXT or CNAME verification in your application. Publish the exact record supplied after approval at the DNS provider for your installation domain, then check verification from your signed-in request status. This record is separate from routing DNS and HTTPS. DNS checks update ownership status only. Production requires a separate Confirm Production Activation decision, an enrolled installation identity and an active applied commercial contract. Choose temporary or permanent, revocable production duration.
  3. Collect your release details. Retrieve your key once from the signed-in workspace linked in the installation email, authenticate Docker to the private registry, and obtain the approved image digest. Your installation email includes the approved image, selected setup, supported alternatives and supplied DNS records, without the secret. One standard multiarchitecture image serves supported targets; your team chooses its installation mode and proxy.
  4. Run the installer. Download and review the script, then run it with your domain and digest-pinned image. Enter the license at the secure prompt.
    curl -fsSLo install-onprem.sh https://mystocks.africa/install-onprem.sh
    # Review the downloaded script before running it.
    sudo bash install-onprem.sh --domain trading.example.com \
      --image REGISTRY/IMAGE@sha256:DIGEST

    Replace the example domain and image with your approved values. Defaults are Docker with Caddy. Select another configuration explicitly with --proxy and --mode; see the full guide below.

  5. Check readiness and sign in. Confirm https://YOUR-DOMAIN/api/health returns ready. Sign in with an authorized partner account, then verify a read-only account request before running sandbox workflows.
  6. Connect your application. Use https://YOUR-DOMAIN/api/v1/partner/… or /api/sandbox/v1/… as appropriate. Send your normal partner API credentials. The on-prem server adds its installation credential and forwards to MyStocks.

When access expires

Protected API calls stop at expiry. The installation displays an access wall with a new-request link. Submit a renewal request; approval can grant temporary or permanent access. Your administrator must install the replacement key, then recheck readiness. A cloud outage also closes access until verification recovers.

Read the complete installation and operations guides →

Installation and administration answers

Can we explore the platform before DNS verification?

Yes. Verified customers can start a 14-day self-service OnPrem evaluation without DNS ownership proof; administrator-reviewed hosted evaluation can also begin without an installation domain. Self-hosted evaluation needs reachable HTTPS; production requires verified ownership, installation identity, commercial entitlement and explicit approval.

Can on-prem operate without MyStocks Cloud?

No. Protected access and readiness require cloud license verification. On-prem is not an offline trading system.

Who manages the server, DNS and TLS?

Your infrastructure team operates the host, DNS, TLS, backups and upgrades. MyStocks Cloud remains authoritative for API authorization, trading and balances.

What happens when temporary access expires?

Protected calls are denied and an access wall provides a new-request link. Submit a renewal for administrator approval, install the replacement key securely and recheck readiness.

Does permanent access mean access cannot be revoked?

No. Permanent access has no scheduled expiry, but remains revocable and bound to the approved organization and domain.

Plan your deployment

Explore supported configurations. Enter your final choices in the application below; administrators review capacity and approve a release before activation.

Your deployment checklist

  • AMD64 Linux host; Docker Engine, Compose plugin and Python 3.
  • Provision trading.example.com; configure HTTPS and authorized Firebase sign-in. Production activation additionally requires the chosen TXT or CNAME ownership proof.
  • Keep application port 3000 private. Permit DNS and outbound HTTPS to MyStocks, Firebase and the image registry.
  • Keep system time synchronized. Preserve the mode-600 Ed25519 private key in the persistent installation directory; do not clone it into another host.
  • Use separate registry reader access and an active domain-bound installation key. Never include secrets in this form or email.
  • Allow inbound 80/443 and certificate challenges; Caddy manages TLS.

Download and checksum-verify the installer using the linked guide. Replace the image placeholder with the administrator-approved digest, then enter the key at the hidden prompt.

sudo bash install-onprem.sh --domain trading.example.com --image REGISTRY/IMAGE@sha256:DIGEST --mode docker --proxy caddy --port 3000
curl --fail --show-error https://trading.example.com/api/health
Versioned installer, checksum and detailed guide
Current implementation limits, not throughput guarantees
Request body10 MiB maximum
Upstream request timeout30 seconds
SSE connection lifetime5 minutes, then reconnect and revalidate
Application port3000 by default; configurable from 1024–65535
CPU / RAM / disk / concurrencyNo benchmark-certified minimum or capacity guarantee. Submit available resources for review.
Offline operationNot supported; protected requests fail closed without cloud verification.

Access plans

Temporary evaluation

Start a 14-day self-service evaluation with a verified account. One installation identity, Sandbox only. Extensions require administrator review.

Fixed self-service duration; no automatic renewal or production access.

Discuss access →

Enterprise

Deployment for your organization, with onboarding and requirements reviewed by our team. Temporary or permanent activation is an administrative decision.

Contact sales for pricing, scope and service terms.

Discuss access →

A license enables the installation. API entitlements, roles, supported markets and sandbox restrictions remain those of your approved partner account.

Request onboarding & access

Tell us where you plan to install and what your team needs. Use this form for new installations and renewal requests.

Use a verified MyStocks account to submit and track your organization’s request.

Return to this page after signing in.

Deployment details

These selections accompany your request and tailor your approved installation instructions. Do not enter passwords or credentials.

How will you connect?

Your choice does not grant Live access or issue an installation license. Each requires its own approval.

Your deployment checklist

  • AMD64 Linux host; Docker Engine, Compose plugin and Python 3.
  • Provision trading.example.com; configure HTTPS and authorized Firebase sign-in. Production activation additionally requires the chosen TXT or CNAME ownership proof.
  • Keep application port 3000 private. Permit DNS and outbound HTTPS to MyStocks, Firebase and the image registry.
  • Keep system time synchronized. Preserve the mode-600 Ed25519 private key in the persistent installation directory; do not clone it into another host.
  • Use separate registry reader access and an active domain-bound installation key. Never include secrets in this form or email.
  • Allow inbound 80/443 and certificate challenges; Caddy manages TLS.

Download and checksum-verify the installer using the linked guide. Replace the image placeholder with the administrator-approved digest, then enter the key at the hidden prompt.

sudo bash install-onprem.sh --domain trading.example.com --image REGISTRY/IMAGE@sha256:DIGEST --mode docker --proxy caddy --port 3000
curl --fail --show-error https://trading.example.com/api/health
Versioned installer, checksum and detailed guide

Start OnPrem evaluation

14 days, one installation identity, Sandbox only. No administrator decision or DNS ownership proof is needed for supported deployments. Production trading, funding and payouts remain blocked.

Enter your organization and intended installation hostname, choose your deployment above and accept the terms. HTTPS, routing and authorized Firebase sign-in are still installation prerequisites. Image downloads require the approved email linked to Google sign-in.

One self-service evaluation per organization and verified contact. Repeat trials, extensions, permanent access and reviewed enterprise topologies require administrator approval.

Sign in and verify your email first.

Evaluation, expiry and production upgrade guide