Pengou is open source

Pengou's code is public, under the Apache-2.0 license. You can read it, install it on your server with Docker, adapt it to your needs and contribute on GitHub.

Updated on .

See the code on GitHub

Why the code is open

First, for trust. Everyone can read what Pengou does with the data, instead of having to believe what the site says about it.

Second, for longevity. If the app.pengou.fr service ever stopped, the code would remain available and anyone could run Pengou again.

Third, for autonomy. A school, an association or a company can run its own instance, on its own machines, without asking anyone.

The license in plain terms

Pengou is published under the Apache-2.0 license, a free license approved by the Open Source Initiative. You can use Pengou, install it for yourself, your organization or your clients, modify it and redistribute it, including in a commercial setting. You can even offer your own version as a hosted service.

In exchange, you must include a copy of the license with any redistribution, keep the copyright and attribution notices (including the NOTICE file) and flag the files you have modified.

The code is free, the brand is not. The names "Pengou" and "Sploot Labs", the logo and the mascot are not covered by the license: you may not use them to present your version as the official one.

The text of the license prevails. The LICENSING.md file explains it in plain language.

Install Pengou yourself

You need Docker and Docker Compose. Get the repository, generate a session secret, then start everything:

git clone https://github.com/Sploot-Labs/pengou.git
cd pengou
export BETTER_AUTH_SECRET=$(openssl rand -base64 32)
docker compose up

Then open http://localhost:3000 in your browser. Compose starts PostgreSQL and the app, and applies the migrations at startup. Never put this secret in a git repository: keep it in your secrets manager.

For a production instance, serve Pengou behind HTTPS and set BETTER_AUTH_URL to an address starting with https://. The single mode suits a single organization, the multi mode several separate workspaces. The current deployment runs on a single instance: the move to several instances is under way. The Docker section of the README details the configuration, and the .env.example file documents each variable.

Contributing

Contributions are welcome, especially first ones. To start, pick an issue labeled good first issue, comment to claim it, then propose your change. If this is your first open source contribution, say so in the description: we will guide you.

Stuck or have an idea? Open a discussion. The contribution guide explains how to set up the project and run the tests, and the code of conduct sets the rules of the exchange.

Found a security vulnerability? Do not open a public issue. Follow the security policy instead, which goes through a private report.

Under the hood

Pengou is a TypeScript monorepo. The server relies on Fastify and Socket.IO, the interface on React and Vite, the data on PostgreSQL with Drizzle, and authentication on Better Auth. The game engine is pure and deterministic: the score is computed on the server, which makes anti-cheating reliable and the points calculation testable.

Try Pengou

Create a host account to prepare your first quiz, or join a game with its code.