Giter Club home page Giter Club logo

ts3viewer's Introduction

Teamspeak 3 Viewer

Build Status

Picture

Current features

  • Material design teamspeak web viewer
  • Live view (Real time)
  • Caching
  • Basic http api
  • Telegram bot
  • Docker support
  • RSS Feed
  • Dark and light mode
  • Bad documentation (not a feature but a warning)

Current api endpoints (Everything GET and returns JSON except RSS Feed)

Avatar & icon related

/avatar/:type/:id
Possible types: dbid or uid
/icon/:id

Channel Tree

/channelTree
The channel tree as json

User related

/online
Get the current online users
/user/:type/:id
Possible types: dbid or uid
/users
Every user in the database

RSS Feed

/feed
The xml rss feed. Contains join and left history.

Docker

Docker Repository

Requirements

  • NodeJS
  • yarn or npm (If npm, replace all yarn commands below with npm)
  • MongoDB

Build

yarn install
yarn build

Start

yarn start // you first need to build with yarn build

Development

  1. yarn watch Watches for file changes and updates the public directory
  2. yarn start Starts the fastify server

Supported settings

You need to use env variables.

List of env variables:
Variable Description Default Example
TSVSERVERIP Teamspeak server ip/host 127.0.0.1 myserver.com
TSVSERVERPORT Teamspeak server query port 10011 10011
TSVSERVERUSERNAME Teamspeak query admin username serveradmin serveradmin
TSVSERVERPASSWORD Teamspeak query admin password mypassword
TSVSERVER Teamspeak virtual server id 1 1
TSVMONGO MongoDB address mongodb://localhost/teamspeak mongodb://172.17.0.6/teamspeak
TSVCACHE Cache time in ms 120000 2000
TSVPORT Webserver port 5000 8080
TSVHOST Webserver host 0.0.0.0 127.0.0.1
TSVDARKMODE UI dark mode default false true
TSVBBCODE BBCode enabled (WIP) false true
TSVTITLE Title (HTML supported) Teamspeak 3 Viewer My Teamspeak
TSVFOOTERTEXT Right footer Text (HTML supported) © 2017
TSPOLLINGTIME The time between each refresh (ms) 500 1000
FEEDURL The feed url Nothing (Required for feed) https://mydomain.com/feed
FEEDSITEURL You need to specify a website Nothing (Required for feed) https://mydomain.com
FEEDTITLE The title of your feed Nothing (Required for feed) User feed
TELEGRAMTOKEN The telegram bot token Nothing (Required for bot) Your token
TELEGRAMBASEURL The url to the ts viewer Nothing (Required for bot) https://mydomain.com/
TELEGRAMPOLLING Force polling false true

ts3viewer's People

Contributors

dunklestoast avatar thenoim avatar

Stargazers

avatar

Watchers

avatar avatar

Forkers

dunklestoast

ts3viewer's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.