Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matrix-org/matrix-static
A static golang generated preview of public world readable Matrix rooms.
https://github.com/matrix-org/matrix-static
static-site
Last synced: 5 days ago
JSON representation
A static golang generated preview of public world readable Matrix rooms.
- Host: GitHub
- URL: https://github.com/matrix-org/matrix-static
- Owner: matrix-org
- License: apache-2.0
- Archived: true
- Created: 2017-06-13T13:34:20.000Z (over 7 years ago)
- Default Branch: develop
- Last Pushed: 2023-05-30T08:16:54.000Z (over 1 year ago)
- Last Synced: 2024-08-01T12:23:46.988Z (3 months ago)
- Topics: static-site
- Language: Go
- Homepage: http://view.matrix.org/
- Size: 6.47 MB
- Stars: 87
- Watchers: 28
- Forks: 25
- Open Issues: 54
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - matrix-org/matrix-static - A static golang generated preview of public world readable Matrix rooms. (others)
README
Matrix Static
===========
### No longer maintained
In favour of https://github.com/matrix-org/matrix-public-archive
### Installation
`git clone` or download this repository as an archive and extract then follow below instructions.
```
go get github.com/valyala/quicktemplate/qtc
qtc
mkdir bin && go build -o bin/ ./cmd/...
```
### Docker
```shell
docker build -t matrix-static .
docker run -v $(pwd)/config.json:/opt/matrix-static/config.json -p 8000:8000 -it matrix-static
```
or for windows:
```shell script
docker run -v %cd%/config.json:/opt/matrix-static/config.json -p 8000:8000 -it matrix-static
```
and pass any command line arguments to the end of the command.
### Usage
First you must create a config, there is a sample json file provided or you can use the helper binary `register-guest` to register a guest on a given homeserver and write an appropriate config file.
`register-guest` takes the following options:
`--config-file=` to specify the config file, defaulting to `./config.json`.
`--homeserver-url=` to specify the Homeserver URL to use, defaulting to `https://matrix.org`.
The main binary, `matrix-static` exhibits the following controls:
Accepts `PORT=` env variable to determine what port to use, defaulting to port 8000 if one is not specified. Will panic if port is in use.
Accepts the following command line arguments:
`--config-file=` to specify the config file, defaulting to `./config.json`.
`--enable-pprof` if set, enables the `/debug/pprof` endpoints for debugging.
`--enable-prometheus-metrics` if set, enables the `/metrics` endpoint for metrics.
`--num-workers=` to specify the number of worker goroutines to start, defaults to 32.
`--public-serve-prefix=` to specify the router prefix to use for the user-facing html-serving routes, defaults to `/`.
`--logger-directory` to specify where the output logs should go.
`--cache-ttl` to specify how long since last access to keep a room in memory and up to date for, defaults to 30 minutes.
`--cache-min-rooms` to specify the minimum number of rooms to always keep in memory, defaults to 10.
### Support
Currently hosted at https://view.matrix.org
Discussion Matrix Room is [#matrix-static:matrix.org](https://matrix.to/#/#matrix-static:matrix.org)