Project Beacon

Overview

Beacon is a standalone IndieAuth provider written in Go.

This project is currently in early stages of development so there may be breaking changes as the project evolves.

Development

Beacon is actively developed in Code Flow with the main branch synced to the following forges:

• Codeberg
• GitHub

Full documentation

The project's documentation can be found here.

🤝 Contributing

Run the application

Clone the repository.

git clone https://github.com/dananglin/beacon.git
cd beacon

Copy the example configuration and generate the JWT secret.

cp ./example/config.json ./config.json
openssl rand -base64 36

Update the configuration with the secret and run the application.

./beacon serve --config config.json

Run the tests

You can run the tests with the below command.

go test -v ./...

Submit a pull request

If you'd like to contribute, please fork the repository and open a pull request to the main branch.

Licensing

This project is REUSE compliant so the copyright and licensing information is stored in the header in every file, but in general:

• All original source code is licensed under AGPL-3.0-only.
• All documentation is licensed under CC-BY-4.0.
• Configuration and data files are licensed under CC0-1.0.