Skip to content

Commit

Permalink
Re-add previous docker tag schema with leading "v" for backwards comp…
Browse files Browse the repository at this point in the history
…atibility (e.g. v2)
  • Loading branch information
JensForstmann committed Oct 8, 2024
1 parent 195f887 commit 0ddb7f8
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
1 change: 1 addition & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,4 @@ jobs:
jensforstmann/tmt2:${{ steps.tagName.outputs.major }}
jensforstmann/tmt2:${{ steps.tagName.outputs.major }}.${{ steps.tagName.outputs.minor }}
jensforstmann/tmt2:${{ steps.tagName.outputs.major }}.${{ steps.tagName.outputs.minor }}.${{ steps.tagName.outputs.patch }}
jensforstmann/tmt2:v${{ steps.tagName.outputs.major }}
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# TMT2 - Tournament Match Tracker 2

[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/JensForstmann/tmt2/docker.yml?label=docker%20build)](https://github.com/JensForstmann/tmt2/actions/workflows/docker.yml)
[![Docker Pulls](https://img.shields.io/docker/pulls/jensforstmann/tmt2)](https://hub.docker.com/r/jensforstmann/tmt2)
[![Docker Image Size (tag)](https://img.shields.io/docker/image-size/jensforstmann/tmt2/latest)](https://hub.docker.com/r/jensforstmann/tmt2)
[![Docker Image Size](https://img.shields.io/docker/image-size/jensforstmann/tmt2/latest?label=docker%20image%20size)](https://hub.docker.com/r/jensforstmann/tmt2)



TMT is a tool that tracks/watches/observes a Counter-Strike 2 match.

Expand Down Expand Up @@ -56,6 +59,8 @@ Table of Contents:
- [Install dependencies and run application in development mode](#install-dependencies-and-run-application-in-development-mode)
- [Build docker image](#build-docker-image)



## Getting Started

TMT2 is available on docker hub: https://hub.docker.com/r/jensforstmann/tmt2
Expand All @@ -80,6 +85,8 @@ docker run --name tmt2 -d -p 8080:8080 -v /home/tmt2/storage:/app/backend/storag

The matches which are neither finished nor stopped will be loaded on application start.



### Create you first Match

After running the container you can open the web frontend: http://localhost:8080
Expand All @@ -98,6 +105,7 @@ either take a look at the `access_tokens.json` file
or take a look at the first lines of the log output (`docker logs tmt2`).



### Ingame Chat Commands

While TMT watches a match the player ingame can use chat commands to communicate with TMT:
Expand Down Expand Up @@ -147,13 +155,16 @@ TMT_SAY_PREFIX="[TMT] "
```



## API

See [`backend/swagger.json`](backend/swagger.json).
You might want to copy its content and paste it into https://editor.swagger.io/.

See also the [`examples`](examples) folder.



## Security / Authentication

There are two types of authentication:
Expand All @@ -169,6 +180,8 @@ Both are used in client requests in the Authorization header with a "Bearer "-pr
Authorization: Bearer 2Mgog6ATqAs495NtUQUsph
...



### global access tokens

Global access tokens are persisted in the storage folder in the file `access_tokens.json`.
Expand All @@ -193,6 +206,8 @@ Example:

If the file does not exist at startup a new one with a single auto generated global access token will be created.



### match specific access tokens

Every match will have a `tmtSecret` property. This can be used in the same way as a global access token.
Expand All @@ -210,6 +225,8 @@ After starting the dev processes you can reach the backend & frontend at:
- Backend: http://localhost:8080
- Frontend: http://localhost:5173



## Docker

Docker is recommended as it's easy to use and doesn't require any other software to be installed
Expand Down Expand Up @@ -278,4 +295,6 @@ docker build -t tmt2 .

---



> This project is a complete rewrite of the former [TMT](https://github.com/JensForstmann/CSGO-PHP-TournamentMatchTracker).

0 comments on commit 0ddb7f8

Please sign in to comment.