https://github.com/matrix-org/panopticon
panopticon records usage metrics from homeservers
https://github.com/matrix-org/panopticon
Last synced: 12 months ago
JSON representation
panopticon records usage metrics from homeservers
- Host: GitHub
- URL: https://github.com/matrix-org/panopticon
- Owner: matrix-org
- License: apache-2.0
- Created: 2015-09-11T16:21:50.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-05-21T19:32:12.000Z (about 2 years ago)
- Last Synced: 2025-07-03T16:43:39.873Z (about 1 year ago)
- Language: Go
- Size: 98.6 KB
- Stars: 13
- Watchers: 27
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# panopticon
panopticon records usage metrics from homeservers
## Building
To build panopticon, you need a working go installation.
To install dependencies, run:
```sh
go get github.com/mattn/go-sqlite3
go get github.com/go-sql-driver/mysql
```
To build, run:
```sh
go build
```
## Testing
There is a second `Dockerfile-testing` that builds panopticon to run the tests as above, as we probably want locally.
This only requires docker on your local workstation, no go install or dependencies required.
```sh
docker-tests.sh
```
To add new tests, crib exiting files in the `tests` directory.
# Deployment using docker image
Set the environment variables for the go image
* `PANOPTICON_DB_DRIVER` (eg, mysql or sqlite)
* `PANOPTICON_DB` (go mysql connection string or filename for sqlite)
* `PANOPTICON_PORT` (http port to expose panopticon on)
Set the environment variables for the python image
* `PANOPTICON_DB_NAME`
* `PANOPTICON_DB_USER`
* `PANOPTICON_DB_PASSWORD`
* `PANOPTICON_DB_HOST`
* `PANOPTICON_DB_PORT`