OpenShock backend

You can access our Open API Doc here:

https://api.openshock.app/swagger

The API can be configured using the following environment variables: Preferred way is a .env file.

When Turnstile enable is set to true, the following environment variable is required:

You need these environment variables to use Mailjet:

You need these environment variables to use SMTP:

The OpenShock stack consists of the following components:

• Postgres as database
• Redis-Stack (with keyspace events KEA)
• The API (container, API)
• One or multiple gateways (container, LCG)
• One or multiple cron daemons (container, CRON)
• The WebUI

OpenShock instance needs to be under the same domain name to work correctly. This is due to cookie limitations in browsers. E.g. Fontend: https://openshock.app API: https://api.openshock.app LCG: https://de1-gateway.openshock.app

1. Grab the docker-compose.yml and .env file from the repository
2. Change the values in the .env file
3. Adjust traefik to your needs (e.g. add SSL certificates)

Run with docker compose up -d

You could also bring your own reverse proxy.
You would need to remove traefik from the docker-compose.yml and route the traffic in your reverse proxy.

Kubernetes and Helm are very powerful and well liked but they are not beginner friendly. Use docker compose if you want something easy.

Openshock has some dependencies. It's not Openshock's place to tell you how to install them. Dependencies are:

• A Postgres database. This is used for storing user data including passwords. The Openshock API needs a connection string.

• A Redis cluster. This is used for storing session data and as a messaging bus. It needs ReJson, RediSearch and an extra argument: "--notify-keyspace-events KEA"

  Example Redis

  Here is a very basic but not necessarily good deployment of Redis that works.

  apiVersion: apps/v1
  kind: Deployment
  metadata:
  name: redis
  spec:
  replicas: 1
  selector:
      matchLabels:
      app: redis
  template:
      metadata:
      labels:
          app: redis
      spec:
      containers:
          - name: redis
          image: redis/redis-stack
          env: 
              - name: REDIS_ARGS
              value: '--notify-keyspace-events KEA'
          ports:
              - name: redis
              containerPort: 6379
              protocol: TCP
  ---
  apiVersion: v1
  kind: Service
  metadata:
  name: redis
  spec:
  type: ClusterIP
  ports:
      - port: 6379
      targetPort: redis
      protocol: TCP
      name: redis
  selector:
      app: redis

Steps:

1. Create a Kubernetes Secret containing the database connection string:

   kubectl create secret generic openshock --from-literal=databaseConnection='Host=10.0.0.5;Port=5432;Database=openshock;Username=openshock;Password=password123'

   Also include any other secrets you may want to use in the deployment. Such as a Redis password and mail credentials. See values.yaml for more.

2. Create a yaml file for your Helm values. See values.yaml for details.

   Example values.yaml

    appConfig:
      database:
        connectionSecretName: openshock
        connectionSecretKey: databaseConnection
      redis:
        host: redis
      frontend:
        name: MyOpenshock
        baseUrl: https://myopenshock.com
        shortUrl: https://myopenshock.com
        cookieDomain: myopenshock.com
      apiUrl: https://api.myopenshock.com
      liveControllerGateway:
        countryCode: NZ
        fcdn: lcg.myopenshock.com
   
    api:
      ingress:
        enabled: true
        hosts:
          - host: api.myopenshock.com
            paths:
              - path: /
                pathType: Prefix
        tls:
          - secretName: openshock-api-tls
             hosts:
               - api.myopenshock.com
   
    liveControllerGateway:
      ingress:
        enabled: true
        hosts:
          - host: lcg.myopenshock.com
            paths:
              - path: /
                pathType: Prefix
        tls:
          - secretName: openshock-lcg-tls
        hosts:
          - lcg.myopenshock.com
   
    webUi:
      enabled: true
      ingress:
        enabled: true
        hosts:
          - host: myopenshock.com
            paths:
              - path: /
                pathType: Prefix
        tls:
          - secretName: openshock-webui-tls
            hosts:
              - myopenshock.com

3. Create a Helm release:

   helm upgrade --install openshock oci://ghcr.io/OpenShock/openshock -f values.yaml

You can support the OpenShock Dev Team here: Sponsor OpenShock