Skip to content

README.md

Latest commit

 

History

History
84 lines (60 loc) · 2.6 KB

README.md

File metadata and controls

84 lines (60 loc) · 2.6 KB

OpenTickets

An open source IT ticket management system designed to be fully self-hostable.

GitHub code size in bytes GitHub License

Important

Rewrite from scratch pending soon:tm:

Important

This is an Alpha. Many features are not fully implimented or have bugs. (See issues) I am actively working through the issue backlog. I almost have all the know issues triaged and tracked in which case I will then work on better design docs and planning materials. PR's are welcome. Issues with ideas are also welcome.

image

Features

  • Self-hostable IT ticket management system
  • RESTful API backend with FastAPI
  • Modern web frontend
  • User authentication and authorization
  • Ticket tracking and management
  • Admin dashboard

Prerequisites

For Docker Deployment

For Local Development

  • Python 3.12+ (Will move to python 3.15 soon but haven't tested yet)

Quick Start

Option 1: Docker Deployment (Recommended)

  1. Install Docker Desktop from https://www.docker.com/products/docker-desktop/ or Docker CLI

  2. Generate secrets (from the project root):

    Docker\generate-secrets.sh

  3. Build and start the containers:

    docker-compose build --no-cache
docker-compose up -d

  4. Access the application:

    • Hosted at: http://localhost or the manually set IP depending on configuration... Improvements to this system are pending.

  5. Default test account:

    • Email: Admin@example.com
    • Password: AdminPass000!

To rebuild after making changes:

docker-compose down
docker-compose build --no-cache
docker-compose up -d

View running containers:

docker ps

Note

The default test admin account will be replaced with a forced password reset on first login once that feature is fully implemented. See: Issue #3

Local Development

For local development, the Docker setup using nginx will handle localhost configuration automatically. Docker is required at this stage.

License

  • AGPLv3 See LICENSE file for details.

Support & Contribution

This is an open source project. Contributions are welcome!