feat: initial setup and docs

Author: tomastrajan

README.md

@@ -0,0 +1,33 @@
+# Omniboard On-Premise Distribution
+
+# Getting Started
+
+1. adjust values in the secret files in this folder
+   * `api-admin-password` - password of initial Omniboard admin user
+   * `db-user` - database user to connect backend to the DB
+   * `db-user-password` - database password to connect backend to the DB
+   * `db-root-password` - database root password for DB administration
+
+2. adjust values in the `docker-compose.yml` file
+   * `OB_ORG_ADMIN_EMAIL` - email of the initial Omniboard admin user
+   * `OB_ORG_NAME` - name of your organization that will be generated in the backend
+   * `ports` - (Optional) ports to expose frontend, backend and DB can be customized, by default frontend can be accessed on port `:80` which is `http://localhost` (and whatever the public url on which the system is accessible)
+
+3. log into Docker using the `docker login` command with username `omniboard` and password `<your-omniboard-access-key>`
+
+4. run `docker-compose up` to start the containers
+
+5. access the running frontend (by default at [http://localhost](http://localhost)) and log in as an admin user with credentials provided previously:
+   * email: `OB_ORG_ADMIN_EMAIL`
+   * password: `api-admin-password`
+
+6. finish initial setup
+
+7. navigate to one of your project folders and run `npx @omniboard/analyzer --ak <your-api-key-from-initial-setup> --api http://localhost:8080` to get first results (`--api http://localhost:8080` assuming its on the same machine, else on a public URL where the Omniboard backend is running)
+
+## Data persistence when pulling new image versions
+...
+
+## DB Administration
+
+Database can be accessed using the provided `Adminer` image which will by default run at [http://localhost:8090](http://localhost:8090)

api-admin-password

@@ -0,0 +1 @@
+admin

db-root-password

@@ -0,0 +1 @@
+secret

db-user

@@ -0,0 +1 @@
+admin

db-user-password

@@ -0,0 +1 @@
+admin

docker-compose.yml

@@ -0,0 +1,70 @@
+services:
+  omniboard-app:
+    image: omniboard/omniboard-app
+    restart: always
+    ports:
+      - 80:80
+    environment:
+      API_URL: http://localhost:8080
+      CONFIG_VARS: API_URL
+
+  omniboard-api:
+    image: omniboard/omniboard-api
+    restart: always
+    ports:
+      - 8080:8080
+    environment:
+      OB_ORG_NAME: 'Awesome Inc.'
+      OB_ORG_ADMIN_EMAIL: [email protected]
+      OB_ORG_ADMIN_PASSWORD_FILE: /run/secrets/api-admin-password
+      ENV: docker
+      TZ: UTC
+      PORT: 8080
+      OB_JWT_SECRET: something_unique_doesnt_really_matter_what
+      OB_DB_HOST: omniboard-db
+      OB_DB_DATABASE: omniboard
+      OB_DB_USERNAME_FILE: /run/secrets/db-user
+      OB_DB_PASSWORD_FILE: /run/secrets/db-user-password
+    secrets:
+      - db-user
+      - db-user-password
+      - db-root-password
+      - api-admin-password
+
+  omniboard-db:
+    image: mysql:5.7.37
+    command: --default-authentication-plugin=mysql_native_password
+    restart: always
+    environment:
+      MYSQL_DATABASE: omniboard
+      MYSQL_USER_FILE: /run/secrets/db-user
+      MYSQL_PASSWORD_FILE: /run/secrets/db-user-password
+      MYSQL_ROOT_PASSWORD_FILE: /run/secrets/db-root-password
+    volumes:
+      - omniboard-db-data:/var/lib/mysql
+    secrets:
+      - db-user
+      - db-user-password
+      - db-root-password
+
+  adminer:
+    image: adminer
+    restart: always
+    ports:
+      - 8090:8080
+    environment:
+      ADMINER_DEFAULT_SERVER: omniboard-db
+      ADMINER_DESIGN: dracula
+
+volumes:
+  omniboard-db-data:
+
+secrets:
+  db-user:
+    file: ./db-user
+  db-user-password:
+    file: ./db-user-password
+  db-root-password:
+    file: ./db-root-password
+  api-admin-password:
+    file: ./api-admin-password