Cupcake

A minimal server providing a read-only version of cake for javaBin regions to be able to find possible speakers for local talks.

For frontend - see frosting

Build

Gradle application using ktor.

Local running

You will require env variables:

SP_BASE_URL=https://sleepingpill.javazone.no
SP_USER=<username>
SP_PASSWORD=<password>
BRING_API_KEY=<key>
BRING_API_USER=<e-mail>
SLACK_CLIENT=<client ID>
SLACK_SECRET=<client secret>
SLACK_BOT_TOKEN=<app bot token>
SLACK_CHANNEL=<channel ID>
SLACK_CHANNEL_NAME=<channel name>
SLACK_CALLBACK=<callback URL>
JWT_SECRET=<jwt secret - defaults to "secret" - should be set to something else via env for deployments>
JWT_ENABLED=true/false
JWT_REDIRECT=URL for redirect on successful login - optional - defaults to "/"

Note - if using slack authorization locally (JWT_ENABLED=true) you will have to expose your localhost frosting instance via something like ngrok (free version is more than good enough) and add your exposed callback URL to the slack app's accepted list of callback URLs.

You must then access the site via the exposed URL.

Slack does not support localhost or http protocol.

If you are not running with auth then localhost is fine.

Local running with docker compose

You will need to provide the same environment variables as above in a file called local.env in the root directory.

Note - this file is also useful when running from Idea with the envfile plugin.

This file MUST NOT be committed to git (it is in .gitignore).

Deploy

Assuming we will build a docker container - add to backend action when decided.

Currently it is setup for the frontend to proxy the backend - anything on /api/*, as well as /login and /slackCallback

For example - let's say we setup:

https://cupcake_backend.javazone.no -> backend
https://cupcake.javazone.no -> frontend

We would then need to set the host in the frontend for non development builds to https://cupcake_backend.javazone.no in the proxy file - but this is set using the CUPCAKE_BACKEND env var.

All app configuration for the backend is done via the environment.

If deploying with docker - you can place both on the same docker network and use the service name for the env var - see docker-compose.yml for an example.

JWT

JWT_SECRET - set some random long string here
JWT_ENABLED - true

Sleepingpill

We use the same user and password for dev and deploy here but it must be set in the environment.

SP_USER
SP_PASSWORD

Bring

We use the same user and password for dev and deploy here but it must be set in the environment.

BRING_API_USER
BRING_API_KEY

Slack

This provides login and access checking.

We can use the same slack client for dev and deploy but we have to set the correct callback URL both in the environment AND in the slack app config on https://api.slack.com

SLACK_CLIENT 
SLACK_SECRET
SLACK_BOT_TOKEN
SLACK_CALLBACK - must be https - using the example above it would be https://cupcake.javazone.no/slackCallback

Slack authorization

This application requires a slack app that provides two functions:

• OIDC login
• A bot that can check channel membership

This is currently provided via the javaBinAccess app.

App manifest:

{
  "display_information": {
    "name": "javaBinAccess",
    "description": "Access bot for javaBin",
    "background_color": "#2121cf"
  },
  "features": {
    "bot_user": {
      "display_name": "javaBinAccess",
      "always_online": true
    }
  },
  "oauth_config": {
    "redirect_urls": [
      "<list of allowed callback URLs>"
    ],
    "scopes": {
      "user": [
        "email",
        "openid",
        "profile"
      ],
      "bot": [
        "channels:read",
        "groups:read",
        "users:read"
      ]
    }
  },
  "settings": {
    "org_deploy_enabled": false,
    "socket_mode_enabled": false,
    "token_rotation_enabled": false
  }
}

To find the environment settings required:

• Client ID and Client Secret from the slack app > Settings > Basic Information
• Bot User OAuth Token token from the slack app > Features > OAuth & Permissions
• Channel ID - right click channel - channel details - ID is at the end of the dialog
• Channel Name - just the channel name with leading #