/README.md (raw)

# Vireo – OpenID Connect and OAuth 2 provider

Vireo is a simple OpenID Connect and OAuth 2 provider for small deployments.

It is a work in progress.

Vireo is a fork of [sinwon](https://codeberg.org/emersion/sinwon).

## License

AGPLv3 only, see LICENSE.

## Usage

An example configuration file is present at `config.in`:

```
listen localhost:8080
database vireo.db
server-name vireo
```

The default administrator username and password combination is
`root` and `root`.

The server is expected to run behind a TLS-terminating reverse proxy.

## Contributing

Create a branch that begins with `contrib/` and push to the
[main repo](https://forge.lindenii.org/vireo/-/repos/server/)
via SSH directly.

```
git clone ssh://forge.lindenii.org/vireo/:/repos/server/ vireo-server
cd vireo-server
git checkout -b contrib/whatever
# edit and commit stuff
git push -u origin HEAD
```

## Support

[`#chat`](https://webirc.runxiyu.org/kiwiirc/#chat)
on
[irc.runxiyu.org](https://irc.runxiyu.org/).