https://github.com/basedcount/flair
Flair is a microservice designed to parse and store flair information as an addition to Lemmy instances.
https://github.com/basedcount/flair
fediverse flair lemmy lemmy-ui
Last synced: 5 months ago
JSON representation
Flair is a microservice designed to parse and store flair information as an addition to Lemmy instances.
- Host: GitHub
- URL: https://github.com/basedcount/flair
- Owner: basedcount
- License: mit
- Created: 2023-07-20T23:47:50.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-03T16:25:57.000Z (over 1 year ago)
- Last Synced: 2024-10-31T11:35:52.470Z (6 months ago)
- Topics: fediverse, flair, lemmy, lemmy-ui
- Language: Rust
- Homepage:
- Size: 78.1 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flair
Flair is an augmentation for [Lemmy](https://join-lemmy.org) that adds user flair support to the backend. It can run both as a REST API microservice, as well as an importable Rust crate.
## Features
- 🚩 Users can pick a user flair among those created by the mods
- 🔃 Users can change or remove their user flair whenever they want to
- ➕ Mods can create and remove user flairs in communities they moderate
- 👮♂️ Mods can change or remove other users' flairs
## API Reference
~~The full API documentation is available on our [documentation page](https://lemmy-flair.readme.io/) or in the `swagger.json` file.~~
At the present date the documentation is not yet available.
As detailed by the docs, some requests will require an `Authorization` header. This should be a Lemmy JWT owned by the user making the request.
No token is required for read only operations such as seeing other people's flairs or seeing the list of a community's flairs.
## Deploy
Flair is designed to be ran adjacently to the Lemmy backend. In its current state, it is only possible to run the microservice from the same server where a Lemmy deployment is running.
Flair only includes a REST API supporting the microservice. If you are looking to add this feature on your Lemmy instance, you should also adopt a new UI. We recommend you check out [kaleidoscope](https://github.com/basedcount/kaleidoscope), a fork of the Lemmy UI built by us to be 100% integrated with Flair.
### Docker
It is recommended to deploy the microservice with Docker, by pulling the latest version of the [image](https://hub.docker.com/repository/docker/ornatot/flair/general) and adding it to the Lemmy docker-compose file.
### Bare metal (Cargo)
Alternatively, it is also possible to run the server with Cargo, using the following command:
`cargo run -- serve`
If you choose this deployment method, make sure to set the `DOCKER` environment variable to `false`, as detailed in the next paragraph.
## Environment variables
Flair can be configured by modifying the following environment variables:
| `ENV_VAR` | type | default | description |
| ------------------------------ | -------- | ---------------- | ----------------------------------------------------------------------------------- |
| `FLAIRS_PORT` | `int` | `6969` | Port where the service will be ran. |
| `LEMMY_PORT` | `int` | `8536` | Port where the associated Lemmy instance is running |
| `FLAIR_DB_URL` | `string` | `flairs.db` | Path where the SQLite DB file will be saved |
| `DOCKER` | `bool` | `true` | `true` if the service is running on Docker, `false` if the service is running on bare metal |
## Test
It is possible to test the application by running the `test.ts` script. A local Lemmy instance is required to test PUT and DELETE requests.
The script is developed for Bun but should also run with different Javascript runtimes.