summaryrefslogtreecommitdiff
path: root/README.md
blob: 3dfb377cb6bd7bcf69005ee4eadb74ee5aad962e (plain)
1
2
3
4
5
6
7
# Index Virtual Terminal
This is the source code for the Index Virtual Terminal (IVT), a web-based terminal emulator that interfaces with other Index applications enabling their control from a centralized location. In order to run a copy of the IVT, the following additional files are required:

- `data/akasha`, a SQLite3 database with the proper tables for the Index
- `music/<albums>/<songs>`, a directory containing mp3 music files

To run, host the `static` directory then run `ivt.py`. Next, forward `127.0.0.1:5417` and edit `main.js` to point towards your new websocket location.