Skip to content

Security: cpareek/k8s-slackbot

Security

SECURITY.md

Security Setup Instructions

Important: Protecting Sensitive Information

This repository contains template files for configuration. You must create actual configuration files with your real credentials locally.

Required Setup Steps

  1. Environment Variables: Copy .env.example to .env and fill in your actual values:

    cp .env.example .env
    # Edit .env with your actual Slack tokens and API keys
  2. HolmesGPT Configuration: Copy the template and add your Azure API credentials:

    cp holmesgpt/values.yaml.template holmesgpt/values.yaml
    # Edit holmesgpt/values.yaml with your actual Azure OpenAI credentials

What's Protected

The following files are automatically ignored by git (never committed):

  • .env - Contains Slack API tokens and other secrets
  • holmesgpt/values.yaml - Contains Azure OpenAI API keys
  • *.log - Log files that might contain sensitive information

Template Files Included

  • .env.example - Template for environment variables
  • holmesgpt/values.yaml.template - Template for HolmesGPT configuration

Before Contributing

Always ensure you're not accidentally committing sensitive information:

git status  # Check what files are being tracked
git diff    # Review changes before committing

Quick Setup

  1. Clone this repository
  2. Run the security setup:
    cp .env.example .env
    cp holmesgpt/values.yaml.template holmesgpt/values.yaml
  3. Edit both files with your actual credentials
  4. Follow the main README.md for installation and deployment instructions

There aren’t any published security advisories