status-updates

README

Status Updates

This bot is a simple way to keep your Discord community up to date with StatusPage updates.

Table of Contents

1. About The Project
   • Built With
2. Installation
3. Configuration
4. Usage
5. Contributing
6. License

About The Project

Status Updates is a backend service that keeps your Discord community informed by syncing incident and status updates from Statuspage.io and Jira. Built with Go for reliability and extensibility, it powers the core API and background processing for the Tickets Bot ecosystem, enabling seamless integration of incident management, ticket tracking, and public status communication.

Key Features:

• Incident & Status Management: Track incidents, components, and status updates for your Discord community.
• Jira Integration: Sync incidents with Atlassian StatusPage for advanced incident management.
• Extensible: Modular internal structure for easy feature addition.

Built With

• Go (Golang)

---

Installation

1. Clone the repository:

   git clone https://github.com/TicketsBot-cloud/status-updates.git
   cd status-updates
   

2. Install dependencies:

   go mod download
   

3. Build the project:

   go build -o status-updates ./cmd/status-updates
   

Configuration

Configuration is managed via environment variables or a config file. See internal/config/config.go for all options.

Example environment variables:

DISCORD_TOKEN=bot_token
DISCORD_PUBLIC_KEY=bot_public_key
DISCORD_GUILD_ID=guild_id
DISCORD_CHANNEL_ID=status_updates_channel_id
DISCORD_UPDATE_ROLE_ID=status_update_role_id

STATUSPAGE_API_KEY=statuspage_api_key
STATUSPAGE_PAGE_ID=statuspage_page_id

DATABASE_URI=postgres://postgres:postgres@localhost/postgres?sslmode=disable

Usage

To run the service locally:

go run cmd/status-updates/main.go

The HTTP server will start and listen on the configured port (default: 8080).

The HTTP server is only used for the buttons to add the user to the role and thread for an incident.

---

Contributing

Contributions are welcome! Please open issues or pull requests for bug fixes, features, or documentation improvements.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a pull request

---

License

Distributed under the MIT License. See LICENSE for details.

(back to top)