twins/README.md

44 lines
1.1 KiB
Markdown
Raw Normal View History

2020-10-29 20:35:48 +00:00
# twins
[![CI status](https://gitlab.com/tslocum/twins/badges/master/pipeline.svg)](https://gitlab.com/tslocum/twins/commits/master)
[![Donate](https://img.shields.io/liberapay/receives/rocketnine.space.svg?logo=liberapay)](https://liberapay.com/rocketnine.space)
[Gemini](https://gemini.circumlunar.space) server
2020-10-31 00:29:25 +00:00
**Warning:** The twins configuration format is still under development.
Breaking changes may be made.
2020-10-29 20:35:48 +00:00
## Features
- Serve static files
2020-10-31 16:59:12 +00:00
- Directory listing (when enabled)
- Serve the output of system commands
- Reverse proxy requests
- Reload configuration on `SIGHUP`
2020-10-29 20:35:48 +00:00
## Download
```bash
go get gitlab.com/tslocum/twins
```
## Configure
See [CONFIGURATION.md](https://gitlab.com/tslocum/twins/blob/master/CONFIGURATION.md)
## Run
```bash
twins
```
## Support
Please share issues and suggestions [here](https://gitlab.com/tslocum/twins/issues).
## Dependencies
- [go-gemini](https://github.com/makeworld-the-better-one/go-gemini)
2020-10-31 16:59:12 +00:00
- [go-shellquote](https://github.com/kballard/go-shellquote)
- [filetype](https://github.com/h2non/filetype)
- [yaml](https://github.com/go-yaml/yaml/tree/v3)